- Known issues
- Installation
- Upgrading
- Backup and restore
- Using RedHat certified images
- Developer Tooling
GitLab Operator
TheGitLab Operatoris an installation and management method that follows the Kubernetes Operator pattern.
Use the GitLab Operator to run GitLab in OpenShiftor on another Kubernetes-compatible platform.
Known issues
GitLab Operator does not support:
- Migration from GitLab Chart or Linux package to GitLab Operator. For migration of the installation method, you must follow steps similar to the manual migration steps. Support for automatic migration is proposed inGitLab Operator issue 1567.
- Deployment by using theGitLab Environment Toolkit. Support for this integration is proposed inGitLab Operator issue 1571.
- GitLab Geoinstallation and configuration. You cannot use GitLab Operator for deploying of primary or secondary sites. Support for Geo is tracked inGitLab Operator issue 1568.
- Git over SSH withOpenShift routes. For more information, seeGitLab Operator documentation on OpenShift Routes.
- Database migrations of the (experimental) registry metadata database. For more information, seeGitLab Operator issue 1599.
- GKE workload identityandIAM service accountsto authenticate workloads to other cloud APIs (such as object storage). For more information, seeGitLab Operator issue 1089.
GitLab Operator has any other limitation of GitLab Chart. GitLab Operator relies on GitLab Chart to provision Kubernetes resources. Therefore, any limitation in GitLab Chart impacts GitLab Operator. Removing the GitLab Chart dependency from GitLab Operator is proposed in Cloud Native epic 64.
Installation
Instructions on how to install the GitLab Operator can be found in ourinstallation document.
We list details of how we use Security Context Constraintsin their respective document.
You should also be aware of theconsiderations for SSH access to Git,especially when using OpenShift.
Upgrading
Operator upgradesdocumentation demonstrates how to upgrade the GitLab Operator.
GitLab upgradesdocumentation demonstrates how to upgrade a GitLab instance, managed by the GitLab Operator.
Backup and restore
Backup and restoredocumentation demonstrates how to back up and restore a GitLab instance that is managed by the Operator.
Using RedHat certified images
RedHat certified imagesdocumentation demonstrates how to instruct the GitLab Operator to deploy images that have been certified by RedHat.
Developer Tooling
- Developer guide:Outlines the project structure and how to contribute.
- Versioning and Release Info:Records notes concerning versioning and releasing the operator.
- Design decisions:This projects makes use of Architecture Decision Records, detailing the structure, functionality, and feature implementation of this Operator.
- OpenShift Cluster Setup:Instructions for creating/configuring OpenShift clusters forDevelopmentpurposes.