Docs: How to install KAS when using source install
"Set up the Kubernetes Agent Server"
- Kubernetes Agent Server is noted when it was released and not followed with what it is/role. And, this section doesn't actually define the steps to set up the KAS
- Introduced "wss://kas.gitlab.com as the --kas-address" and not used until section "Install the Agent into the cluster" and still no explanation what KAS does and why it's required
- Also the link target "**set up the configuration repository **" doesn't do anything with the "--kas-address"
"To configure an Agent, you need: ... Install the Agent in a cluster."
- "Agent" was defined in a different page and its vicinity is so close to Setup Kubernetes Agent Server and KAS, it's very easy to mistake that Agent is the Kubernetes Agent Server
- A GitLab repository to hold the configuration file
- The configuration file being referenced follows the referring text- a forward reference.
"Your config.yaml file specifies all configurations of the Agent, such as: The manifest projects to synchronize. The groups that can access this Agent via the CI/CD Tunnel. The address of the hubble-relay for the Network Security policy integrations."
- An explanation of the manifest project and its synchronizing could be inferred from the previous sequence diagram, but what kind of psychopath remembers that?
References
Merged MR that introduced documentation requiring review:
Related issue(s):
Further Details
Please review an instructional designer's take on the GA4K setup: Issue
Definition of done
-
Update the Agent documentation using the recommendations above. -
Ping author of this issue as a reviewer for the docs MR to ensure satisfaction.
Edited by Suzanne Selhorn