epamedp/codebase-operator repository overview

⁠Codebase Operator

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

⁠Overview

Codebase Operator is an KubeRocketCI operator that is responsible for provisioning codebase entities. Operator installation can be applied on two container orchestration platforms: OpenShift and Kubernetes.

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. KubeRocketCI project/namespace is deployed by following the Install KubeRocketCI⁠ instruction.

⁠Installation

In order to install the Codebase 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
   

   Copy

2. Choose available Helm chart version:

   helm search repo epamedp/codebase-operator -l
   NAME                           CHART VERSION   APP VERSION     DESCRIPTION
   epamedp/codebase-operator      2.23.0          2.23.0          A Helm chart for KubeRocketCI Codebase Operator
   

   Copy

   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 codebase-operator epamedp/codebase-operator --version <chart_version> --namespace <edp-project> --set name=codebase-operator --set global.edpName=<edp-project> --set global.platform=<platform_type> --set jira.integration=false
   

   Copy

5. Check the namespace that should contain operator 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 Developer Guide⁠ page.

Development versions are also available, please refer to the snapshot helm chart repository⁠ page.

⁠Related Articles

• Install KubeRocketCI⁠