-
Notifications
You must be signed in to change notification settings - Fork 264
Namespace tag docs #3765
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Namespace tag docs #3765
Changes from all commits
f2fde55
ec4f341
287cd2e
d0e62ac
1299bd5
3558915
e9d2b5a
3d50809
950060d
ac6b0da
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ A Namespace is a unit of isolation within the Temporal Platform. | |
- [Access a Namespace](#access-namespaces) | ||
- [Manage Namespaces](#manage-namespaces) | ||
- [Delete a Namespace](#delete-a-namespace) | ||
- [Tag a Namespace](#tag-a-namespace) | ||
|
||
## What is a Cloud Namespace Name? {#temporal-cloud-namespace-name} | ||
|
||
|
@@ -376,3 +377,42 @@ tcld namespace lifecycle set \ | |
--namespace <namespace_id.account_id> \ | ||
--enable-delete-protection <Boolean> | ||
``` | ||
|
||
## How to tag a Namespace in Temporal Cloud {#tag-a-namespace} | ||
|
||
:::tip Support, stability, and dependency info | ||
|
||
Namespace tags are currently in [Public Preview](/evaluate/development-production-features/release-stages#public-preview). | ||
|
||
::: | ||
|
||
Tags are key-value metadata pairs that can be attached to namespaces in Temporal Cloud to help operators organize, track, and manage namespaces more easily. | ||
|
||
### Tag Structure and Limits | ||
|
||
- Each namespace can have a maximum of 10 tags | ||
- Each key must be unique for a given namespace (e.g., a namespace cannot have both `team:foo` and `team:bar` tags) | ||
- Keys and values must be 1-63 characters in length | ||
- Allowed characters: lowercase letters (`a-z`), numbers (`0-9`), periods (`.`), underscores (`_`), and hyphens (`-`) | ||
- Tags are not a secure storage mechanism and should not store PII or PHI | ||
- Tags will not change the behavior of the tagged resource | ||
- There is a soft limit of 1000 unique tag keys per account | ||
|
||
### Permissions | ||
|
||
- Only [**Account Admins** and **Account Owners**](/cloud/users#account-level-roles) can create and edit tags | ||
- All users with access to a namespace can view its tags | ||
|
||
### tcld | ||
|
||
See the [tcld namespace tags](/cloud/tcld/namespace/#tags) command reference for details. | ||
|
||
### Terraform | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace these inline examples with link to examples when temporalio/terraform-provider-temporalcloud#319 merges There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similarly, we have a dedicated section for terraform docs here https://docs.temporal.io/production-deployment/cloud/terraform-provider#manage-temporal-cloud-namespaces-with-terraform - do we want to add there/hyperlink or better to keep the samples here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good question - the Terraform docs page is WAY out of date (for instance: it says we have 2 data sources, but we're currently close to 10) so I'm inclined to link directly to the TF repo instead. I'll track a separate TODO to replace or update those TF docs. |
||
|
||
See the [Terraform provider](https://github.com/temporalio/terraform-provider-temporalcloud/) for details. | ||
|
||
### Web UI | ||
|
||
Tags can be viewed and managed through the Temporal Cloud web interface. When viewing a namespace, you'll see tags displayed and can add, edit, or remove them if you have the appropriate permissions. | ||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.