KubeBlocks
BlogsKubeBlocks Cloud

Getting Started

Introduction
Supported addons
Installation

Concepts and Features

Concepts

Backup and Restore

Introduction

Backup

Configure BackupRepo
Configure BackupPolicy
Scheduled backup
On-demand backup

Restore

Restore from backup set
Point-in-Time Recovery

In Place Update

Introduction
Enable in-place update

Instance Template

Introduction
Apply instance template

Trouble Shooting

FAQs

References

API Reference

Cluster
Operations
Parameters
Dataprotection
Add-On
Terminology
Install Addons
Install kbcli
Create a test Kubernetes cluster
Kubernetes and Operator 101

Upgrade KubeBlocks

Upgrade to v0.8
Upgrade to v0.9.0
Upgrade to v0.9.x

Release Notes

v1.0.0-cn
v1.0.0
v0.9.3
v0.9.2
v0.9.1
v0.9.0
  1. List of K8s Resources created by KubeBlocks when creating a Cluster
  2. How to get the detail of each backup method
  3. How to Check Compatible versions

FAQs

List of K8s Resources created by KubeBlocks when creating a Cluster

To get the full list of associated resources created by KubeBlocks for given cluster:

kubectl get cmp,its,po -l app.kubernetes.io/instance=<CLUSTER_NAME> -n demo # cluster and worload
kubectl get backuppolicy,backupschedule,backup -l app.kubernetes.io/instance=<CLUSTER_NAME> -n demo # data protection resources
kubectl get componentparameter,parameter -l app.kubernetes.io/instance=<CLUSTER_NAME> -n demo # configuration resources
kubectl get opsrequest -l app.kubernetes.io/instance=<CLUSTER_NAME> -n demo # opsrequest resources
kubectl get svc,secret,cm,pvc -l app.kubernetes.io/instance=<CLUSTER_NAME> -n demo # k8s native resources

For troubleshooting,

  1. describe resource such as Cluster, Component, e.g.
kubectl describe TYPE NAME
  1. check database instance logs
kubectl logs <podName> -c <containerName>
  1. check KubeBlocks logs
kubectl -n kb-system logs deployments/kubeblocks -f

How to get the detail of each backup method

Details of each backup method are defined in ActionSet in KubeBlocks.

For example, To get the ActionSet which defines the behavior of backup method named wal-g-archive in PostgreSQL, for instance:

kubectl -n demo get bp pg-cluster-postgresql-backup-policy -oyaml | yq '.spec.backupMethods[] | select(.name=="wal-g-archive") | .actionSetName'

ActionSet defined:

  • backup type
  • both backup and restore procedures
  • environment variables used in procedures

And you may check details of each ActionsSet to find out how backup and restore will be performed.

How to Check Compatible versions

Versions and it compatibility rules are embedded in ComponentVersion CR in KubeBlocks. To the the list of compatible versions:

kubectl get cmpv postgresql -ojson | jq '.spec.compatibilityRules'
Expected output
[
  {
    "compDefs": [
      "postgresql-12-"
    ],
    "releases": [
      "12.14.0",
      "12.14.1",
      "12.15.0"
    ]
  },
  {
    "compDefs": [
      "postgresql-14-"
    ],
    "releases": [
      "14.7.2",
      "14.8.0"
    ]
  }
]

Releases are grouped by component definitions, and each group has a list of compatible releases. In this example, it shows you can upgrade from version 12.14.0 to 12.14.1 or 12.15.0, and upgrade from 14.7.2 to 14.8.0. But cannot upgrade from 12.14.0 to 14.8.0.

© 2025 ApeCloud PTE. Ltd.