Add K3D instructions

README.md

@@ -2,15 +2,56 @@
 
 Local dev environment for the COOPGO Technical Platform, using [Tilt](https://tilt.dev) and a local Kubernetes cluster (such as [Rancher Desktop](https://rancherdesktop.io/), K3D, ...)
 
-Tested with Rancher Desktop.
+Tested with Rancher Desktop and K3D.
 
 ## Quickstart
 
-1. Install Rancher Dektop or K3D or any other local Kubernetes. Make your Kubernetes context point to this cluster
+### Install local cluster
 
-2. [Install Tilt](https://docs.tilt.dev/install.html)
+Install Rancher Dektop or K3D or any other local Kubernetes. Make your Kubernetes context point to this cluster
 
-3. Create a .env file and configure environment
+Later, we will be using port 80 to access the cluster Ingress controller. On Linux, you must probably allow this.
+
+```
+sudo sysctl -w net.ipv4.ip_unprivileged_port_start=80
+```
+
+To preserve this change across reboots as a custom kernel parameter setting, add the same command inside your /etc/sysctl.conf file (or a dedicated /etc/sysctl.d/xxxxx.conf).
+
+#### Rancher Desktop
+
+See installation instructions here : https://docs.rancherdesktop.io/getting-started/installation
+
+#### K3D 
+
+Install K3D : 
+
+```
+curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
+```
+
+Create config for the internal K3D registry to mirror your default docker images registry, for example in `/tmp/k3d-registry.yaml` :
+
+```
+mirrors:
+  docker.io:
+    endpoint:
+      - "git.coopgo.io"
+```
+
+Create cluster :
+
+``` 
+k3d cluster create devcluster -p "80:80@loadbalancer" --registry-create devregistry:5000 --registry-config /tmp/k3d-registry.yaml
+```
+
+### Install Tilt 
+
+[Follow instructions on Tilt documentation](https://docs.tilt.dev/install.html)
+
+### Set the environment
+
+Create a .env file and configure environment
 
 For example, to set the source code directories (see default values in Tiltfile) :
 
@@ -24,25 +65,43 @@ GROUPS_MANAGEMENT_DIR="../../coopgo-platform/groups-management"
 
 To avoid developing on another cluster than the one dedicated for dev, we whitelist the correct context. By default, the allowed context is 'rancher-desktop'. To change this, set ALLOWED_K8S_CONTEXT to the correct context name in .env :
 
-```
+``` 
 ALLOWED_K8S_CONTEXT="k3d-devcluster"
 ```
 
 You might also want to set the default container images used if/while your local source code folder doesn't exist.
 
-```
+``` 
-PARCOURSMOB_IMAGE=my.own.registry/coopgo-platform/parcoursmob@v1.2
+PARCOURSMOB_IMAGE=coopgo-apps/parcoursmob@v1.2
 MOBILITY_ACCOUNTS_IMAGE=my.own.registry/coopgo-platform/mobility-accounts
 ...
 ```
 
-4. Add `tilt-dev.svc.cluster.local parcoursmob.tilt-dev.svc.cluster.local mobility-accounts.tilt-dev.svc.cluster.local` to resolve `127.0.0.1` in your hosts config (`/etc/hosts` on Linux)
+#### K3D specific setup 
 
-5. Run `tilt up`
+If you're using K3D, remove the registry part in the images (we'll use K3D local registry instead). It should look something like this :
 
-6. After some time (you can see the services loading -or failing, if there is an error- through Tilt UI), PARCOURSMOB should be available on http://parcoursmob.tilt-dev.svc.cluster.local
+``` 
+PARCOURSMOB_IMAGE=coopgo-apps/parcoursmob 
+MOBILITY_ACCOUNTS_IMAGE=coopgo-platform/mobility-accounts
+...
+```
 
-To have this work, make sure port 80 is unprivileged if you're using Linux. This is described in Rancher Desktop documentation. If you're using something else to run Kubernetes, make sure you have the right port forwarding and an Ingress controller on your cluster to target port 80 on localhost.
+Then, set the K8S config to the dedicated overlay in k8s_config :
+
+``` 
+K8S_CONFIG="k8s_config/k3d"
+```
+
+### Set local hosts config 
+
+Add `tilt-dev.svc.cluster.local parcoursmob.tilt-dev.svc.cluster.local mobility-accounts.tilt-dev.svc.cluster.local` to resolve `127.0.0.1` in your hosts config (`/etc/hosts` on Linux)
+
+### Run the dev environment and start developing 
+
+Run `tilt up`
+
+After some time (you can see the services loading -or failing, if there is an error- through Tilt UI), PARCOURSMOB should be available on http://parcoursmob.tilt-dev.svc.cluster.local
 
 Once you can acess PARCOURSMOB UI, you can connect with the initially created user :
 
@@ -74,4 +133,4 @@ Tilt handles livereloading Kubernetes pods when something changes in the code. Y
 Access smtp4dev to check outgoing emails :
 
 1. Forward smtp4dev service locally : kubectl port-forward svc/smtp4dev 9090:80
-2. Access UI : http://localhost:9090/
+2. Access UI : http://localhost:9090/

Tiltfile

@@ -5,13 +5,6 @@ dotenv()
 
 allowed_k8s_context = os.environ.get('ALLOWED_K8S_CONTEXT', 'rancher-desktop')
 
-# parcoursmob_dir = os.path.realpath(os.environ.get('PARCOURSMOB_DIR', 'src/parcoursmob'))
-# parcoursmob_theme_dir = os.path.realpath(os.environ.get('PARCOURSMOB_THEME_DIR', 'src/parcoursmob/themes/default'))
-# mobility_accounts_dir = os.path.realpath(os.environ.get('MOBILITY_ACCOUNTS_DIR', 'src/mobility-accounts'))
-# agenda_dir = os.path.realpath(os.environ.get('AGENDA_DIR', 'src/agenda'))
-# fleets_dir = os.path.realpath(os.environ.get('FLEETS_DIR', 'src/fleets'))
-# groups_management_dir = os.path.realpath(os.environ.get('GROUPS_MANAGEMENT_DIR', 'src/groups-management'))
-
 parcoursmob_dir = os.environ.get('PARCOURSMOB_DIR', 'src/parcoursmob')
 parcoursmob_theme_dir = os.environ.get('PARCOURSMOB_THEME_DIR', 'src/parcoursmob/themes/default')
 mobility_accounts_dir = os.environ.get('MOBILITY_ACCOUNTS_DIR', 'src/mobility-accounts')
@@ -25,9 +18,9 @@ agenda_image = os.environ.get('AGENDA_IMAGE', 'git.coopgo.io/coopgo-platform/age
 fleets_image = os.environ.get('FLEETS_IMAGE', 'git.coopgo.io/coopgo-platform/fleets')
 groups_management_image = os.environ.get('GROUPS_MANAGEMENT_IMAGE', 'git.coopgo.io/coopgo-platform/groups-management')
 
-
 allow_k8s_contexts(allowed_k8s_context)
 
+k8s_config = os.environ.get('K8S_CONFIG', 'k8s_config/dev')
 
 if os.path.exists(parcoursmob_dir) and os.path.exists(parcoursmob_theme_dir):
     parcoursmob_dir = os.path.realpath(parcoursmob_dir)
@@ -72,5 +65,5 @@ if os.path.exists(groups_management_dir):
     print("Directory : {dir}".format(dir=groups_management_dir))
     deploy_go('groups-management', groups_management_dir, groups_management_image)
 
-k8s_yaml(kustomize('k8s_config/dev'))
+k8s_yaml(kustomize(k8s_config))
 

k8s_config/k3d/kustomization.yaml

@@ -0,0 +1,12 @@
+resources: 
+  - ../dev/ 
+
+images:
+  - name: git.coopgo.io/coopgo-apps/parcoursmob
+    newName: "coopgo-apps/parcoursmob"
+  - name: git.coopgo.io/coopgo-platform/mobility-accounts
+    newName: "coopgo-platform/mobility-accounts"
+  - name: git.coopgo.io/coopgo-platform/fleets
+    newName: "coopgo-platform/fleets"
+  - name: git.coopgo.io/coopgo-platform/agenda
+    newName: "coopgo-platform/agenda"