The Deckhouse Kubernetes Platform module delivers Deckhouse Code through the code-operator component, which installs and maintains the Deckhouse Code instance. Every setting of the instance is a field of the CodeInstance resource; for an empty field the operator takes the platform’s global setting: the public domain template, the IngressClass or the HTTPS mode. The module’s own ModuleConfig carries only the logLevel setting.
The web interface of the module delivery is available at the code subdomain of the platform’s public domain template, for example https://code.example.com. Setting spec.network.web.hostname in CodeInstance uses that address instead.
Requirements
The module requires:
- Deckhouse Kubernetes Platform 1.68 or later;
- Kubernetes 1.29 or later;
- the
cert-managermodule enabled; - PostgreSQL 17 or later;
- Redis 7.0 or later;
- S3 storage with the
YCloudorGenericprovider; - a StorageClass for the Git repositories, named in the
gitData.storageClassfield; - an IngressClass for the traffic to the web interface.
The cluster resources for the instance size are given in Minimum requirements in the module documentation, and Getting started there describes the setup of PostgreSQL, Redis and the S3 storage.
Installation
Enabling the module installs code-operator; once PostgreSQL, Redis and the S3 storage are ready, applying a CodeInstance resource installs Deckhouse Code with the given parameters. Getting started in the module documentation covers the installation steps, from enabling the module to the first sign-in.
Disabling the module deletes the Code configuration, the Git data and every Secret and ConfigMap owned by the operator, including the encryption keys of the data stored in PostgreSQL. Create a backup before disabling the module.
Configuration
Every setting of the module delivery is a field of the CodeInstance resource. Custom Resources in the module documentation lists every field.
Operations
Backup, scaling and network configuration of the module delivery are CodeInstance fields, described in the module documentation: Maintenance, Scaling and Network. The module is updated by the platform; the backup before an update is described on the Upgrade page. Moving an instance between the Linux package or Omnibus Docker and the module is described in Migration.
Administration
A module administrator uses the product documentation Overview and the rest of the Administration section for instance-level tasks: users and access, authentication, security, monitoring, backup and upgrade.