docs: Refinements matching the job operator

Author: Alan Christie

README.md

@@ -61,20 +61,21 @@ 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
+    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
+    python -m venv venv
+    source venv/bin/activate
     pip install --upgrade pip
     pip install -r requirements.txt
     ansible-galaxy install -r requirements.yaml

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

local-parameters.yaml

@@ -1,6 +1,7 @@
 ---
 
 jo_image_tag: 19.2.0
+jo_ingress_domain: kubernetes.docker.internal
 jo_dmapi_namespace: data-manager-api
 
 # The Kubernetes config file