Gerrit Operator

❗ Please refer to EDP documentation to get the notion of the main concepts and guidelines.

Get acquainted with the Gerrit Operator and the installation process as well as the local development, and architecture scheme.

Overview

Gerrit Operator is an EDP operator that is responsible for installing and configuring Gerrit. Operator installation can be applied on OpenShift container orchestration platform.

NOTE: Operator is platform-independent, that is why there is a unified instruction for deploying.

Prerequisites

1. Linux machine or Windows Subsystem for Linux instance with Helm 3 installed;
2. Cluster admin access to the cluster;
3. EDP project/namespace is deployed by following the Install EDP instruction.

Installation

In order to install the EDP Gerrit Operator, follow the steps below:

1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":

   helm repo add epamedp https://chartmuseum.demo.edp-epam.com/

2. Choose available Helm chart version:

   helm search repo epamedp/gerrit-operator
   NAME                     CHART VERSION   APP VERSION     DESCRIPTION
   epamedp/gerrit-operator  v2.4.0                          Helm chart for Golang application/service deplo...

   NOTE: It is highly recommended to use the latest released version.

3. Deploy operator:

   Full available chart parameters list:

   - <chart_version>                        # Helm chart version;
   - global.edpName                         # a namespace or a project name (in case of OpenShift);
   - global.platform                        # a platform type that can be "kubernetes" or "openshift";
   - global.dnsWildCard                     # a cluster DNS wildcard name;
   - global.admins                          # Administrators of your tenant separated by comma (,) (eg --set 'global.admins={test@example.com}');
   - global.openshift.deploymentType        # Wich type of kind will be deployed to Openshift (values: deployments/deploymentConfigs);
   - image.name                             # EDP image. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator);
   - image.version                          # EDP tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator/tags);
   - gerrit.deploy                          # Flag to enable/disable Gerrit deploy;
   - gerrit.name                            # Gerrit name;
   - gerrit.image                           # Gerrit image, e.g. openfrontier/gerrit;
   - gerrit.imagePullSecrets                # Secrets to pull from private Docker registry;
   - gerrit.version                         # Gerrit version, e.g. 3.2.5.1;
   - gerrit.sshPort                         # SSH port;
   - gitServer.name                         # GitServer CR name;
   - gitServer.user                         # Git user to connect;
   - gitServer.httpsPort                    # HTTPS port;
   - gitServer.nameSshKeySecret             # Name of secret with credentials to Git server;
   - gerrit.storage.class                   # Storageclass for Gerrit data volume;
   - gerrit.storage.size                    # Size for Gerrit data volume;
   

4. Install operator in the <edp_cicd_project> namespace with the helm command; find below the installation command example:

   helm install gerrit-operator epamedp/gerrit-operator --version <chart_version> --namespace <edp_cicd_project> --set name=gerrit-operator --set global.edpName=<edp_cicd_project> --set global.platform=<platform_type> --set global.dnsWildCard=<cluster_DNS_wildcard>

5. Check the <edp_cicd_project> namespace that should contain Deployment with your operator in a running status.

Local Development

In order to develop the operator, first set up a local environment. For details, please refer to the Local Development page.

Related Articles

• Architecture Scheme of Gerrit Operator
• Install EDP