From 1491bbc81cfc4bb0080087892246ecb2cf540785 Mon Sep 17 00:00:00 2001 From: Maximilien Cuony Date: Wed, 11 Feb 2026 08:57:56 +0100 Subject: [PATCH] [doc] Improve minikube instructions --- deploy/services/helm-charts/dss/README.md | 2 +- deploy/services/tanka/README.md | 22 ++++++++++++++++++---- docs/infrastructure/minikube.md | 2 +- 3 files changed, 20 insertions(+), 6 deletions(-) diff --git a/deploy/services/helm-charts/dss/README.md b/deploy/services/helm-charts/dss/README.md index 6a529d2bf..4b8405c63 100644 --- a/deploy/services/helm-charts/dss/README.md +++ b/deploy/services/helm-charts/dss/README.md @@ -1,5 +1,5 @@ # Helm Chart -An [Helm Chart](https://helm.sh/) is provided [there](https://github.com/interuss/dss/tree/master/deploy/services/helm-charts/dss) to deploy the DSS and datastore (CockroachDB or Yugabyte) kubernetes resources. +This directory provides an [Helm Chart](https://helm.sh/) to deploy the DSS and datastore (CockroachDB or Yugabyte) kubernetes resources. ## Requirements 1. A Kubernetes cluster should be running and you should be properly authenticated. Requirements and instructions to create a new Kubernetes cluster can be found here: diff --git a/deploy/services/tanka/README.md b/deploy/services/tanka/README.md index b18883289..bc477e287 100644 --- a/deploy/services/tanka/README.md +++ b/deploy/services/tanka/README.md @@ -1,15 +1,29 @@ # Tanka library -A set of configuration to be used by [tanka](https://tanka.dev/install) to deploy a single DSS instance via -Kubernetes is provided [there](https://github.com/interuss/dss/tree/master/deploy/services/tanka). +This folder contains a set of configuration to be used with [tanka](https://tanka.dev/) to deploy a single DSS instance in a Kubernetes cluster. ## Requirements -This section hasn't been written yet. +1. A Kubernetes cluster should be running and you should be properly authenticated. Requirements and instructions to create a new Kubernetes cluster can be found here: + * [AWS](../../../docs/infrastructure/aws.md) + * [Google](../../../docs/infrastructure/google.md) + * [Minikube](../../../docs/infrastructure/minikube.md) + +2. Create the certificates and apply them to the cluster using the instructions [here](../../../docs/operations/certificates-management.md) +3. Install [Tanka](https://tanka.dev/install) ## Usage -This section hasn't been written yet. +There is a base file in `examples/minikube`. You can directly use it to deploy the service. + +Check first that you cluster is using `192.168.49.2` as IP with `minikube ip -p dss-local-cluster`. If that not the case, edit `examples/minikube/spec.json` accordingly. + +To apply changes, use the following command: + +* `cd examples/minikube` +* `tk apply .` + +You may edit `main.jsonnet` as needed should you want to change configuration, or docker images used. ## Job cleanup diff --git a/docs/infrastructure/minikube.md b/docs/infrastructure/minikube.md index 9a82c0040..ea8f2467c 100644 --- a/docs/infrastructure/minikube.md +++ b/docs/infrastructure/minikube.md @@ -34,7 +34,7 @@ You can also use any other tool as needed. You can switch to the cluster's conte Should you want to run the local docker image that you [built](./google-manual.md#prerequisites), run the following commands to upload / update your image -1. `minikube image -p dss-local-cluster push interuss-local/dss` +1. `minikube image -p dss-local-cluster load interuss-local/dss` In the helm charts, use `docker.io/interuss-local/dss:latest` as image and be sure to set the `imagePullPolicy` to `Never`.