Overview

Kubernetes and Operator 101

Supported addons

About this manual

Try out KubeBlocks with Playground

Try out KubeBlocks on cloud

Try out KubeBlocks on laptop

Installation

Prerequisite for Local Env

Prerequisite for Local Env

Install KubeBlocks

Uninstall KubeBlocks and kbcli

Upgrade KubeBlocks

Upgrade to v0.8

Upgrade to v0.9.0

Upgrade to v0.9.3

Connect Database

Testing environment

Production environment

Maintenance

Scale

Horizontal Scale

Backup and Restore

Backup

Configure BackupRepo

Configure BackupPolicy

Scheduled backup

On-demand backup

Restore

Restore from backup set

In Place Update

Overview on in-place update

Enable in-place update

Resource Scheduling

Configure pod affinity for database clusters

Cross K8s Deployment

Deploy a Cluster across Multiple Kubernetes Clusters by KubeBlocks

Instance Template

Introduction of instance template

Apply instance template

Observability

Monitor database

Configure alert

User Management

Manage user accounts

Handle an Exception

Handle an exception

Developer

Developer guides

Add an add-on to KubeBlocks

Add-ons of KubeBlocks

Backup and restore

Parameter template

Parameter configuration

Multi-component configuration

Environment variables and placeholders

External Component

Reference external component

API Reference

Environment variables and placeholders

Environment variables

Pod container environment variables

The following variables are injected by KubeBlocks into each pod.

Name	Description
`KB_POD_NAME`	K8s Pod Name
`KB_NAMESPACE`	K8s Pod Namespace
`KB_SA_NAME`	KubeBlocks Service Account Name
`KB_NODENAME`	K8s Node Name
`KB_HOSTIP`	K8s Host IP address
`KB_PODIP`	K8s Pod IP address
`KB_PODIPS`	K8s Pod IP addresses
`KB_POD_UID`	POD UID (`pod.metadata.uid`)
`KB_CLUSTER_NAME`	KubeBlocks Cluster API object name
`KB_COMP_NAME`	Running pod's KubeBlocks Cluster API object's `.spec.components.name`
`KB_CLUSTER_COMP_NAME`	Running pod's KubeBlocks Cluster API object's `<.metadata.name>-<.spec.components.name>`
`KB_REPLICA_COUNT`	Running pod's component's replica
`KB_CLUSTER_UID`	Running pods' KubeBlocks Cluster API object's `metadata.uid`
`KB_CLUSTER_UID_POSTFIX_8`	Last eight digits of KB_CLUSTER_UID
`KB_{ordinal}_HOSTNAME`	Running pod's hostname, where `{ordinal}` is the ordinal of pod. N/A if workloadType=Stateless.
`KB_POD_FQDN`	Running pod's fully qualified domain name (FQDN). N/A if workloadType=Stateless.

Built-in Place-holders

ComponentValueFrom API

Name	Description
`POD_ORDINAL`	Pod ordinal
`POD_FQDN`	Pod FQDN (fully qualified domain name)
`POD_NAME`	Pod Name

ConnectionCredential API

Name	Description
`UUID`	Generate a random UUID v4 string.
`UUID_B64`	Generate a random UUID v4 BASE64 encoded string.
`UUID_STR_B64`	Generate a random UUID v4 string then BASE64 encoded.
`UUID_HEX`	Generate a random UUID v4 HEX representation.
`HEADLESS_SVC_FQDN`	Headless service FQDN placeholder, value pattern - `$(CLUSTER_NAME)-$(1ST_COMP_NAME)-headless.$(NAMESPACE).svc`, where `1ST_COMP_NAME` is the 1st component that provide `ClusterDefinition.spec.componentDefs[].service` attribute.
`SVC_FQDN`	Service FQDN placeholder, value pattern - `$(CLUSTER_NAME)-$(1ST_COMP_NAME).$(NAMESPACE).svc`, where 1ST_COMP_NAME is the 1st component that provide `ClusterDefinition.spec.componentDefs[].service` attribute.
`SVC_PORT_{PORT_NAME}`	A ServicePort's port value with specified port name, i.e, a servicePort JSON struct: `{"name": "mysql", "targetPort": "mysqlContainerPort", "port": 3306}`, and `"$(SVC_PORT_mysql)"` in the connection credential value is 3306.
`RANDOM_PASSWD`	Random 8 characters