| ❗ Please refer to EDP documentation to get the notion of the main concepts and guidelines. |
|---|
Get acquainted with the Codebase Operator and the installation process as well as the local development, and architecture scheme.
Codebase Operator is an EDP 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.
- Linux machine or Windows Subsystem for Linux instance with Helm 3 installed;
- Cluster admin access to the cluster;
- EDP project/namespace is deployed by following the Install EDP instruction.
In order to install the Codebase Operator, follow the steps below:
-
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
-
Choose available Helm chart version:
helm search repo epamedp/codebase-operator -l NAME CHART VERSION APP VERSION DESCRIPTION epamedp/codebase-operator 2.13.0 2.13.0 A Helm chart for EDP Codebase Operator epamedp/codebase-operator 2.12.0 2.12.0 A Helm chart for EDP Codebase Operator epamedp/codebase-operator 2.10.1 2.10.1 A Helm chart for EDP Codebase Operator
NOTE: It is highly recommended to use the latest released version.
-
Full chart parameters available in deploy-templates/README.md.
-
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
-
Check the namespace that should contain operator deployment with your operator in a running status.
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.