Skip to content

Commit 4eb88ed

Browse files
committed
Add API params for Advanced Settings
1 parent 359f414 commit 4eb88ed

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed
184 KB
Loading

source/plugins/cloudstack-kubernetes-service.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ Once the ISO has been built for a desired Kubernetes version, it can be added by
9595

9696
|cks-add-version-form.png|
9797

98+
.. note::
99+
Since 4.21.0 it is possible to deploy separate dedicated etcd nodes. This requires the Kubernetes ISO contains the etcd binaries.
100+
98101
addKubernetesSupportedVersion API can be used by an admin to add a new supported version for the service. It takes following input parameters:
99102

100103
- **name** (the name of the Kubernetes supported version) · semanticversion (the semantic version of the Kubernetes release in MAJOR.MINOR.PATCH format. More about semantic versioning here: https://semver.org/ Required)
@@ -197,6 +200,13 @@ New Kubernetes clusters can be created using the API or via the UI. User will be
197200

198201
|cks-create-cluster-form.png|
199202

203+
Since 4.21.0, users will be provided with an additional section displayed when toggling the option: 'Show Advanced Settings'. On this section, users can select templates and service offerings for:
204+
- Worker nodes
205+
- Control nodes
206+
- Etcd nodes (if one or more are selected, no etcd nodes are selected by default)
207+
208+
|cks-create-cluster-additional-settings.png|
209+
200210
createKubernetesCluster API can be used to create new Kubernetes cluster. It takes following parameters as input,
201211

202212
- **name** (name for the Kubernetes cluster; Required)
@@ -218,6 +228,9 @@ createKubernetesCluster API can be used to create new Kubernetes cluster. It tak
218228
- **dockerregistrypassword** (password for the docker image private registry; Experimental)
219229
- **dockerregistryurl** (URL for the docker image private registry; Experimental)
220230
- **dockerregistryemail** (email of the docker image private registry user; Experimental)
231+
- **nodeofferings**: an optional map parameter to set the service offerings for worker, control or etcd nodes. If this parameter is not set, then every VM in the cluster will be deployed using the default service offering set on the serviceofferingid parameter.
232+
- **etcdnodes**: an optional integer parameter to specify the number etcd nodes in the cluster, the default value is 0. In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly.
233+
- **nodetemplates**: an optional map parameter to set the template to be used by worker, control or etcd nodes. If this parameter is not set, then every VM in the cluster will be deployed using the System VM template.
221234

222235
For example:
223236

@@ -420,6 +433,8 @@ To remove an Instance from an ExternalManaged Kubernetes cluster:
420433
:alt: Kubernetes clusters list.
421434
.. |cks-create-cluster-form.png| image:: /_static/images/cks-create-cluster-form.png
422435
:alt: Create Kubernetes Cluster form.
436+
.. |cks-create-cluster-additional-settings.png| image:: /_static/images/cks-create-cluster-additional-settings.png
437+
:alt: Create Kubernetes Cluster form with Advanced Settings.
423438
.. |cks-delete-action.png| image:: /_static/images/cks-delete-action.png
424439
:alt: Delete action icon.
425440
.. |cks-kube-config-action.png| image:: /_static/images/cks-kube-config-action.png

0 commit comments

Comments
 (0)