From 19022ecbeb7730dc1c205da615d22c084503b125 Mon Sep 17 00:00:00 2001 From: Michael Barroco Date: Mon, 5 Aug 2024 21:31:07 +0200 Subject: [PATCH 1/6] [helm] Remove default dss image to force user to set manually the version --- deploy/services/helm-charts/dss/values.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/deploy/services/helm-charts/dss/values.yaml b/deploy/services/helm-charts/dss/values.yaml index cf3fab895..1b1af3a7c 100644 --- a/deploy/services/helm-charts/dss/values.yaml +++ b/deploy/services/helm-charts/dss/values.yaml @@ -13,6 +13,3 @@ cockroachdb: enabled: false ingress: enabled: false - -dss: - image: docker.io/interuss/dss:v0.7.0 \ No newline at end of file From 21d530581ad6fcc822afb909962775dcb62eb463 Mon Sep 17 00:00:00 2001 From: Michael Barroco Date: Mon, 5 Aug 2024 21:37:54 +0200 Subject: [PATCH 2/6] Add note about latest tag usage --- deploy/services/helm-charts/dss/values.schema.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/deploy/services/helm-charts/dss/values.schema.json b/deploy/services/helm-charts/dss/values.schema.json index 829f67180..63f388828 100644 --- a/deploy/services/helm-charts/dss/values.schema.json +++ b/deploy/services/helm-charts/dss/values.schema.json @@ -133,7 +133,8 @@ "type": "object", "properties": { "image": { - "type": "string" + "type": "string", + "description": "Image of the DSS. See the following link for official image releases. Please note that the usage of the `latest` tag is discouraged to prevent accidental upgrades in case of restart. https://hub.docker.com/r/interuss/dss/tags" }, "conf": { "type": "object", From 667b438f373f0e5eb5b1cd17600dc022c7027685 Mon Sep 17 00:00:00 2001 From: Michael Barroco Date: Mon, 5 Aug 2024 21:57:46 +0200 Subject: [PATCH 3/6] Preserve an example --- deploy/services/helm-charts/dss/values.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/services/helm-charts/dss/values.schema.json b/deploy/services/helm-charts/dss/values.schema.json index 63f388828..d9790ff03 100644 --- a/deploy/services/helm-charts/dss/values.schema.json +++ b/deploy/services/helm-charts/dss/values.schema.json @@ -134,7 +134,7 @@ "properties": { "image": { "type": "string", - "description": "Image of the DSS. See the following link for official image releases. Please note that the usage of the `latest` tag is discouraged to prevent accidental upgrades in case of restart. https://hub.docker.com/r/interuss/dss/tags" + "description": "Image of the DSS. Please note that the usage of the `latest` tag is discouraged to prevent accidental upgrades in case of restart. Example: `docker.io/interuss/dss:v0.15.0`. Official image releases: https://hub.docker.com/r/interuss/dss/tags" }, "conf": { "type": "object", From e77a54b10450b888ab13df3c2b2c091265d5633e Mon Sep 17 00:00:00 2001 From: Michael Barroco Date: Mon, 5 Aug 2024 22:15:48 +0200 Subject: [PATCH 4/6] Update example and readme --- deploy/services/helm-charts/dss/README.md | 3 ++- .../helm-charts/dss/values.example.yaml | 19 ++++++++++--------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/deploy/services/helm-charts/dss/README.md b/deploy/services/helm-charts/dss/README.md index 7e4a15d5e..8639d37e3 100644 --- a/deploy/services/helm-charts/dss/README.md +++ b/deploy/services/helm-charts/dss/README.md @@ -8,7 +8,8 @@ Requirements and instructions to create a new Kubernetes cluster can be found [h 3. Install [Helm](https://helm.sh/) version 3.11.3 or higher ## Usage -1. Copy `values.example.yaml` to `values.dev.yaml` and edit it. See `values.schema.json` for schema definition. (Note that the key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)). +1. Copy `values.example.yaml` to `values.dev.yaml` and edit it. In particular, the key `dss.image` must be set manually. +See `values.schema.json` for schema definition. The root key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)). Note that values.yaml contains the default values and are always passed to helm. 2. Validate the configuration: `helm lint -f values.dev.yaml .` 3. Set a RELEASE_NAME to `dss`: `export RELEASE_NAME=dss` diff --git a/deploy/services/helm-charts/dss/values.example.yaml b/deploy/services/helm-charts/dss/values.example.yaml index aee606033..b49832e1f 100644 --- a/deploy/services/helm-charts/dss/values.example.yaml +++ b/deploy/services/helm-charts/dss/values.example.yaml @@ -1,5 +1,15 @@ # See values.schema.json for schema description +dss: + # image: docker.io/interuss/dss:v0.15.0 # See https://hub.docker.com/r/interuss/dss/tags for official image releases. + conf: + pubKeys: + - /test-certs/auth2.pem + jwksEndpoint: '' + jwksKeyIds: [] + hostname: dss.example.com + enableScd: true + cockroachdb: # See https://github.com/cockroachdb/helm-charts/blob/master/cockroachdb/values.yaml fullnameOverride: dss-cockroachdb @@ -32,14 +42,5 @@ loadBalancers: # subnet: subnet-xxx # for aws only # certName: arn:xxxx # for aws only -dss: - conf: - pubKeys: - - /test-certs/auth2.pem - jwksEndpoint: '' - jwksKeyIds: [] - hostname: dss.example.com - enableScd: true - global: cloudProvider: google From 3cee6065eb234f573bf1aa3f0119791f75e25561 Mon Sep 17 00:00:00 2001 From: Michael Barroco Date: Wed, 7 Aug 2024 16:35:45 +0100 Subject: [PATCH 5/6] Address PR comments --- deploy/services/helm-charts/dss/README.md | 3 +-- deploy/services/helm-charts/dss/values.example.yaml | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/deploy/services/helm-charts/dss/README.md b/deploy/services/helm-charts/dss/README.md index 8639d37e3..48ec2aa72 100644 --- a/deploy/services/helm-charts/dss/README.md +++ b/deploy/services/helm-charts/dss/README.md @@ -9,8 +9,7 @@ Requirements and instructions to create a new Kubernetes cluster can be found [h ## Usage 1. Copy `values.example.yaml` to `values.dev.yaml` and edit it. In particular, the key `dss.image` must be set manually. -See `values.schema.json` for schema definition. The root key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)). -Note that values.yaml contains the default values and are always passed to helm. +See `values.schema.json` for schema definition. The root key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)). Note that values.yaml contains the default values and are always passed to helm. 2. Validate the configuration: `helm lint -f values.dev.yaml .` 3. Set a RELEASE_NAME to `dss`: `export RELEASE_NAME=dss` It is temporarily the only release name possible. diff --git a/deploy/services/helm-charts/dss/values.example.yaml b/deploy/services/helm-charts/dss/values.example.yaml index b49832e1f..52cda8dcf 100644 --- a/deploy/services/helm-charts/dss/values.example.yaml +++ b/deploy/services/helm-charts/dss/values.example.yaml @@ -1,7 +1,7 @@ # See values.schema.json for schema description dss: - # image: docker.io/interuss/dss:v0.15.0 # See https://hub.docker.com/r/interuss/dss/tags for official image releases. + image: docker.io/interuss/dss:v0.15.0 # See https://hub.docker.com/r/interuss/dss/tags for official image releases. conf: pubKeys: - /test-certs/auth2.pem From ca3e3f5d66b6ffd4347c1d69630d3fe329f43aea Mon Sep 17 00:00:00 2001 From: Michael Barroco Date: Wed, 7 Aug 2024 16:41:08 +0100 Subject: [PATCH 6/6] Fix broken paragraph in README --- deploy/services/helm-charts/dss/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/deploy/services/helm-charts/dss/README.md b/deploy/services/helm-charts/dss/README.md index 48ec2aa72..291d1994c 100644 --- a/deploy/services/helm-charts/dss/README.md +++ b/deploy/services/helm-charts/dss/README.md @@ -8,8 +8,7 @@ Requirements and instructions to create a new Kubernetes cluster can be found [h 3. Install [Helm](https://helm.sh/) version 3.11.3 or higher ## Usage -1. Copy `values.example.yaml` to `values.dev.yaml` and edit it. In particular, the key `dss.image` must be set manually. -See `values.schema.json` for schema definition. The root key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)). Note that values.yaml contains the default values and are always passed to helm. +1. Copy `values.example.yaml` to `values.dev.yaml` and edit it. In particular, the key `dss.image` must be set manually. See `values.schema.json` for schema definition. The root key `cockroachdb` supports all values supported by the [`cockroachdb` Chart](https://github.com/cockroachdb/helm-charts/tree/master/cockroachdb#configuration)). Note that values.yaml contains the default values and are always passed to helm. 2. Validate the configuration: `helm lint -f values.dev.yaml .` 3. Set a RELEASE_NAME to `dss`: `export RELEASE_NAME=dss` It is temporarily the only release name possible.