Constraints

There are several constraints and limits imposed in the Humanitec platform. This page documents the main validation, limits, and constraints.

Anchor IDs #

Anchor IDs must follow these constraints:

• Only contain alphanumeric characters and dashes.
• Be between 3 and 63 characters long.
• Not start or end with a dash.

Application IDs #

Application IDs have the following constraints:

• Must only contain alphanumeric characters, numbers, or dashes.
• Must be lowercase.
• Must be 3 - 50 characters long.
• Cannot start or end with a dash.

Example valid Application names:

• my-app
• back-end-1
• front-end

Commit IDs #

Commit IDs must follow these constraints:

• Be a 40 character SHA hash.
• Only contain hexadecimal characters (0-9 and a-f).

Cronjob schedules #

Cronjob schedule elements must fall within the following ranges:

• Minutes: 0-59.
• Hours: 0-23.
• Day of Month: 1-31.
• Month: 1-12.
• Day of Week: 0-6.

Environment IDs #

Environment IDs must follow these constraints:

• Must only contain alphanumeric characters, numbers, or dashes.
• Must be lowercase.
• Must be 2 - 50 characters long.
• Cannot start or end with a dash.

Example valid Environment IDs:

• dev
• dev-1
• production-front-end

Environment Types #

Environment types must follow these constraints:

• Must only contain alphanumeric characters and dashes (-).
• Must be unique across the Organization to avoid any naming conflicts.
• Must be between 2 and 63 characters long.
• Cannot start or end with a dash.

Headers #

Header keys and values must follow these constraints:

• Only contain alphanumeric characters, dashes, and underscores.
• Header keys cannot be whitespace.

IDs #

IDs must follow these constraints:

• Be at least 2-50 characters long.
• Contain only lowercase letters, numbers, and dashes.
• Cannot start or end with a dash.

Example valid IDs:

• my-app
• app123

Example invalid IDs:

• my app (contains space)
• -app(starts with dash)
• app- (ends with dash)

Labels and Annotations #

Label and annotation keys must follow these constraints:

• Be a string.
• Have a maximum length of 63 characters.
• Contain only letters, numbers, dashes, underscores, dots, and slashes.
• Have a prefix (before the first slash) of at most 253 characters.
• Not have two consecutive dots.
• Not end with a dash or underscore.
• Not be a path.
• Not be an FQDN (example.com).

Label and annotation values must follow these constraints:

• Have a maximum length of 63 characters.
• Contain only letters, numbers, dashes, underscores, dots, and slashes.
• Begin and end with an alphanumeric character.

Paths #

Paths must follow these constraints:

• Start with a forward slash (/).
• Contain at least two forward slashes (/).
• Cannot be a prefix of another path.

Example valid paths:

• /path/to/file
• /my/path

Example invalid paths:

• path/to/file (does not start with /)
• /path (does not contain at least two /)

Resources #

Resource IDs must follow these constraints:

• Contain only lowercase letters, numbers, and dashes.
• Be at least 3 characters long.
• Not start or end with a dash.
• Be separated by exactly one dot (.).

Service Names #

Service names must follow these constraints:

• Must only contain lowercase alphanumeric characters.
• Must be between 3 and 30 characters long.

Shared Value Keys #

Shared value keys must follow these constraints:

• Only contain letters, numbers, dashes, underscores, and dots.
• Be between 1 and 253 characters long.

Volume Names #

Volume names must follow these constraints:

• Only contain lowercase alphanumeric characters.
• Be between 3 and 63 characters long.
• Not start or end with dashes.

Webhook URLs #

Webhook URLs must follow these constraints:

• Use the https protocol.