Skip to content

Commit 0738ebb

Browse files
committed
Incorporated Mike’s feedback.
1 parent fe59748 commit 0738ebb

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

src/current/cockroachcloud/labels.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ CockroachDB {{ site.data.products.cloud }} supports labels as a flexible way to
99

1010
## What are labels?
1111

12-
Labels are customizable key-value pairs that you can attach to CockroachDB {{ site.data.products.cloud }} resources. Unlike folders, which allow only one-to-many relationships, labels support many-to-many relationships which is ideal for complex environments with overlapping ownership or multiple tagging criteria.
12+
Labels are customizable key-value pairs that you can attach to CockroachDB {{ site.data.products.cloud }} resources. Unlike folders, which allow one-to-many relationships, labels support many-to-many relationships, ideal for complex environments which require a variety of tagging criteria.
1313

14-
### Examples
14+
## Common use cases
1515

16-
- Team or cost center labels: Add labels based on team or cost center to distinguish resources owned by different teams (for example, `team:research` and `team:analytics`). You can use this type of label for cost accounting or budgeting.
16+
You can set labels for:
1717

18-
- Environment or stage labels: For example, `environment:production` and `environment:test`.
18+
- **Environment tracking**: Distinguish between stages like `environment:production`, `environment:staging`, or `environment:test` to simplify deployment workflows and access control.
19+
- **Cost allocation**: Use labels like `team:analytics` or `cost_center:finance` to track usage and spending across departments in billing exports.
20+
- **Ownership and accountability**: Assign operational responsibility with labels such as `team:order-management` or `owner:platform-engineering`.
21+
- **Automation and lifecycle management**: Automate actions using labels like `state:active`, `state:archive`, or `state:ready-to-delete` in scripts and infrastructure-as-code tools.
22+
- **Custom organization**: Apply labels based on application, region, or any other criteria relevant to your workflows, e.g. the application, workload, or region applicable to a cluster.
1923

20-
- State labels: For example, `state:active`, `state:readytodelete`, and `state:archive`.
24+
These labels can then be used to:
2125

22-
- Ownership labels: Used to identify the teams that are responsible for operations, for example, `team:shopping-cart`.
23-
24-
## Why use labels?
25-
26-
- **Flexible Organization**: Tag clusters and folders by team, environment, application, or another category relevant to your workflows.
27-
- **Cost Allocation**: Analyze your invoice data by label values to track spending across departments or services.
28-
- **Automation**: Use labels in API calls and Terraform configurations to automate operations.
29-
- **Enhanced Reporting**: Export label metadata for use in external analytics tools.
26+
- Filter and group resources in the Console.
27+
- Power cost reports and analytics.
28+
- Drive automation through APIs or Terraform.
29+
- Provide consistent metadata across teams and environments.
3030

3131
## Requirements for labels
3232

@@ -41,17 +41,17 @@ The labels applied to a resource must meet the following requirements:
4141

4242
## Edit labels
4343

44-
You can apply labels to your cluster or folder through the [CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/).
44+
You can apply labels to your cluster or folder through the [CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/) or using the CockroachDB Cloud API (refer to the schema for creating a [cluster](https://www.cockroachlabs.com/docs/api/cloud/v1#post-/api/v1/clusters) or [folder](https://www.cockroachlabs.com/docs/api/cloud/v1#post-/api/v1/folders)) or [Terraform provider](https://registry.terraform.io/providers/cockroachdb/cockroach/latest/docs).
4545

4646
Adding or deleting labels on a cluster requires the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-administrator) or [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role.
4747

48-
1. Navigate to the cluster on the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page) and click the menu button in the **Action** column. Alternatively, navigate to the [**Overview** page]({% link cockroachcloud/cluster-management.md %}#view-cluster-overview) for the cluster and click **Actions** in the top right corner.
49-
1. In the dropdown menu, select **Edit labels** to open the **Edit labels** window.
48+
1. Navigate to the cluster on the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page) and click the menu button in the **Action** column. Alternatively, navigate to the [**Overview** page]({% link cockroachcloud/cluster-management.md %}#view-cluster-overview) for the cluster and click **Actions** in the top right corner.
49+
1. In the dropdown menu, select **Edit cluster labels** to open the **Edit labels** window.
5050

5151
Adding or deleting labels on a folder requires the [Folder Admin]({% link cockroachcloud/authorization.md %}#folder-admin) role.
5252

53-
1. Navigate to the folder on the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page) and click the menu button in the **Action** column.
54-
1. In the dropdown menu, select **Edit labels** to open the **Edit labels** window.
53+
1. Navigate to the folder on the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page) and click the menu button in the **Action** column.
54+
1. In the dropdown menu, select **Edit folder labels** to open the **Edit labels** window.
5555

5656
### Add labels
5757

@@ -79,5 +79,5 @@ Labels appear in invoices on the [**Billing** page]({% link cockroachcloud/billi
7979
## Best Practices
8080

8181
- Define a consistent labeling taxonomy (e.g., `team`, `env`, `app`) across your organization.
82-
- Use autocomplete in the console to prevent key duplication.
82+
- Use autocomplete in the console to prevent the duplication of keys.
8383
- Regularly review and remove unused or outdated labels.

src/current/releases/cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Get future release notes emailed to you:
1414

1515
{% include marketo.html formId=1083 %}
1616

17-
## TBD
17+
## April 30, 2025
1818

1919
You can now use the CockroachDB {{ site.data.products.cloud }} Console to [edit the labels of a cluster or folder]({% link cockroachcloud/labels.md %}).
2020

0 commit comments

Comments
 (0)