Skip to content

Commit

Permalink
Fix naming issues (#385)
Browse files Browse the repository at this point in the history
* Initial commit: check workload and agent naming conventions at server start-up

* Check for improper naming when ank apply is being called.

* Add unit tests for naming issues

* Provide better error messages

* Fix agent name constraint and wrongly modified config file

* Update requirements and add stests for wrong names

* Add stest for long workload name

* Fix regex

* Apply suggestions from code review

Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>

* Simplify path checking

* Trace and update docs

* Fix agent name checking in CLI

* Update doc/docs/usage/quickstart.md

Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>

* Update server and agent requirements

* Update server/doc/swdesign/README.md

Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>

* Fix agent cli name parsing

* Update swdds

---------

Co-authored-by: Kaloyan <36224699+krucod3@users.noreply.github.com>
  • Loading branch information
HorjuRares and krucod3 committed Sep 30, 2024
1 parent a5e66bd commit 81cffe6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 3 additions & 0 deletions agent/doc/swdesign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ Status: approved

The Ankaios CLI shall enforce agent names which respect the naming convention defined in the common library.

Comment:
We need to check the agent names in order to ensure the proper function of the filtering.

Tags:
- AgentManager

Expand Down
4 changes: 2 additions & 2 deletions common/doc/swdesign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ The Common library shall provide functionality for enforcing a workload name to:
* have a maximal length of 63 characters

Rationale:
A consistent naming manner assures stability in usage, compatibility with Ankaios internal structure and compliance to internet standards (RFC-1123).
A consistent naming manner assures stability in usage, compatibility with Ankaios internal structure by ensuring proper function of the filtering.

Tags:
- Objects
Expand All @@ -361,7 +361,7 @@ Status: approved
The Common library shall provide functionality for enforcing an agent name to contain only regular upper and lowercase characters (a-z and A-Z), numbers and the symbols "-" and "_".

Rationale:
A consistent naming manner allows a flawless usage of the Ankaios CLI and does not tamper with the internal structure of Ankaios.
A consistent naming manner assures stability in usage, compatibility with Ankaios internal structure by ensuring proper function of the filtering.

Tags:
- Objects
Expand Down

0 comments on commit 81cffe6

Please sign in to comment.