Merge pull request #5 from InformaticsMatters/sc-2884

Cluster-wide operator

Author: alanbchristie

.github/workflows/build-latest.yaml

@@ -30,10 +30,10 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-    - name: Set up Python 3.9
+    - name: Set up Python 3.10
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.10'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -45,6 +45,10 @@ jobs:
         pre-commit run --all-files
         pylint operator/*.py
         ansible-lint
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v1
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
     - name: Login to DockerHub
       uses: docker/login-action@v1
       with:
@@ -54,5 +58,6 @@ jobs:
       uses: docker/build-push-action@v2
       with:
         context: operator
+        platforms: linux/amd64,linux/arm64
         push: true
         tags: informaticsmatters/data-manager-jupyter-operator:latest

.github/workflows/build-stable.yaml

@@ -36,6 +36,10 @@ jobs:
       uses: actions/checkout@v2
     - name: Inject slug/short variables
       uses: rlespinasse/[email protected]
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v1
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
     - name: Login to DockerHub
       uses: docker/login-action@v1
       with:
@@ -45,6 +49,7 @@ jobs:
       uses: docker/build-push-action@v2
       with:
         context: operator
+        platforms: linux/amd64,linux/arm64
         push: true
         tags: |
           informaticsmatters/data-manager-jupyter-operator:${{ env.GITHUB_REF_SLUG }}

.github/workflows/build-tag.yaml

@@ -32,6 +32,10 @@ jobs:
       uses: actions/checkout@v2
     - name: Inject slug/short variables
       uses: rlespinasse/[email protected]
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v1
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
     - name: Login to DockerHub
       uses: docker/login-action@v1
       with:
@@ -41,5 +45,6 @@ jobs:
       uses: docker/build-push-action@v2
       with:
         context: operator
+        platforms: linux/amd64,linux/arm64
         push: true
         tags: informaticsmatters/data-manager-jupyter-operator:${{ env.GITHUB_REF_SLUG }}

.github/workflows/build.yaml

@@ -32,10 +32,10 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-    - name: Set up Python 3.9
+    - name: Set up Python 3.10
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.10'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -46,7 +46,12 @@ jobs:
       run: |
         pre-commit run --all-files
         ansible-lint
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v1
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
     - name: Build
       uses: docker/build-push-action@v2
       with:
         context: operator
+        platforms: linux/amd64,linux/arm64

README.md

@@ -3,6 +3,8 @@
 [![Data Manager: Application](https://img.shields.io/badge/data%20manager-application-000000?labelColor=dc332e)]()
 [![Dev Stage: 1](https://img.shields.io/badge/dev%20stage-★☆☆%20%281%29-000000?labelColor=dc332e)](https://github.com/InformaticsMatters/code-repository-development-stages)
 
+![Architecture](https://img.shields.io/badge/architecture-amd64%20%7C%20arm64-lightgrey)
+
 [![build](https://github.com/informaticsmatters/data-manager-jupyter-operator/actions/workflows/build.yaml/badge.svg)](https://github.com/informaticsmatters/data-manager-jupyter-operator/actions/workflows/build.yaml)
 [![build latest](https://github.com/informaticsmatters/data-manager-jupyter-operator/actions/workflows/build-latest.yaml/badge.svg)](https://github.com/informaticsmatters/data-manager-jupyter-operator/actions/workflows/build-latest.yaml)
 [![build tag](https://github.com/informaticsmatters/data-manager-jupyter-operator/actions/workflows/build-tag.yaml/badge.svg)](https://github.com/informaticsmatters/data-manager-jupyter-operator/actions/workflows/build-tag.yaml)
@@ -59,40 +61,41 @@ current health of your clone with: -
 The operator container, residing in the `operator` directory,
 is automatically built and pushed to Docker Hub using GitHub Actions.
 
-You can build the image yourself using docker-compose.
-The following will build an operator image with the tag `19.0.0-alpha.1`: -
+You can build and push the image yourself using docker-compose.
+The following will build an operator image with the tag `19.2.0-alpha.1`: -
 
-    $ export IMAGE_TAG=19.0.0-alpha.1
-    $ docker-compose build
+    export IMAGE_TAG=19.2.0-alpha.1
+    docker-compose build
+    dcoker-compose push
 
 ## Deploying into the Data Manager API
 We use [Ansible] 3 and community modules in [Ansible Galaxy] as the deployment
 mechanism, using the `operator` Ansible role in this repository and a
 Kubernetes config (KUBECONFIG). All of this is done via a suitable Python
 environment using the requirements in the root of the project...
 
-    $ python -m venv ~/.venv/data-manager-jupyter-operator
-    $ source ~/.venv/data-manager-jupyter-operator/bin/activate
-    $ pip install --upgrade pip
-    $ pip install -r requirements.txt
-    $ ansible-galaxy install -r requirements.yaml
+    python -m venv venv
+    source venv/bin/activate
+    pip install --upgrade pip
+    pip install -r requirements.txt
+    ansible-galaxy install -r requirements.yaml
 
 Set your KUBECONFIG for the cluster and verify its right: -
 
-    $ export KUBECONFIG=~/k8s-config/local-config
-    $ kubectl get no
+    export KUBECONFIG=~/k8s-config/local-config
+    kubectl get no
     [...]
 
 Now, create a parameter file (i.e. `parameters.yaml`) based on the project's
 `example-parameters.yaml`, setting values for the operator that match your
 needs. Then deploy, using Ansible, from the root of the project: -
 
-    $ export PARAMS=parameters
-    $ ansible-playbook -e @${PARAMS}.yaml site.yaml
+    export PARAMS=parameters
+    ansible-playbook -e @${PARAMS}.yaml site.yaml
 
 To remove the operator (assuming there are no operator-derived instances)...
 
-    $ ansible-playbook -e @${PARAMS}.yaml -e jo_state=absent site.yaml
+    ansible-playbook -e @${PARAMS}.yaml -e jo_state=absent site.yaml
 
 >   The current Data Manager API assumes that once an Application (operator)
     has been installed it is not removed. So, removing the operator here
@@ -105,9 +108,9 @@ are held in this repository.
 
 To deploy: -
 
-    $ export KUBECONFIG=~/k8s-config/config-aws-im-main-eks
-    $ export PARAMS=staging
-    $ ansible-playbook -e @${PARAMS}-parameters.yaml site.yaml
+    export KUBECONFIG=~/k8s-config/config-aws-im-main-eks
+    export PARAMS=staging
+    ansible-playbook -e @${PARAMS}-parameters.yaml site.yaml
 
 >   You will need the vault password, held in the company's KeePass under
     `data-manager-jupyter-operator -> Ansible Vault Password`
@@ -162,7 +165,7 @@ Data Manager's **Namespace**.
 Typical **Role** and **RoleBinding** definitions are provided in this
 repository. Once you define yours you'll just need to create them: -
 
-    $ kubectl create -f data-manager-rbac.yaml
+    kubectl create -f data-manager-rbac.yaml
 
 With this done the application should be visible through the Data Manager API's
 **/application** REST endpoint.

