Deckhouse Platform in existing cluster
Select the Deckhouse Platform edition
- Community Edition
- Basic Edition
- Standard Edition
- Standard Edition+
- Enterprise Edition
The recommended settings for a Deckhouse Platform Community Edition installation are generated below:
config.yml— a file with the configuration needed to bootstrap the cluster. Contains the installer parameters, and the initial cluster parameters.
Pay attention to:
- highlighted parameters you must define.
- parameters you might want to change.
- Read the If something went wrong section first: it may already describe the case of your provider. Refer to it if you have any problems during the installation process.
Create the config.yml file.
# Deckhouse module settings.
# https://deckhouse.io/modules/deckhouse/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: deckhouse
spec:
version: 1
enabled: true
settings:
bundle: Minimal
# Deckhouse release channel. The Early Access channel is stable enough to be used in production environments.
# If you have several clusters, set different release channels on them.
# More info: https://deckhouse.io/products/kubernetes-platform/documentation/v1/reference/release-channels.html
releaseChannel: EarlyAccess
logLevel: Info
---
# Global Deckhouse settings.
# https://deckhouse.io/products/kubernetes-platform/documentation/v1/reference/api/global.html#parameters
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
modules:
# Template that will be used for system apps domains within the cluster.
# E.g., Grafana for %s.example.com will be available as 'grafana.example.com'.
# The domain MUST NOT match the one specified in the clusterDomain parameter of the ClusterConfiguration resource.
# You can change it to your own or follow the steps in the guide and change it after installation.
publicDomainTemplate: "%s.example.com"
# If necessary, specify in the customTolerationKeys array
# all the taints to which Deckhouse Platform should have tolerations.
# The following is an example for the case if you need Deckhouse Platform and its components to be able
# to run on nodes that have the SystemLoad taint.
# You might consider changing this.
placement:
customTolerationKeys:
- SystemLoad
---
# cert-manager module settings.
# https://deckhouse.io/modules/cert-manager/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: cert-manager
spec:
version: 1
enabled: true
---
# documentation module settings.
# https://deckhouse.io/modules/documentation/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: documentation
spec:
version: 1
enabled: true
Enter license key
Have no key?
The recommended settings for a Deckhouse Platform Basic Edition installation are generated below:
config.yml— a file with the configuration needed to bootstrap the cluster. Contains the installer parameters, and the initial cluster parameters.
Pay attention to:
- highlighted parameters you must define.
- parameters you might want to change.
- Read the If something went wrong section first: it may already describe the case of your provider. Refer to it if you have any problems during the installation process.
Create the config.yml file.
# Deckhouse module settings.
# https://deckhouse.io/modules/deckhouse/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: deckhouse
spec:
version: 1
enabled: true
settings:
bundle: Minimal
releaseChannel: Stable
logLevel: Info
# Settings for accessing the container registry with Deckhouse images.
registry:
mode: Unmanaged
unmanaged:
imagesRepo: registry.deckhouse.io/deckhouse/<REVISION>
license: <YOUR_ACCESS_STRING_IS_HERE>
---
# Global Deckhouse settings.
# https://deckhouse.io/products/kubernetes-platform/documentation/v1/reference/api/global.html#parameters
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
modules:
# Template that will be used for system apps domains within the cluster.
# E.g., Grafana for %s.example.com will be available as 'grafana.example.com'.
# The domain MUST NOT match the one specified in the clusterDomain parameter of the ClusterConfiguration resource.
# You can change it to your own or follow the steps in the guide and change it after installation.
publicDomainTemplate: "%s.example.com"
# If necessary, specify in the customTolerationKeys array
# all the taints to which Deckhouse Platform should have tolerations.
# The following is an example for the case if you need Deckhouse Platform and its components to be able
# to run on nodes that have the SystemLoad taint.
# You might consider changing this.
placement:
customTolerationKeys:
- SystemLoad
---
# cert-manager module settings.
# https://deckhouse.io/modules/cert-manager/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: cert-manager
spec:
version: 1
enabled: true
---
# documentation module settings.
# https://deckhouse.io/modules/documentation/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: documentation
spec:
version: 1
enabled: true
Enter license key
Have no key?
The recommended settings for a Deckhouse Platform Standard Edition installation are generated below:
config.yml— a file with the configuration needed to bootstrap the cluster. Contains the installer parameters, and the initial cluster parameters.
Pay attention to:
- highlighted parameters you must define.
- parameters you might want to change.
- Read the If something went wrong section first: it may already describe the case of your provider. Refer to it if you have any problems during the installation process.
Create the config.yml file.
# Deckhouse module settings.
# https://deckhouse.io/modules/deckhouse/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: deckhouse
spec:
version: 1
enabled: true
settings:
bundle: Minimal
releaseChannel: Stable
logLevel: Info
# Settings for accessing the container registry with Deckhouse images.
registry:
mode: Unmanaged
unmanaged:
imagesRepo: registry.deckhouse.io/deckhouse/<REVISION>
license: <YOUR_ACCESS_STRING_IS_HERE>
---
# Global Deckhouse settings.
# https://deckhouse.io/products/kubernetes-platform/documentation/v1/reference/api/global.html#parameters
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
modules:
# Template that will be used for system apps domains within the cluster.
# E.g., Grafana for %s.example.com will be available as 'grafana.example.com'.
# The domain MUST NOT match the one specified in the clusterDomain parameter of the ClusterConfiguration resource.
# You can change it to your own or follow the steps in the guide and change it after installation.
publicDomainTemplate: "%s.example.com"
# If necessary, specify in the customTolerationKeys array
# all the taints to which Deckhouse Platform should have tolerations.
# The following is an example for the case if you need Deckhouse Platform and its components to be able
# to run on nodes that have the SystemLoad taint.
# You might consider changing this.
placement:
customTolerationKeys:
- SystemLoad
---
# cert-manager module settings.
# https://deckhouse.io/modules/cert-manager/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: cert-manager
spec:
version: 1
enabled: true
---
# documentation module settings.
# https://deckhouse.io/modules/documentation/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: documentation
spec:
version: 1
enabled: true
Enter license key
Have no key?
The recommended settings for a Deckhouse Platform Standard Edition+ installation are generated below:
config.yml— a file with the configuration needed to bootstrap the cluster. Contains the installer parameters, and the initial cluster parameters.
Pay attention to:
- highlighted parameters you must define.
- parameters you might want to change.
- Read the If something went wrong section first: it may already describe the case of your provider. Refer to it if you have any problems during the installation process.
Create the config.yml file.
# Deckhouse module settings.
# https://deckhouse.io/modules/deckhouse/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: deckhouse
spec:
version: 1
enabled: true
settings:
bundle: Minimal
releaseChannel: Stable
logLevel: Info
# Settings for accessing the container registry with Deckhouse images.
registry:
mode: Unmanaged
unmanaged:
imagesRepo: registry.deckhouse.io/deckhouse/<REVISION>
license: <YOUR_ACCESS_STRING_IS_HERE>
---
# Global Deckhouse settings.
# https://deckhouse.io/products/kubernetes-platform/documentation/v1/reference/api/global.html#parameters
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
modules:
# Template that will be used for system apps domains within the cluster.
# E.g., Grafana for %s.example.com will be available as 'grafana.example.com'.
# The domain MUST NOT match the one specified in the clusterDomain parameter of the ClusterConfiguration resource.
# You can change it to your own or follow the steps in the guide and change it after installation.
publicDomainTemplate: "%s.example.com"
# If necessary, specify in the customTolerationKeys array
# all the taints to which Deckhouse Platform should have tolerations.
# The following is an example for the case if you need Deckhouse Platform and its components to be able
# to run on nodes that have the SystemLoad taint.
# You might consider changing this.
placement:
customTolerationKeys:
- SystemLoad
---
# cert-manager module settings.
# https://deckhouse.io/modules/cert-manager/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: cert-manager
spec:
version: 1
enabled: true
---
# documentation module settings.
# https://deckhouse.io/modules/documentation/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: documentation
spec:
version: 1
enabled: true
Enter license key
Have no key?
The recommended settings for a Deckhouse Platform Enterprise Edition installation are generated below:
config.yml— a file with the configuration needed to bootstrap the cluster. Contains the installer parameters, and the initial cluster parameters.
Pay attention to:
- highlighted parameters you must define.
- parameters you might want to change.
- Read the If something went wrong section first: it may already describe the case of your provider. Refer to it if you have any problems during the installation process.
Create the config.yml file.
# Deckhouse module settings.
# https://deckhouse.io/modules/deckhouse/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: deckhouse
spec:
version: 1
enabled: true
settings:
bundle: Minimal
releaseChannel: Stable
logLevel: Info
# Settings for accessing the container registry with Deckhouse images.
registry:
mode: Unmanaged
unmanaged:
imagesRepo: registry.deckhouse.io/deckhouse/<REVISION>
license: <YOUR_ACCESS_STRING_IS_HERE>
---
# Global Deckhouse settings.
# https://deckhouse.io/products/kubernetes-platform/documentation/v1/reference/api/global.html#parameters
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
modules:
# Template that will be used for system apps domains within the cluster.
# E.g., Grafana for %s.example.com will be available as 'grafana.example.com'.
# The domain MUST NOT match the one specified in the clusterDomain parameter of the ClusterConfiguration resource.
# You can change it to your own or follow the steps in the guide and change it after installation.
publicDomainTemplate: "%s.example.com"
# If necessary, specify in the customTolerationKeys array
# all the taints to which Deckhouse Platform should have tolerations.
# The following is an example for the case if you need Deckhouse Platform and its components to be able
# to run on nodes that have the SystemLoad taint.
# You might consider changing this.
placement:
customTolerationKeys:
- SystemLoad
---
# cert-manager module settings.
# https://deckhouse.io/modules/cert-manager/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: cert-manager
spec:
version: 1
enabled: true
---
# documentation module settings.
# https://deckhouse.io/modules/documentation/configuration.html
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: documentation
spec:
version: 1
enabled: true
Use a container image to install the Deckhouse Platform. It is necessary to transfer configuration file to the container.
Run the installer on the personal computer.
- Linux / macOS
- Windows
If, with VPN enabled, the container with the installer cannot access the network, follow the instructions in the FAQ.
docker run --pull=always -it -v "$PWD/config.yml:/config.yml" \
-v "$HOME/.kube/config:/kubeconfig" registry.deckhouse.io/deckhouse/ce/install:early-access bash
docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.kube\config:/kubeconfig" registry.deckhouse.io/deckhouse/ce/install:early-access bash -c "chmod 400 /tmp/.ssh/<SSH_PRIVATE_KEY_FILE>; bash"
Notes:
- The kubectl configuration file with access to the Kubernetes API must be mounted as the
/kubeconfigfile in the container. The guide assumes that it is the.kube/configfile in the user’s home directory.
Now, to initiate the process of installation, you need to execute inside the container:
dhctl bootstrap-phase install-deckhouse --kubeconfig=/kubeconfig --config=/config.yml
The installation process may take from 5 to 30 minutes, depending on the connection.
After the installation is complete, the installer will output the IP of the master node (you will need it further). Example output:
...
┌ 🎈 ~ Common: Kubernetes Master Node addresses for SSH
│ cloud-demo-master-0 | ssh ubuntu@1.2.3.4
└ 🎈 ~ Common: Kubernetes Master Node addresses for SSH (0.00 seconds)
Almost everything is ready for a fully-fledged Deckhouse Platform to work.
If something went wrong
Some providers’ clusters may require extra steps before or after installing Deckhouse Platform.
Here are some common problems and ways to solve them. If you run into other difficulties installing Deckhouse Platform in an existing cluster, describe them in an issue on GitHub.
Use a container image to install the Deckhouse Platform. It is necessary to transfer configuration file to the container.
Run the installer on the personal computer.
- Linux / macOS
- Windows
Log in on the personal computer to the container image registry:
echo <LICENSE_TOKEN> | docker login -u license-token --password-stdin registry.deckhouse.io
Run a container with the installer:
If, with VPN enabled, the container with the installer cannot access the network, follow the instructions in the FAQ.
docker run --pull=always -it -v "$PWD/config.yml:/config.yml" \
-v "$HOME/.kube/config:/kubeconfig" registry.deckhouse.io/deckhouse/be/install:stable bash
Log in on the personal computer to the container image registry by providing the license key as a password:
docker login -u license-token registry.deckhouse.io
Run a container with the installer:
docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.kube\config:/kubeconfig" registry.deckhouse.io/deckhouse/be/install:stable bash -c "chmod 400 /tmp/.ssh/<SSH_PRIVATE_KEY_FILE>; bash"
Notes:
- The kubectl configuration file with access to the Kubernetes API must be mounted as the
/kubeconfigfile in the container. The guide assumes that it is the.kube/configfile in the user’s home directory.
Now, to initiate the process of installation, you need to execute inside the container:
dhctl bootstrap-phase install-deckhouse --kubeconfig=/kubeconfig --config=/config.yml
The installation process may take from 5 to 30 minutes, depending on the connection.
After the installation is complete, the installer will output the IP of the master node (you will need it further). Example output:
...
┌ 🎈 ~ Common: Kubernetes Master Node addresses for SSH
│ cloud-demo-master-0 | ssh ubuntu@1.2.3.4
└ 🎈 ~ Common: Kubernetes Master Node addresses for SSH (0.00 seconds)
Almost everything is ready for a fully-fledged Deckhouse Platform to work.
If something went wrong
Some providers’ clusters may require extra steps before or after installing Deckhouse Platform.
Here are some common problems and ways to solve them. If you run into other difficulties installing Deckhouse Platform in an existing cluster, describe them in an issue on GitHub.
Use a container image to install the Deckhouse Platform. It is necessary to transfer configuration file to the container.
Run the installer on the personal computer.
- Linux / macOS
- Windows
Log in on the personal computer to the container image registry:
echo <LICENSE_TOKEN> | docker login -u license-token --password-stdin registry.deckhouse.io
Run a container with the installer:
If, with VPN enabled, the container with the installer cannot access the network, follow the instructions in the FAQ.
docker run --pull=always -it -v "$PWD/config.yml:/config.yml" \
-v "$HOME/.kube/config:/kubeconfig" registry.deckhouse.io/deckhouse/se/install:stable bash
Log in on the personal computer to the container image registry by providing the license key as a password:
docker login -u license-token registry.deckhouse.io
Run a container with the installer:
docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.kube\config:/kubeconfig" registry.deckhouse.io/deckhouse/se/install:stable bash -c "chmod 400 /tmp/.ssh/<SSH_PRIVATE_KEY_FILE>; bash"
Notes:
- The kubectl configuration file with access to the Kubernetes API must be mounted as the
/kubeconfigfile in the container. The guide assumes that it is the.kube/configfile in the user’s home directory.
Now, to initiate the process of installation, you need to execute inside the container:
dhctl bootstrap-phase install-deckhouse --kubeconfig=/kubeconfig --config=/config.yml
The installation process may take from 5 to 30 minutes, depending on the connection.
After the installation is complete, the installer will output the IP of the master node (you will need it further). Example output:
...
┌ 🎈 ~ Common: Kubernetes Master Node addresses for SSH
│ cloud-demo-master-0 | ssh ubuntu@1.2.3.4
└ 🎈 ~ Common: Kubernetes Master Node addresses for SSH (0.00 seconds)
Almost everything is ready for a fully-fledged Deckhouse Platform to work.
If something went wrong
Some providers’ clusters may require extra steps before or after installing Deckhouse Platform.
Here are some common problems and ways to solve them. If you run into other difficulties installing Deckhouse Platform in an existing cluster, describe them in an issue on GitHub.
Use a container image to install the Deckhouse Platform. It is necessary to transfer configuration file to the container.
Run the installer on the personal computer.
- Linux / macOS
- Windows
Log in on the personal computer to the container image registry:
echo <LICENSE_TOKEN> | docker login -u license-token --password-stdin registry.deckhouse.io
Run a container with the installer:
If, with VPN enabled, the container with the installer cannot access the network, follow the instructions in the FAQ.
docker run --pull=always -it -v "$PWD/config.yml:/config.yml" \
-v "$HOME/.kube/config:/kubeconfig" registry.deckhouse.io/deckhouse/se-plus/install:stable bash
Log in on the personal computer to the container image registry by providing the license key as a password:
docker login -u license-token registry.deckhouse.io
Run a container with the installer:
docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.kube\config:/kubeconfig" registry.deckhouse.io/deckhouse/se-plus/install:stable bash -c "chmod 400 /tmp/.ssh/<SSH_PRIVATE_KEY_FILE>; bash"
Notes:
- The kubectl configuration file with access to the Kubernetes API must be mounted as the
/kubeconfigfile in the container. The guide assumes that it is the.kube/configfile in the user’s home directory.
Now, to initiate the process of installation, you need to execute inside the container:
dhctl bootstrap-phase install-deckhouse --kubeconfig=/kubeconfig --config=/config.yml
The installation process may take from 5 to 30 minutes, depending on the connection.
After the installation is complete, the installer will output the IP of the master node (you will need it further). Example output:
...
┌ 🎈 ~ Common: Kubernetes Master Node addresses for SSH
│ cloud-demo-master-0 | ssh ubuntu@1.2.3.4
└ 🎈 ~ Common: Kubernetes Master Node addresses for SSH (0.00 seconds)
Almost everything is ready for a fully-fledged Deckhouse Platform to work.
If something went wrong
Some providers’ clusters may require extra steps before or after installing Deckhouse Platform.
Here are some common problems and ways to solve them. If you run into other difficulties installing Deckhouse Platform in an existing cluster, describe them in an issue on GitHub.
Use a container image to install the Deckhouse Platform. It is necessary to transfer configuration file to the container.
Run the installer on the personal computer.
- Linux / macOS
- Windows
Log in on the personal computer to the container image registry:
echo <LICENSE_TOKEN> | docker login -u license-token --password-stdin registry.deckhouse.io
Run a container with the installer:
If, with VPN enabled, the container with the installer cannot access the network, follow the instructions in the FAQ.
docker run --pull=always -it -v "$PWD/config.yml:/config.yml" \
-v "$HOME/.kube/config:/kubeconfig" registry.deckhouse.io/deckhouse/ee/install:stable bash
Log in on the personal computer to the container image registry by providing the license key as a password:
docker login -u license-token registry.deckhouse.io
Run a container with the installer:
docker run --pull=always -it -v "%cd%\config.yml:/config.yml" -v "%userprofile%\.kube\config:/kubeconfig" registry.deckhouse.io/deckhouse/ee/install:stable bash -c "chmod 400 /tmp/.ssh/<SSH_PRIVATE_KEY_FILE>; bash"
Notes:
- The kubectl configuration file with access to the Kubernetes API must be mounted as the
/kubeconfigfile in the container. The guide assumes that it is the.kube/configfile in the user’s home directory.
Now, to initiate the process of installation, you need to execute inside the container:
dhctl bootstrap-phase install-deckhouse --kubeconfig=/kubeconfig --config=/config.yml
The installation process may take from 5 to 30 minutes, depending on the connection.
After the installation is complete, the installer will output the IP of the master node (you will need it further). Example output:
...
┌ 🎈 ~ Common: Kubernetes Master Node addresses for SSH
│ cloud-demo-master-0 | ssh ubuntu@1.2.3.4
└ 🎈 ~ Common: Kubernetes Master Node addresses for SSH (0.00 seconds)
Almost everything is ready for a fully-fledged Deckhouse Platform to work.
If something went wrong
Some providers’ clusters may require extra steps before or after installing Deckhouse Platform.
Here are some common problems and ways to solve them. If you run into other difficulties installing Deckhouse Platform in an existing cluster, describe them in an issue on GitHub.