Document the recommended Flux setup for GitLab

Release notes

We announced in February our plans to integrate FluxCD with the agent for Kubernetes for GitOps. To help you get started, we are providing dedicated documentation to setup Flux with GitLab for production.

Problem to solve

As a platform engineer creating a platform for development teams to use, I want to set up a single, shared Flux instance that other teams can rely on for their pull-based deployments.

WIP Proposal

Document our recommended setup to use Flux with GitLab.

The documentation should describe

• recommended Flux installation steps with potential links to the Flux documentation
• recommended multi-tenant workflow to enable manifests stored outside of the bootstrapped Flux project
• the setup should include the installation and setup of agentk to allow forward compatibility with the UI integration
• recommended key management to access GitLab projects, including a selected secret management solution and its setup
• upgrade instructions for the components involved in the setup
• troubleshooting guide for the most common (expected) issues
• a link to example projects that present this setup

Adjusted Proposal for first iteration

Document

• recommended Flux installation steps with potential links to the Flux documentation
• give the most basic guidance around using a Deploy Token for accessing GitLab from Flux
• include note about limitations of read only permissions (some features wouldn't be able to work), affects
  • image-automation-controller
  • GitLab notification controller
• troubleshooting guide for the most common (expected) issues I never ran into trouble, so I crossed this out. - hustewart
• a link to example projects that present this setup

Out of scope

• secret management recommendatino

Intended users

• Priyanka (Platform Engineer)
• Allison (Application Ops)
• Ingrid (Infrastructure Operator)

Feature Usage Metrics

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.