Create script and update docs for workspace infrastructure walkthrough
Goal
The goal is to provide helpful information (in any form) that would help users with varying amounts of Kubernetes experience (no experience to expert) to be able to easily understand and setup infrastructure for Workspaces.
Problem statement
Currently, our documentation for setting up workspace infrastructure is incomplete. The Tutorial: Set up GitLab agent and proxies assumes certain prerequisites that are not explained or linked to helpful resources.
Users need a complete guide that walks them through the entire process, from setting up a Kubernetes cluster to configuring the workspaces proxy.
Proposed solution
Improve the Configure workspaces documentation that guides users through the complete infrastructure setup process required before creating workspaces.
Develop a "script" for the infrastructure setup that will be used to create a walkthrough demo with Navattic. The walkthrough will require screenshots for steps that require a terminal, VS Code, and any other non-web apps.
Detailed requirements
Step-by-step instructions for:
- Set up a Kubernetes cluster compatible with GitLab
- Supported Kubernetes versions and distributions.
- Minimum resource requirements.
- Configuration recommendations for GitLab workspaces.
- Links to provider-specific setup guides.
- Install and configure an Ingress controller
- Recommended Ingress controllers.
- Installation steps for each recommended controller.
- Configuration requirements specific to GitLab workspaces.
- Troubleshooting common issues.
- Install and configure the GitLab agent
- Detailed installation steps.
- Configuration options and requirements.
- Integration with the Kubernetes cluster.
- Verification and testing procedures.
- Set up the GitLab workspaces proxy
- Installation requirements.
- Configuration parameters.
- Security considerations.
- Testing and validation.
Additional requirements
- Include command-line examples for all installation and configuration steps.
- (Optional) Add diagrams illustrating the infrastructure components and their interactions.
- Create troubleshooting sections for common issues.
- Include validation steps at each stage to ensure proper setup.
- Add links to relevant external documentation (blogs/videos) where appropriate.
Success criteria
- Users can follow the documentation to set up the complete infrastructure without needing external resources.
- Documentation includes all prerequisite steps currently missing.
- Clear validation steps are provided to confirm successful setup at each stage.
- Feedback from users indicates the documentation is comprehensive and easy to follow.