Make validate command ignore environment variables in service name #3558
Conversation
| be resolved at run time. Invalid characters outside of environment variable names will not pass | ||
| validation. | ||
| For example, if the service name is set to `my_service${NOMAD_NODE_NAME}` it will fail | ||
| validation. However, if a service name is set to `myservice{NOMAD_NODE_NAME}` and the node name |
There was a problem hiding this comment.
myservice${NOMAD_NODE_NAME} ?
| @@ -28,6 +28,14 @@ and supports `go-getter` syntax. | |||
| On successful validation, exit code 0 will be returned, otherwise an exit code | |||
| of 1 indicates an error. | |||
|
|
|||
| Service names are validated according to [RFC-1123](https://tools.ietf.org/html/rfc1123). | |||
There was a problem hiding this comment.
I would remove from here and instead add to: https://www.nomadproject.io/docs/job-specification/service.html#name.
There was a problem hiding this comment.
I am not a fan of any specific validation details on this page since then we will end up documenting validation details here and on the specific stanzas.
| @@ -89,6 +89,12 @@ does not automatically enable service discovery. | |||
| - `${GROUP}` - the name of the group | |||
| - `${TASK}` - the name of the task | |||
| - `${BASE}` - shorthand for `${JOB}-${GROUP}-${TASK}` | |||
|
|
|||
| Any environment variables in the name are ignored during validation, because some environment variables can only | |||
| be resolved at run time. Invalid characters outside of environment variable names will not pass | |||
There was a problem hiding this comment.
How about:
Validation of the name occurs in two parts. When the job is registered, an initial validation pass checks that the service name adheres to RFC-1123 §2.1 and the length limit, excluding any variables requiring interpolation. Once the client receives the service and all interpretable values are available, the service name will be interpolated and revalidated. This can cause certain service names to pass validation at submit time but fail at runtime.
…e name after substituting env vars with placeholder.
| @@ -28,6 +28,14 @@ and supports `go-getter` syntax. | |||
| On successful validation, exit code 0 will be returned, otherwise an exit code | |||
| of 1 indicates an error. | |||
|
|
|||
| Service names are validated according to [RFC-1123](https://tools.ietf.org/html/rfc1123). | |||
There was a problem hiding this comment.
I am not a fan of any specific validation details on this page since then we will end up documenting validation details here and on the specific stanzas.
|
LGTM assuming we remove the new verbiage from the validate commands page |
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Fixes #3532