Docs: Restructure Kubernetes executor page
Problem to solve
The Kubernetes executor page has a lot of configuration settings, which makes the page extremely long and difficult to scan. While there's some evidence of logical ordering (like the reference topics for configuration settings), some of the sections could be organized more categorically to make the page content easier to scan. This would also help scale the content for newly added features.
Further details
Proposal
- Identify categories of content in the page based on areas configuration areas/settings.
- Restructure sections in page, and move out to content to separate pages if necessary.
Categories (WIP)
-
Configure pods and containers
- Pod lifecycle
- Overwrite generated pod specifications
- Overwrite pod tolerations
- Overwrite pod labels
- Overwrite pod annotations
- Set a security policy for the pod
- Remove old runner pods
- Define nodes where pods are scheduled
- Set a security policy for the container
- Set a pull policy
- Specify container capabilities
- Overwrite container resources
- Overwrite service containers resources
- Default annotations for job pods (reference topic)
-
Configure Kubernetes
- Configure the executor service account
- Overwrite the Kubernetes namespace
- Overwrite the Kubernetes default service account
-
Permissions
- Restrict access to job variables
- Configure runner API permissions
-
Volumes
- Using the cache with the Kubernetes executor
- Configure volume types
-
Nodes
- Specify the node to execute builds
- Define a list of node affinities
- Define nodes where pods are scheduled
-
Networking
- Configure a container lifecycle hook
- Add extra host aliases
- Configure pod DNS settings
Who can address the issue
Other links/references
Edited by Fiona Neill