DOC-11438 Docs for cc/console: Grouping clusters by labels #19484
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
In redirects.yml, added entry for cluster-management-advanced.md to advanced-cluster-management.
florence-crl
changed the title
…sic and not Advanced. In authorization.md, in Cluster Operator section added link to Manage Labels. In billing-management.md, in View Credits balance section added link to Manage Labels. In releases/cloud.md, add release note for Manage Labels.
|
|
||
| 1. Navigate to the **Overview** page for the cluster to which you want to add labels. | ||
| 1. Click the **Actions** button in the top right corner. | ||
| 1. Select **Manage Labels** to open the **Edit cluster labels** window. |
There was a problem hiding this comment.
I think the final copy will be Edit cluster labels and Edit folder labels, i'll confirm.
| 1. Enter a label key and an optional label value. | ||
| 1. Click **+ Add**. The label appears under **Labels applied**. | ||
| 1. Repeat steps 4 and 5 to add additional labels. | ||
| 1. Click **Add/Update Labels** to apply the labels to the cluster. |
There was a problem hiding this comment.
Do we want anything about seeing the success or failure notifications?
There was a problem hiding this comment.
I think we need a section on rules for labels. These are the rules (@linhcrl please confirm):
- Max labels per cluster/folder are 50
- Key is unique per resource (if cluster A has a label "environment:production", it cannot also have a label "environment:development")
- Keys and values are limited to up to 63 characters
- Keys and values are only allowed to have lowercase letters and numbers
| @@ -0,0 +1,26 @@ | |||
| ## Manage labels | |||
|
|
|||
| You can attach labels to your cluster through the {{ site.data.products.cloud }} Console. | |||
There was a problem hiding this comment.
You can also set labels via CC API and Terraform. Might be good to link to any corresponding docs here.
There was a problem hiding this comment.
Might be a good idea to mention role requirements here for labels.
- To add or remove labels on a cluster, you must have one of the following roles on the cluster: cluster admin or cluster operator.
- To add or remove labels on a cluster, you must have the folder admin role.
| @@ -0,0 +1,26 @@ | |||
| ## Manage labels | |||
|
|
|||
| You can attach labels to your cluster through the {{ site.data.products.cloud }} Console. | |||
| @@ -14,6 +14,10 @@ Get future release notes emailed to you: | |||
|
|
|||
| {% include marketo.html formId=1083 %} | |||
|
|
|||
| ## April 9, 2025 | |||
| @@ -0,0 +1,26 @@ | |||
| ## Manage labels | |||
There was a problem hiding this comment.
@florence-crl it might be helpful for the user to have get more context on how to use labels. A quick overview at the start of the page could be helpful. WDYT?
This is GCP's page with a quick labels overview: https://cloud.google.com/resource-manager/docs/labels-overview. I particularly like the "What are labels" and "common uses of labels" section.
There was a problem hiding this comment.
Thanks @florence-crl! I left some feedback inline. A couple of things:
- Could we include a quick overview of the feature with some example uses?
- Can we include info on roles required to manage labels?
- You can label both clusters and folders
- There are rules/requirements for the labels you can use (like character limits, and things like that)
Fixes DOC-11438
Added manage-labels.md include file.
In *cluster-management.md, include manage-labels.md.
In cluster-management.md include file, fixed html_page_filenames list so that filter tabs appear.
Deleted cluster-management-advanced.md.
In redirects.yml, added entry for cluster-management-advanced.md to advanced-cluster-management.
In cluster-overview-page.md, added labels to settings for Standard/Basic and not Advanced.
In authorization.md, in Cluster Operator section added link to Manage Labels.
In billing-management.md, in View Credits balance section added link to Manage Labels.
In releases/cloud.md, added release note for Manage Labels.
Rendered previews