OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

Kubernetes operator for OceanBase

V2.1.2Community Edition
  • Overview
  • Quick start
  • Deploy
  • Upgrade
  • Configure
  • User guide
    • Cluster management
      • Manage clusters
      • Create a cluster
      • Zone management
        • Add zones to a cluster
        • Delete zones from a cluster
      • Server management
        • Add OBServer nodes to zones
        • Delete OBServer nodes from zones
      • Upgrade a cluster
      • Manage parameters
      • Delete a cluster
    • Tenant management
      • Manage tenants
      • Create a tenant
      • Modify tenant
        • Manage resources
        • Manage replicas
        • Modify other parameters
      • Delete a tenant
      • Perform tenant O&M operations
    • High availability
      • High availability
      • Restore service from node failure
      • Back up a tenant
      • Restore data from a backup
      • Physical standby tenant
  • Appendix
    • Deploy OceanBase Database and applications in a Kubernetes cluster
    • FAQ
  • Changelog

Download PDF

Document Feedback
  1. Documentation Center
  2. Kubernetes operator for OceanBase
  3. V2.1.2

Perform tenant O&M operations

Last Updated:2026-09-04 08:21:43

Examples
Create a standby tenant
View the tenant status
Perform O&M operations on the tenant
Query the information about the tenant O&M operations

A tenant contains various resources. To prevent a tenant from becoming bloated and improve tenant O&M flexibility, ob-operator provides the tenant O&M resource OBTenantOperation for you to perform intra-tenant and inter-tenant O&M operations. ob-operator V2.1.0 supports three O&M operations: changing the password of the root user, activating a standby tenant, and executing a primary/standby tenant switchover. Standby tenant activation and primary/standby tenant switchover are related to the physical standby database feature. Here are sample configurations of the three O&M operations:

# Change the password.
apiVersion: oceanbase.oceanbase.com/v1alpha1
kind: OBTenantOperation
metadata:
  name: op-chg-pwd
  namespace: oceanbase
spec:
  type: "CHANGE_PASSWORD"
  changePwd:
    tenant: "t1"
    secretRef: "t1-credential-new"
# Upgrade a standby tenant to the primary tenant.
apiVersion: oceanbase.oceanbase.com/v1alpha1
kind: OBTenantOperation
metadata:
  name: op-failover
  namespace: oceanbase
spec:
  type: "FAILOVER"
  failover:
    standbyTenant: "t1s"
# Perform a primary/standby tenant switchover.
apiVersion: oceanbase.oceanbase.com/v1alpha1
kind: OBTenantOperation
metadata:
  name: op-switchover
  namespace: oceanbase
spec:
  type: "SWITCHOVER"
  switchover:
    primaryTenant: "t1"
    standbyTenant: "t1s"

Examples

Create a standby tenant

kubectl apply -f tenant_restore.yaml

View the tenant status

kubectl get obtenants.oceanbase.oceanbase.com -n oceanbase

The command output is as follows:

NAME   STATUS    TENANTNAME   TENANTROLE   CLUSTERNAME   AGE
t1     running   t1           PRIMARY      obcluster     3d4h
t1s    running   t1s          STANDBY      obcluster     3h30m

Perform O&M operations on the tenant

kubectl apply -f tenant_op_change_pwd.yaml
kubectl apply -f tenant_op_failover.yaml

Query the information about the tenant O&M operations

kubectl get obtenantoperations.oceanbase.oceanbase.com -n oceanbase

The command output is as follows:

NAME          TYPE       STATUS       AGE   CLUSTER     PRIMARYTENANT
op-failover   FAILOVER   SUCCESSFUL   8s    obcluster   t1s

Note that the value of the PRIMARYTENANT field in the output indicates the new primary tenant after the switchover. The value of the SECONDARYTENANT field in the output indicates the new standby tenant after the switchover. To save space, the SECONDARYTENANT field is not exported by default. You can run the kubectl get obtenantoperations.oceanbase.oceanbase.com -o wide command to view it.

Previous topic

Delete a tenant
Last

Next topic

High availability
Next
on this page
Examples
Create a standby tenant
View the tenant status
Perform O&M operations on the tenant
Query the information about the tenant O&M operations