-
Notifications
You must be signed in to change notification settings - Fork 24
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
Enforce naming conventions #374
Conversation
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.
Review done, findings documented.
Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>
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.
Some additional open points:
We should also enforce the agent name restrictions in the agent startup arguments.
Additionally we need to document the new constraints somewhere in our documentation (in doc/docs
). The naming constraints can be mentioned as notes in complete-state.md and in the quickstart.md. Additionally they should be present in the documentation of the proto file. The agent constraints must also be added in the documentation of the cli parameters of the ank-agent
.
It would also be great if we also add some hints about the workload names and how DNS can be enabled for workloads. For this part we would probably need a separate file in the reference folder.
Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>
Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>
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.
LGTM 👍
Issues: #341
Definition of Done
The PR shall be merged only if all items mentioned in CONTRIBUTING.md have been followed. In case an item is not applicable as described, please provide a short explanation in the description.