From 06ddc4cf4be7f3f813e7883c379d0df26a9ba093 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Tue, 15 Nov 2022 11:24:01 +0100 Subject: [PATCH 1/2] kube-arangodb: Correct spec.architecture description --- ...ployment-kubernetes-deployment-resource.md | 23 +++++++++++++++---- 3.10/deployment-kubernetes-usage.md | 2 +- ...ployment-kubernetes-deployment-resource.md | 23 +++++++++++++++---- 3.11/deployment-kubernetes-usage.md | 2 +- ...ployment-kubernetes-deployment-resource.md | 23 +++++++++++++++---- 3.8/deployment-kubernetes-usage.md | 2 +- ...ployment-kubernetes-deployment-resource.md | 23 +++++++++++++++---- 3.9/deployment-kubernetes-usage.md | 2 +- 8 files changed, 80 insertions(+), 20 deletions(-) diff --git a/3.10/deployment-kubernetes-deployment-resource.md b/3.10/deployment-kubernetes-deployment-resource.md index 0a69abfe71..dd5dad5703 100644 --- a/3.10/deployment-kubernetes-deployment-resource.md +++ b/3.10/deployment-kubernetes-deployment-resource.md @@ -62,30 +62,45 @@ with `` where `` can be any of: - `syncmasters` for all syncmasters of a `Cluster`. - `syncworkers` for all syncworkers of a `Cluster`. -### `spec.architectures: []string` +### `spec.architecture: []string` -This setting specifies a list of CPU architectures for the deployment. +This setting specifies a CPU architecture for the deployment. Possible values are: - `amd64` (default): Use processors with the x86-64 architecture. - `arm64`: Use processors with the 64-bit ARM architecture. +The setting expects a list of strings, but you should only specify a single +list item for the architecture, except when you want to migrate from one +architecture to the other. + {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using `--set "operator.architectures={amd64,arm64}"`. See [Installation with Helm](deployment-kubernetes-usage.html#installation-with-helm). {% endhint 'tip' %} -To let new members as well as recreated members use `arm64` nodes, modify the +To create a new deployment with `arm64` nodes, specify the architecture in the deployment specification as follows: +```yaml +spec: + architecture: + - arm64 +``` + +To migrate nodes of an existing deployment from `amd64` to `arm64`, modify the +deployment specification so that both architectures are listed: + ```diff spec: - architectures: + architecture: + - arm64 - amd64 ``` +This lets new members as well as recreated members use `arm64` nodes. + Then run the following command: ```bash diff --git a/3.10/deployment-kubernetes-usage.md b/3.10/deployment-kubernetes-usage.md index 4bf12146a5..247855158a 100644 --- a/3.10/deployment-kubernetes-usage.md +++ b/3.10/deployment-kubernetes-usage.md @@ -48,7 +48,7 @@ helm install $URLPREFIX/kube-arangodb-.tgz --set "operator.architecture Use at least version 1.2.20 of the operator to use the ARM architecture. {% endhint %} -Note that you need to set [`spec.architectures`](deployment-kubernetes-deployment-resource.html#specarchitectures-string) +Note that you need to set [`spec.architecture`](deployment-kubernetes-deployment-resource.html#specarchitecture-string) in the deployment specification, too, in order to create a deployment that runs on ARM chips. diff --git a/3.11/deployment-kubernetes-deployment-resource.md b/3.11/deployment-kubernetes-deployment-resource.md index 0a69abfe71..dd5dad5703 100644 --- a/3.11/deployment-kubernetes-deployment-resource.md +++ b/3.11/deployment-kubernetes-deployment-resource.md @@ -62,30 +62,45 @@ with `` where `` can be any of: - `syncmasters` for all syncmasters of a `Cluster`. - `syncworkers` for all syncworkers of a `Cluster`. -### `spec.architectures: []string` +### `spec.architecture: []string` -This setting specifies a list of CPU architectures for the deployment. +This setting specifies a CPU architecture for the deployment. Possible values are: - `amd64` (default): Use processors with the x86-64 architecture. - `arm64`: Use processors with the 64-bit ARM architecture. +The setting expects a list of strings, but you should only specify a single +list item for the architecture, except when you want to migrate from one +architecture to the other. + {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using `--set "operator.architectures={amd64,arm64}"`. See [Installation with Helm](deployment-kubernetes-usage.html#installation-with-helm). {% endhint 'tip' %} -To let new members as well as recreated members use `arm64` nodes, modify the +To create a new deployment with `arm64` nodes, specify the architecture in the deployment specification as follows: +```yaml +spec: + architecture: + - arm64 +``` + +To migrate nodes of an existing deployment from `amd64` to `arm64`, modify the +deployment specification so that both architectures are listed: + ```diff spec: - architectures: + architecture: + - arm64 - amd64 ``` +This lets new members as well as recreated members use `arm64` nodes. + Then run the following command: ```bash diff --git a/3.11/deployment-kubernetes-usage.md b/3.11/deployment-kubernetes-usage.md index 4bf12146a5..247855158a 100644 --- a/3.11/deployment-kubernetes-usage.md +++ b/3.11/deployment-kubernetes-usage.md @@ -48,7 +48,7 @@ helm install $URLPREFIX/kube-arangodb-.tgz --set "operator.architecture Use at least version 1.2.20 of the operator to use the ARM architecture. {% endhint %} -Note that you need to set [`spec.architectures`](deployment-kubernetes-deployment-resource.html#specarchitectures-string) +Note that you need to set [`spec.architecture`](deployment-kubernetes-deployment-resource.html#specarchitecture-string) in the deployment specification, too, in order to create a deployment that runs on ARM chips. diff --git a/3.8/deployment-kubernetes-deployment-resource.md b/3.8/deployment-kubernetes-deployment-resource.md index 0a69abfe71..dd5dad5703 100644 --- a/3.8/deployment-kubernetes-deployment-resource.md +++ b/3.8/deployment-kubernetes-deployment-resource.md @@ -62,30 +62,45 @@ with `` where `` can be any of: - `syncmasters` for all syncmasters of a `Cluster`. - `syncworkers` for all syncworkers of a `Cluster`. -### `spec.architectures: []string` +### `spec.architecture: []string` -This setting specifies a list of CPU architectures for the deployment. +This setting specifies a CPU architecture for the deployment. Possible values are: - `amd64` (default): Use processors with the x86-64 architecture. - `arm64`: Use processors with the 64-bit ARM architecture. +The setting expects a list of strings, but you should only specify a single +list item for the architecture, except when you want to migrate from one +architecture to the other. + {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using `--set "operator.architectures={amd64,arm64}"`. See [Installation with Helm](deployment-kubernetes-usage.html#installation-with-helm). {% endhint 'tip' %} -To let new members as well as recreated members use `arm64` nodes, modify the +To create a new deployment with `arm64` nodes, specify the architecture in the deployment specification as follows: +```yaml +spec: + architecture: + - arm64 +``` + +To migrate nodes of an existing deployment from `amd64` to `arm64`, modify the +deployment specification so that both architectures are listed: + ```diff spec: - architectures: + architecture: + - arm64 - amd64 ``` +This lets new members as well as recreated members use `arm64` nodes. + Then run the following command: ```bash diff --git a/3.8/deployment-kubernetes-usage.md b/3.8/deployment-kubernetes-usage.md index 06bff5fdde..cfda75de83 100644 --- a/3.8/deployment-kubernetes-usage.md +++ b/3.8/deployment-kubernetes-usage.md @@ -48,7 +48,7 @@ helm install $URLPREFIX/kube-arangodb-.tgz --set "operator.architecture Use at least version 1.2.20 of the operator to use the ARM architecture. {% endhint %} -Note that you need to set [`spec.architectures`](deployment-kubernetes-deployment-resource.html#specarchitectures-string) +Note that you need to set [`spec.architecture`](deployment-kubernetes-deployment-resource.html#specarchitecture-string) in the deployment specification, too, in order to create a deployment that runs on ARM chips. diff --git a/3.9/deployment-kubernetes-deployment-resource.md b/3.9/deployment-kubernetes-deployment-resource.md index 0a69abfe71..dd5dad5703 100644 --- a/3.9/deployment-kubernetes-deployment-resource.md +++ b/3.9/deployment-kubernetes-deployment-resource.md @@ -62,30 +62,45 @@ with `` where `` can be any of: - `syncmasters` for all syncmasters of a `Cluster`. - `syncworkers` for all syncworkers of a `Cluster`. -### `spec.architectures: []string` +### `spec.architecture: []string` -This setting specifies a list of CPU architectures for the deployment. +This setting specifies a CPU architecture for the deployment. Possible values are: - `amd64` (default): Use processors with the x86-64 architecture. - `arm64`: Use processors with the 64-bit ARM architecture. +The setting expects a list of strings, but you should only specify a single +list item for the architecture, except when you want to migrate from one +architecture to the other. + {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using `--set "operator.architectures={amd64,arm64}"`. See [Installation with Helm](deployment-kubernetes-usage.html#installation-with-helm). {% endhint 'tip' %} -To let new members as well as recreated members use `arm64` nodes, modify the +To create a new deployment with `arm64` nodes, specify the architecture in the deployment specification as follows: +```yaml +spec: + architecture: + - arm64 +``` + +To migrate nodes of an existing deployment from `amd64` to `arm64`, modify the +deployment specification so that both architectures are listed: + ```diff spec: - architectures: + architecture: + - arm64 - amd64 ``` +This lets new members as well as recreated members use `arm64` nodes. + Then run the following command: ```bash diff --git a/3.9/deployment-kubernetes-usage.md b/3.9/deployment-kubernetes-usage.md index 4bf12146a5..247855158a 100644 --- a/3.9/deployment-kubernetes-usage.md +++ b/3.9/deployment-kubernetes-usage.md @@ -48,7 +48,7 @@ helm install $URLPREFIX/kube-arangodb-.tgz --set "operator.architecture Use at least version 1.2.20 of the operator to use the ARM architecture. {% endhint %} -Note that you need to set [`spec.architectures`](deployment-kubernetes-deployment-resource.html#specarchitectures-string) +Note that you need to set [`spec.architecture`](deployment-kubernetes-deployment-resource.html#specarchitecture-string) in the deployment specification, too, in order to create a deployment that runs on ARM chips. From d20747d69aebd7eb5dded4fc4bd1cf31742b1263 Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Tue, 15 Nov 2022 11:42:04 +0100 Subject: [PATCH 2/2] The first list item defines the default deployment architecture --- 3.10/deployment-kubernetes-deployment-resource.md | 3 ++- 3.11/deployment-kubernetes-deployment-resource.md | 3 ++- 3.8/deployment-kubernetes-deployment-resource.md | 3 ++- 3.9/deployment-kubernetes-deployment-resource.md | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/3.10/deployment-kubernetes-deployment-resource.md b/3.10/deployment-kubernetes-deployment-resource.md index dd5dad5703..962c57eb19 100644 --- a/3.10/deployment-kubernetes-deployment-resource.md +++ b/3.10/deployment-kubernetes-deployment-resource.md @@ -72,7 +72,8 @@ Possible values are: The setting expects a list of strings, but you should only specify a single list item for the architecture, except when you want to migrate from one -architecture to the other. +architecture to the other. The first list item defines the new default +architecture for the deployment that you want to migrate to. {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using diff --git a/3.11/deployment-kubernetes-deployment-resource.md b/3.11/deployment-kubernetes-deployment-resource.md index dd5dad5703..962c57eb19 100644 --- a/3.11/deployment-kubernetes-deployment-resource.md +++ b/3.11/deployment-kubernetes-deployment-resource.md @@ -72,7 +72,8 @@ Possible values are: The setting expects a list of strings, but you should only specify a single list item for the architecture, except when you want to migrate from one -architecture to the other. +architecture to the other. The first list item defines the new default +architecture for the deployment that you want to migrate to. {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using diff --git a/3.8/deployment-kubernetes-deployment-resource.md b/3.8/deployment-kubernetes-deployment-resource.md index dd5dad5703..962c57eb19 100644 --- a/3.8/deployment-kubernetes-deployment-resource.md +++ b/3.8/deployment-kubernetes-deployment-resource.md @@ -72,7 +72,8 @@ Possible values are: The setting expects a list of strings, but you should only specify a single list item for the architecture, except when you want to migrate from one -architecture to the other. +architecture to the other. The first list item defines the new default +architecture for the deployment that you want to migrate to. {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using diff --git a/3.9/deployment-kubernetes-deployment-resource.md b/3.9/deployment-kubernetes-deployment-resource.md index dd5dad5703..962c57eb19 100644 --- a/3.9/deployment-kubernetes-deployment-resource.md +++ b/3.9/deployment-kubernetes-deployment-resource.md @@ -72,7 +72,8 @@ Possible values are: The setting expects a list of strings, but you should only specify a single list item for the architecture, except when you want to migrate from one -architecture to the other. +architecture to the other. The first list item defines the new default +architecture for the deployment that you want to migrate to. {% hint 'tip' %} To use the ARM architecture, you need to enable it in the operator first using