-
Notifications
You must be signed in to change notification settings - Fork 43
docs: Add resource tags documentation page #747
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
base: main
Are you sure you want to change the base?
Changes from all commits
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 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,78 @@ | ||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||
| title: "Resource tags" | ||||||||||||||||||||||||||
| description: "Organize, filter, and track usage of Runpod resources across your organization with tags." | ||||||||||||||||||||||||||
| tag: "NEW" | ||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Resource tags are labels you create and apply to your Runpod resources to organize, filter, and track usage across your organization. By tagging resources, you can group them in ways that reflect how your teams, projects, and environments are structured. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Tags are shared across your organization rather than defined per user. Once a tag exists, anyone working in your organization can apply it to supported resources, so the same set of labels stays consistent no matter who created a given resource. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Supported resources | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| You can apply resource tags to the following resource types: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| | Resource type | Description | | ||||||||||||||||||||||||||
| |--------------|-------------| | ||||||||||||||||||||||||||
| | Pods | Tag individual Pods to organize compute resources. | | ||||||||||||||||||||||||||
| | Serverless endpoints | Tag endpoints to group related Serverless workloads. | | ||||||||||||||||||||||||||
|
Contributor
Author
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. Verifies the claim that resource tags and cost centers cover different resource sets. Cost centers' "Supported resources" table lists Pods, Serverless endpoints, Network volumes, and Instant Clusters (no Templates, no Container registry auths), confirming coverage differs from resource tags' five supported types. Source: docs/accounts-billing/cost-centers.mdx Lines 27 to 38 in 7fc37cc
|
||||||||||||||||||||||||||
| | Network volumes | Tag network volumes to track persistent storage. | | ||||||||||||||||||||||||||
| | Templates | Tag templates to organize reusable configurations. | | ||||||||||||||||||||||||||
|
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. We have *not added tagging to templates or container registry auth (CRA), yet. |
||||||||||||||||||||||||||
| | Container registry auths | Tag container registry auths to organize registry credentials. | | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Resource tags support templates and container registry auths, which cost centers do not. Instant Clusters are not currently supported for tagging. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| <Note> | ||||||||||||||||||||||||||
| Resource tags and cost centers serve different purposes. Tags help you organize and filter resources, while [cost centers](/accounts-billing/cost-centers) track and attribute billing across your organization. You can use both together. | ||||||||||||||||||||||||||
| </Note> | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Why use resource tags | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| Tags give you a flexible way to categorize resources so you can find and understand them later. Common uses include: | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| - Tracking usage for a specific team, project, or initiative. | ||||||||||||||||||||||||||
| - Separating environments, such as production versus staging. | ||||||||||||||||||||||||||
| - Organizing resources by team or project. | ||||||||||||||||||||||||||
| - Quickly filtering resources to find what you need. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Create a tag | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| To create a tag, open the resource tags management area in the Runpod console, give it a name, optionally assign a color, and save it. The new tag then becomes available across your organization for anyone to apply. | ||||||||||||||||||||||||||
|
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. We have not implemented coloured tags. This is the first I've heard of this - should it be added as a future ticket/feature?
|
||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| <Tip> | ||||||||||||||||||||||||||
| Because tags are shared across your organization, a tag you create is immediately available for anyone in your organization to apply. Consider agreeing on your tags as a team so everyone uses the same set. | ||||||||||||||||||||||||||
| </Tip> | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Attach a tag to a resource | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| You can apply a tag when you create a supported resource, or add one later from the resource's management view. Attaching an existing tag associates that resource with the tag without changing any other resources. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Filter resources by tag | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| You can filter or search a resource list by tag to see every resource that shares that tag across your organization. This makes it easy to review all the resources associated with a given team, project, or environment in one place. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Update a tag | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| You can update a tag to change its name, color, or metadata. Because tags are shared across your organization, updating a tag changes it for every resource that carries it. | ||||||||||||||||||||||||||
|
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. "You can update a tag to change it's name (key), and any associated value."
|
||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Detach a tag from a resource | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| You can remove a tag from a single resource without deleting the tag itself. Detaching a tag affects only that resource; the tag remains available and stays applied to any other resources that use it. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Delete a tag | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| <Warning> | ||||||||||||||||||||||||||
| Deleting a tag removes it entirely from your organization, including from every resource it is applied to. This affects all resources carrying the tag, not just one. | ||||||||||||||||||||||||||
| </Warning> | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| ## Best practices | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| A few habits help keep your tags useful and consistent as your organization grows. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **Establish consistent naming conventions.** Agree on a naming scheme that reflects your teams, projects, and environments before you create tags. Predictable names make tags easier to apply correctly and to filter on later. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **Tag resources at creation time.** Apply the appropriate tags when you create a resource rather than after the fact. This keeps your resources organized from the start and reduces cleanup work later. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **Use tags to separate environments.** Apply distinct tags to production, staging, and other environments so you can quickly distinguish them and avoid acting on the wrong resources. | ||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||
| **Periodically review and prune unused tags.** Revisit your tags from time to time and remove any that are no longer in use. Keeping the tag list current makes it easier for everyone in your organization to find and apply the right tags. | ||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume this was written when tags were still just a single label (like cost centers)?
runpod:; any string (including a blank string "") can be used for value (it's optional).Proposed edit to first sentence:
"Resource tags are key-value labels you create and apply to your ... ".