Docs: GitLab for Kubernetes Agent lacks full configuration example

• Start this issue's title with Docs: or Docs feedback:.

Problem to solve

There is no source of truth that reveals the entire spec of the GitLab Kubernetes agent configuration file, preventing . All config files should have a full spec with all options and their defaults laid out to provide a whole picture of the configuration, similar to the gitlab.rb template file. however the agent configuration is documented via a series of use-case specific fragments.

Further details

Currently, configuration examples for the GitLab for Kubernetes Agent are limited to specific use cases in the official documentation and trial-and-error examples scattered across issues and documentation files in the project. There are a variety of use cases (see this internal ZenDesk link for a customer example) where an full configuration reference would be useful for deployments rather than have to create an issue or support ticket for further answers.

Proposal

With a fully-defined configuration file, administrators would have more power to set up an Agent without having to spend hours combing through incomplete documentation and closed issues.

Who can address the issue

Environments team managing the GitLab Agent for Kubernetes project.

Other links/references