doc/LOCAL-DEPLOYMENT.md

@@ -9,7 +9,7 @@ You will now need: -
 
 - This repository (but you'll have that already)
 - Python 3
-- [lens]
+- A [kubectl] that matches your cluster
 
 ## Create an environment for the Ansible playbooks
 You will need a Python virtual environment for ansible playbook execution.
@@ -18,17 +18,16 @@ this one.
 
 You must use Python 3: -
 
-    python -m venv  ~/.venv/ansible
+    python -m venv venv
 
-    source ~/.venv/ansible/bin/activate
-    pip install wheel
+    source venv/bin/activate
     pip install -r requirements.txt
 
 ## Deploy the Jupyter Operator
 From the root of your clone of the `data-manager-jupyter-operator` repository,
 and within the Ansible environment you created in the previous step,
-create a suitable Ansible parameter file called `parameters.yaml` using the
-`parameters-template.yaml` file as a guide, replacing the `SetMe` lines.
+copy the `local-parameters.yaml` file to `parameters.yaml` and change the variables
+to suit your local cluster.
 
 >   You will need a KUBECONFIG file, and refer to it using the `jo_kubeconfig`
     variable and make sure `kubectl get no` returns nodes you expect.
@@ -37,10 +36,18 @@ Now deploy the Job Operator: -
 
     ansible-playbook site.yaml -e @parameters.yaml
 
->   You can check the deployment progress using [Lens].
+The operator should deploy to the namespace `data-manager-jupyter-operator`.
+Run: -
+
+    kubectl get po -n data-manager-jupyter-operator
+
+To see something like this...
+
+    NAME                                READY   STATUS    RESTARTS   AGE
+    jupyter-operator-6895bc77f9-9pg44   1/1     Running   0          35s
 
 ---
 
 [docker desktop]: https://www.docker.com/products/docker-desktop
-[lens]: https://k8slens.dev
-[minikube]: https://minikube.sigs.k8s.io/docs/start/
+[kubectl]: https://kubernetes.io/docs/tasks/tools
+[minikube]: https://minikube.sigs.k8s.io/docs/start

docker-compose.yaml

@@ -5,21 +5,21 @@
 # You can control some of the behaviour of the build
 # with environment variables: -
 #
-# - IMAGE_TAG The image version tag (default 19.0.0)
+# - IMAGE_TAG The image version tag (default 19.2.0)
 #
 # Note: The image tag MUST use the major version of the
 #       kubernetes package the operator is built against.
 #       The minor/patch values are free for your use.
 #
 # i.e.: -
 #
-#   IMAGE_TAG=19.0.0-alpha.1 docker-compose build
-#   IMAGE_TAG=19.0.0-alpha.1 docker-compose push
+#   IMAGE_TAG=19.3.0-alpha.1 docker-compose build
+#   IMAGE_TAG=19.3.0-alpha.1 docker-compose push
 
 version: '3.8'
 
 services:
   operator:
     build:
       context: operator
-    image: informaticsmatters/data-manager-jupyter-operator:${IMAGE_TAG:-19.0.0}
+    image: informaticsmatters/data-manager-jupyter-operator:${IMAGE_TAG:-19.2.0}

docker-desktop-parameters.yaml

@@ -3,7 +3,7 @@
 jo_ingress_domain: kubernetes.docker.internal
 jo_ingress_tls_secret: data-manager-api-tls
 jo_dmapi_namespace: data-manager-api
-jo_image_tag: 19.1.2
+jo_image_tag: 19.2.0
 jo_namespaces: data-manager-api
 
 jo_kubeconfig: "{{ lookup('env', 'KUBECONFIG') }}"

integration-parameters.yaml

@@ -1,9 +1,10 @@
 ---
 
+jo_image_tag: 19.2.0
+jo_dmapi_namespace: data-manager-api-integration
+
 jo_ingress_domain: squonk.it
 jo_ingress_tls_secret: data-manager-api-tls
-jo_dmapi_name: integration
-jo_image_tag: 19.0.2
 jo_namespaces: data-manager-api-staging:data-manager-api-integration:data-manager-api-production
 
 jo_kubeconfig: "{{ lookup('env', 'KUBECONFIG') }}"

local-parameters.yaml

@@ -0,0 +1,8 @@
+---
+
+jo_image_tag: 19.2.0
+jo_ingress_domain: kubernetes.docker.internal
+jo_dmapi_namespace: data-manager-api
+
+# The Kubernetes config file
+jo_kubeconfig: ~/k8s-config/config-local