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 one of the instructions: edp-install-openshift or edp-install-kubernetes.
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://chartmuseum.demo.edp-epam.com/
-
Choose available Helm chart version:
helm search repo epamedp/codebase-operator NAME CHART VERSION APP VERSION DESCRIPTION epamedp/codebase-operator v2.4.0 Helm chart for Golang application/service deplo...NOTE: It is highly recommended to use the latest released version.
-
Deploy operator:
Full available chart parameters list:
- chart_version # a version of CD Pipeline operator Helm chart; - global.edpName # a namespace or a project name (in case of OpenShift); - global.platform # openshift or kubernetes; - global.database.host # Host to DB (<db-name>.<namespace>); - global.database.port # Port to DB; - global.database.name # Name of DB; - image.name # EDP image. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/codebase-operator); - image.version # EDP tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/codebase-operator/tags); - jira.integration # Flag to enable/disable Jira integration; - jira.name # JiraServer CR name; - jira.apiUrl # API URL for development; - jira.rootUrl # URL to Jira server; - jira.credentialName # Name of secret with credentials to Jira server; -
Install operator in the <edp_cicd_project> namespace with the helm command; find below the installation command example:
helm install codebase-operator epamedp/codebase-operator --version <chart_version> --namespace <edp_cicd_project> --set name=codebase-operator --set global.edpName=<edp_cicd_project> --set global.platform=<platform_type> --set global.database.name=<db-name> --set global.database.host=<db-name>.<namespace_name> --set global.database.port=<port> --set jira.integration=false
-
Check the <edp_cicd_project> namespace that should contain operator deployment with your operator in a running status.