Skip to content
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.

Sign up for GitHub

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

Make validate command ignore environment variables in service name #3558

Merged
merged 8 commits into from
Nov 17, 2017
Merged

Make validate command ignore environment variables in service name #3558

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
05d52b6
Changes service name validation logic to ignore any environment varia…
Nov 15, 2017
f630ae3
Update documentation about validation logic for service names.
Nov 15, 2017
38798c8
Adding some more explanatory text around validating
Nov 15, 2017
800c6e3
Update validate.html.md.erb
Nov 16, 2017
436a5f7
Move service validation explanation doc
Nov 16, 2017
24f9632
Rewording for clarity
Nov 17, 2017
f75e4c1
Change error message to use original name for clarity, rather than th…
Nov 17, 2017
800f5cb
Remove documentation around service name validation
Nov 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions website/source/docs/commands/validate.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,6 @@ 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove from here and instead add to: https://www.nomadproject.io/docs/job-specification/service.html#name.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Any environment variables in the name are ignored, because some environment variables can only
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
contains an invalid character, it will only be caught at run time and nomad validate will succeed.

## Examples

Expand Down
6 changes: 6 additions & 0 deletions website/source/docs/job-specification/service.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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
contains an invalid character, it will only be caught at run time and nomad validate will succeed.

- `port` `(string: <required>)` - Specifies the label of the port on which this
service is running. Note this is the _label_ of the port and not the port
Expand Down