You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/current/cockroachcloud/labels.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -9,24 +9,24 @@ CockroachDB {{ site.data.products.cloud }} supports labels as a flexible way to
9
9
10
10
## What are labels?
11
11
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.
13
13
14
-
### Examples
14
+
##Common use cases
15
15
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:
17
17
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.
19
23
20
-
- State labels: For example, `state:active`, `state:readytodelete`, and `state:archive`.
24
+
These labels can then be used to:
21
25
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.
30
30
31
31
## Requirements for labels
32
32
@@ -41,17 +41,17 @@ The labels applied to a resource must meet the following requirements:
41
41
42
42
## Edit labels
43
43
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).
45
45
46
46
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.
47
47
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.
50
50
51
51
Adding or deleting labels on a folder requires the [Folder Admin]({% link cockroachcloud/authorization.md %}#folder-admin) role.
52
52
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.
55
55
56
56
### Add labels
57
57
@@ -79,5 +79,5 @@ Labels appear in invoices on the [**Billing** page]({% link cockroachcloud/billi
79
79
## Best Practices
80
80
81
81
- 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.
83
83
- Regularly review and remove unused or outdated labels.
Copy file name to clipboardExpand all lines: src/current/releases/cloud.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Get future release notes emailed to you:
14
14
15
15
{% include marketo.html formId=1083 %}
16
16
17
-
## TBD
17
+
## April 30, 2025
18
18
19
19
You can now use the CockroachDB {{ site.data.products.cloud }} Console to [edit the labels of a cluster or folder]({% link cockroachcloud/labels.md %}).
0 commit comments