fix: Changes for cluster-wide operator

BREAKING CHANGE

Author: Alan Christie

.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

.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

README.md

@@ -62,37 +62,37 @@ 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`: -
 
-    $ export IMAGE_TAG=19.0.0-alpha.1
-    $ docker-compose build
+    export IMAGE_TAG=19.0.0-alpha.1
+    docker-compose build
 
 ## 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/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
 
 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 +105,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 +162,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.

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,7 @@
+---
+
+jo_image_tag: 19.2.0
+jo_dmapi_namespace: data-manager-api
+
+# The Kubernetes config file
+jo_kubeconfig: ~/k8s-config/config-local

operator/Dockerfile

@@ -1,4 +1,11 @@
-FROM python:3.9.12-slim
+FROM python:3.10.4-slim
+
+# Labels
+LABEL maintainer='Alan Christie <[email protected]>'
+
+# Force the binary layer of the stdout and stderr streams
+# to be unbuffered
+ENV PYTHONUNBUFFERED 1
 
 COPY requirements.txt ./
 RUN pip install -r requirements.txt

operator/entrypoint.sh

@@ -1,3 +1,2 @@
 #!/usr/bin/env bash
-NS=$(cat /var/run/secrets/kubernetes.io/serviceaccount/namespace)
-kopf run ./handlers.py --verbose --standalone --namespace=${NS} --log-format full
+kopf run ./handlers.py --verbose --standalone --all-namespaces --log-format full

operator/handlers.py

@@ -4,33 +4,33 @@
 import random
 import os
 import string
-from typing import Any, Dict
+from typing import Any, Dict, Optional
 
 import kubernetes
 import kopf
 
 # Some (key) default deployment variables...
-_DEFAULT_IMAGE = "jupyter/minimal-notebook:notebook-6.3.0"
-_DEFAULT_SA = "default"
-_DEFAULT_CPU_LIMIT = "1"
-_DEFAULT_CPU_REQUEST = "10m"
-_DEFAULT_MEM_LIMIT = "1Gi"
-_DEFAULT_MEM_REQUEST = "256Mi"
-_DEFAULT_USER_ID = 1000
-_DEFAULT_GROUP_ID = 100
-_DEFAULT_INGRESS_PROXY_BODY_SIZE = "500m"
+_DEFAULT_IMAGE: str = "jupyter/minimal-notebook:notebook-6.3.0"
+_DEFAULT_SA: str = "default"
+_DEFAULT_CPU_LIMIT: str = "1"
+_DEFAULT_CPU_REQUEST: str = "10m"
+_DEFAULT_MEM_LIMIT: str = "1Gi"
+_DEFAULT_MEM_REQUEST: str = "256Mi"
+_DEFAULT_USER_ID: int = 1000
+_DEFAULT_GROUP_ID: int = 100
+_DEFAULT_INGRESS_PROXY_BODY_SIZE: str = "500m"
 
 # The ingress class
-_INGRESS_CLASS = "nginx"
+_INGRESS_CLASS: str = "nginx"
 # The ingress domain must be provided.
-ingress_domain = os.environ["INGRESS_DOMAIN"]
+ingress_domain: str = os.environ["INGRESS_DOMAIN"]
 # The ingress TLS secret is optional.
 # If provided it is used as the Ingress secret
 # and cert-manager is avoided.
-ingress_tls_secret = os.environ.get("INGRESS_TLS_SECRET")
+ingress_tls_secret: Optional[str] = os.environ.get("INGRESS_TLS_SECRET")
 # The cert-manager issuer,
 # expected if a TLS certificate is not defined.
-ingress_cert_issuer = os.environ.get("INGRESS_CERT_ISSUER")
+ingress_cert_issuer: Optional[str] = os.environ.get("INGRESS_CERT_ISSUER")
 
 # Application node selection
 _POD_NODE_SELECTOR_KEY: str = os.environ.get(
@@ -51,7 +51,7 @@
 # As part of the startup we erase the existing '~/.bashrc' and,
 # as a minimum, set a more suitable PS1 (see ch2385).
 # 'conda init' then puts its stuff into the same file.
-_NOTEBOOK_STARTUP = """#!/bin/bash
+_NOTEBOOK_STARTUP: str = """#!/bin/bash
 echo "PS1='\$(pwd) \$UID$ '" > ~/.bashrc
 echo "umask 0002" >> ~/.bashrc
 conda init
@@ -72,7 +72,7 @@
 
 # The bash-profile
 # which simply launches the .bashrc
-_BASH_PROFILE = """if [ -f ~/.bashrc ]; then
+_BASH_PROFILE: str = """if [ -f ~/.bashrc ]; then
     source ~/.bashrc
 fi
 """
@@ -81,7 +81,7 @@
 # A ConfigMap whose content is written into '/etc'
 # and copied to the $HOME/.jupyter by the notebook_startup
 # script (above).
-_NOTEBOOK_CONFIG = """{
+_NOTEBOOK_CONFIG: str = """{
   "NotebookApp": {
     "token": "%(token)s",
     "base_url": "%(base_url)s"
@@ -97,7 +97,7 @@ def configure(settings: kopf.OperatorSettings, **_: Any) -> None:
     settings.posting.level = logging.INFO
 
 
-@kopf.on.create("squonk.it", "v1", "jupyternotebooks", id="jupyter")
+@kopf.on.create("squonk.it", "v2", "jupyternotebooks", id="jupyter")
 def create(spec: Dict[str, Any], name: str, namespace: str, **_: Any) -> Dict[str, Any]:
     """Handler for CRD create events.
     Here we construct the required Kubernetes objects,