EDP Component Operator

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

Get acquainted with the EDP Component Operator and the installation process as well as the local development.

Overview

EDP Component Operator is an extension for K8S/OpenShift that is used for managing the EDP CI/CD components in the EDP Portal. At the moment, it is delivered as a Custom Resource Definition without any controllers. Some of EDP components are predefined and installed automatically.

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

Additionally, there is the ability to use the custom components and afterwards consume the respective component data from EDP Portal.

The basic Custom Resource for EDP Component can be as follows (edp_components_crd.yaml):

apiVersion: v1.edp.epam.com/v1
kind: EDPComponent
metadata:
  name: example-edpcomponent
spec:
  type: example-edpcomponent
  url: https://example-jenkins
  icon: base64encoded_icon
  visible: true   # ensures whether the component is visible on the EDP Portal Overview page or not

For example: docker-registry.yaml, kubernetes.yaml.

NOTE: Pay attention to the icon field that should be a base64 encoded.

As soon as the CR is created, it will appear on the main page of the EDP Portal:

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 Component 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/edp-component-operator -l
   NAME                            CHART VERSION   APP VERSION     DESCRIPTION
   epamedp/edp-component-operator  0.13.0          0.13.0          A Helm chart for EDP Component Operator
   epamedp/edp-component-operator  0.12.0          0.12.0          A Helm chart for EDP Component Operator

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

3. Deploy operator:

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

helm install edp-component-operator epamedp/edp-component-operator --version <chart_version>

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

• Install EDP