Skip to content

This operator installs and manages Gerrit EDP Component in order to use it as GitProvider and store codebases code

License

Notifications You must be signed in to change notification settings

epam/edp-gerrit-operator

Build codecov Go Report Card GitHub license

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.
  4. Make sure Git FSMonitor feature is turned off. This is due to limitations of go-git.

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://epam.github.io/edp-helm-charts/stable
  2. Choose available Helm chart version:

    helm search repo epamedp/gerrit-operator -l
    NAME                     CHART VERSION   APP VERSION     DESCRIPTION
    epamedp/gerrit-operator  2.19.0          2.19.0          A Helm chart for EDP Gerrit Operator
    epamedp/gerrit-operator  2.18.0          2.18.0          A Helm chart for EDP Gerrit Operator

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

  3. Full chart parameters available in deploy-templates/README.md.

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

    helm install gerrit-operator epamedp/gerrit-operator --version <chart_version> --namespace <edp-project> --set name=gerrit-operator --set global.platform=<platform_type> --set global.dnsWildCard=<cluster_DNS_wildcard>
  5. Check the 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.

Development versions are also available, please refer to the snapshot Helm Chart repository page.

Related Articles