README.md

build-helm-operator-action

An github action for building operators based on helm-charts via the redhat operator sdk

Build

Add a workflow to your repository .github/workflows/example_workflow.yml

name: apache-operator
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Build test operator
      uses: 'Netzlink/build-helm-operator-action@master'
      id: builder
      with:
        repository-name: 'bitnami'
        repository-address: 'https://charts.bitnami.com/bitnami'
        chart: 'bitnami/apache'
        project: 'test-apache-operator'
        kind: 'Apache'
        api-version: 'apache.netzlink.com/v1alpha1'
        container-image: 'netzlink/apache-operator'

    - name: Get the output time
      run: echo "The time was ${{ steps.builder.outputs.time }}"

This workflow is resposible for building your operator.
To build the operator and push the container-image we use a different workflow .github/workflows/operator_and_container_build_workflow.yml

name: apache_operator_CI_Prod
on:
 push:
   branches: [ master ]
 pull_request:
   branches: [ master ]
 schedule:
   - cron: '0 2 * * *' # Daily at 02:00
jobs:
 build:
   runs-on: ubuntu-latest
   steps:
   - uses: actions/checkout@v2
   - name: get_version
     run: echo ::set-env name=RELEASE_VERSION::$(echo ${GITHUB_SHA})

   - name: Build test operator version: ${{ env.RELEASE_VERSION }}
     uses: 'Netzlink/build-helm-operator-action@master'
     id: builder
     with:
       repository-name: 'bitnami'
       repository-address: 'https://charts.bitnami.com/bitnami'
       chart: 'bitnami/apache'
       project: 'test-apache-operator'
       kind: 'Apache'
       api-version: 'apache.netzlink.com/v1alpha1'
       container-image: "netzlink/apache-operator:${{ env.RELEASE_VERSION }}"
       
   - name: Get the output time
     run: echo "The time was ${{ steps.builder.outputs.time }}"

   - name: Publish netzlink/apache-operator:${{ env.RELEASE_VERSION }}
     uses: elgohr/Publish-Docker-Github-Action@master
     with:
       name: netzlink/apache-operator
       username: ${{ secrets.DOCKER_USERNAME }}
       password: ${{ secrets.DOCKER_PASSWORD }}
       dockerfile: ./test-apache-operator/build/Dockerfile
       context: ./test-apache-operator
       tags: "latest,${{ env.RELEASE_VERSION }}"

WARNING
Your have to add your registry username and password as secret in preparation.

Deployment

The deployment is the easy part | oc for Openshift kubectl for Kubernetes
Add your CustomRessourceDefinition

oc create -f ./<PROJECT-NAME>/deploy/crds/<APIVERSION>_<KIND>s_crd.yaml

Deploy the operator

oc create -f ./<PROJECT-NAME>/deploy/service_account.yaml
oc create -f ./<PROJECT-NAME>/deploy/role.yaml
oc create -f ./<PROJECT-NAME>/deploy/role_binding.yaml
oc create -f ./<PROJECT-NAME>/deploy/operator.yaml

Wait for to be status running

oc get pods -w

When running deploy your first instance with the test CustomRessource

oc create -f ./<PROJECT-NAME>/<APIVERSION_DOMAIN_PART>_<APIVERSION_VERSION_PART>_<KIND>_cr.yaml

Wait for to be status running

oc get pods -w

Now you schould have a running instance via the operator.

also have a look at:

• Github actions
• Redhat operator-sdk and OpenShift
• Helm
• Kubernetes

Happy building!