Cloud Resource Naming Convention Generator & Checker

About the Cloud Resource Naming Convention Generator & Checker

Write one naming standard for your cloud and see the name it gives every resource type. Put the parts in order — organisation, workload, environment, region, instance number, the type’s abbreviation, or parts of your own — with their codes, then choose the separator and the letters. Each type then gets its name within its own rules: a type that refuses hyphens gets another separator or none, one that refuses capitals gets lowercase, and a name that is too long is shortened, with every change said beside it.

The page knows the published naming rules of 58 resource types of three public clouds and Kubernetes: length, characters, first and last character, repeated separators, reserved prefixes and endings, and where the name must be unique. Paste existing names, or open a CSV file, to check them against those rules and your standard, with a replacement for each one that fails. Add the tags every resource carries, checked against each provider’s tag rules. Everything is worked out in your browser. Without a pass the result is a free preview: the counts, three of the names and the first three checked names; every name, the document (Markdown, Word, PDF), the bulk CSV, the patterns and the JSON unlock with a Premium pass.

Common uses

• Writing the naming standard of a platform or cloud team, with the exceptions each resource type forces worked out.
• Getting the names of a new environment (every workload, environment and region) ready before the infrastructure code is written.
• Checking an export of existing resource names against the standard, with replacements to plan renames.
• Adding the patterns to a pipeline so names that break the standard are caught before deployment.
• Agreeing the tags (labels) every resource carries, in a form every provider in use accepts.

How each type gets its name

• Separator: the one you chose where the type allows it; otherwise a hyphen or an underscore it allows; otherwise none.
• Letters: lowercase wherever the type refuses capitals, whatever you chose.
• Values: characters the type refuses are dropped, and separators inside a value become the name’s separator.
• Length: when a name is too long, the parts with other values allowed — the workload, the organisation and your own parts — are cut, longest first, down to three characters; if that is not enough the separators go, and then the cut goes down to two. Codes for the environment, region and instance number are never cut.
• Child resources and Kubernetes objects: a part can be left out of them (the organisation inside a parent resource, the region inside a cluster).
• Fixed endings: a FIFO queue’s name gets “.fifo”, counted in its length.

What the checker looks at

Each name is checked against its type’s rules — length, characters, the first and the last character, two separators in a row, reserved prefixes and endings, a name shaped like an IP address — and against the standard: the parts in order, the codes listed for each, the separator and the letters. A replacement keeps what the name says: an environment written out (“production”, “staging”) becomes the standard’s code for it, a region written out becomes its code, a number becomes the instance number, and words the standard does not know become the workload. Parts the name lacks get the standard’s first code, and every change is listed.

Patterns for automated checks

Each type gets one regular expression for its names under the standard: the listed codes as alternatives, parts with other values allowed as runs of letters and digits (or one of their own codes, such as web-api), the instance number as its digits. Where the longest names have to be shortened, the shortened forms are accepted too. The syntax is the one JavaScript, PCRE, Python and RE2 share (no look-around), so the same line works in a script, a policy or a pipeline; the length is checked apart, and the JSON file holds each type’s limits.

Sources

• <https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules>
• <https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations>
• <https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming>
• <https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources>
• <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html>
• <https://docs.aws.amazon.com/lambda/latest/api/API_CreateFunction.html>
• <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html>
• <https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html>
• <https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html>
• <https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html>
• <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html>
• <https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateLoadBalancer.html>
• <https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html>
• <https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreateRepository.html>
• <https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html>
• <https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html>
• <https://docs.cloud.google.com/storage/docs/buckets>
• <https://docs.cloud.google.com/compute/docs/naming-resources>
• <https://docs.cloud.google.com/resource-manager/docs/creating-managing-projects>
• <https://docs.cloud.google.com/pubsub/docs/pubsub-basics>
• <https://docs.cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters>
• <https://docs.cloud.google.com/run/docs/deploying>
• <https://docs.cloud.google.com/run/docs/reference/rest/v2/projects.locations.services/create>
• <https://docs.cloud.google.com/iam/docs/service-accounts-create>
• <https://docs.cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts/create>
• <https://docs.cloud.google.com/bigquery/docs/datasets>
• <https://docs.cloud.google.com/resource-manager/docs/labels-overview>
• <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>
• <https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/>
• <https://kubernetes.io/docs/concepts/services-networking/service/>
• <https://kubernetes.io/docs/concepts/workloads/controllers/deployment/>
• <https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/>
• <https://kubernetes.io/docs/concepts/configuration/configmap/>
• <https://kubernetes.io/docs/concepts/configuration/secret/>
• <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/>
• <https://kubernetes.io/docs/reference/kubectl/>

Limitations

• The rules are the ones each provider publishes for the type; a provider can refuse a name for a reason it only gives when the resource is created.
• Whether a name that must be unique everywhere is still available can only be found by creating it: the page says which types need such a name.
• Where the documentation gives no character set (one container service’s), the page uses lowercase letters, digits and hyphens.
• Up to 58 resource types; the bulk file holds up to 100,000 names and the checker reads up to 5,000 lines.
• The PDF prints Latin letters; other scripts print as “?” there, while the Word, Markdown, CSV and JSON files keep them.
• The free preview shows three of the names and the first three checked names (at most half of a shorter list).

Privacy

On this device: nothing is sent

Everything happens in your browser. What you enter or open here is not uploaded or stored by MySmartCoPilot.