Vitess Operator

https://vitess-operator.planetscale.dev/api
Admin
Vitess Operator is a Kubernetes operator that manages VitessClusters, providing automated deployment...
Tokens:18,028
Snippets:14
Trust Score:5.2
Update:11 months ago
Show doc for...
Tokens:
Raw
### LockserverSpec Configuration

Source: https://vitess-operator.planetscale.dev/api/index

Specification for deploying or connecting to a lockserver, either global or local.

```APIDOC
## LockserverSpec

### Description
Specification for either deploying a new lockserver or connecting to an existing one.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Request Body
- **external** (VitessLockserverParams) - Optional - Connect to an existing lockserver; ignores all other fields if set.
- **etcd** (EtcdLockserverTemplate) - Optional - Deploy own etcd cluster as a lockserver.

### Request Example
{
  "external": {
    "address": "etcd-client.default.svc.cluster.local:2379"
  }
}

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### MysqldSpec Configuration

Source: https://vitess-operator.planetscale.dev/api/index

Configuration for the local MySQL server within a tablet, including resource allocation and overrides.

```APIDOC
## MysqldSpec

### Description
Configuration for the local MySQL server within a tablet, including compute resources and my.cnf overrides.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Request Body
- **resources** (Kubernetes core/v1.ResourceRequirements) - Required - Compute resources allocated for the MySQL process.
- **configOverrides** (string) - Optional - my.cnf snippet overriding default values for this MySQL instance.

### Request Example
{
  "resources": {
    "requests": {
      "memory": "2Gi",
      "cpu": "1"
    }
  },
  "configOverrides": "[mysqld]\ninnodb_buffer_pool_size=1G"
}

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### VitessKeyspacePartitioning - Equal Partitioning

Source: https://vitess-operator.planetscale.dev/api/index

Describes splitting a keyspace into equal parts.

```APIDOC
## VitessKeyspaceEqualPartitioning

### Description
VitessKeyspaceEqualPartitioning splits the keyspace into some number of equal parts.

### Method
GET

### Endpoint
/api/v1/vitesskeyspaces/{name}/partitioning/equal

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the VitessKeyspace.

#### Query Parameters
- **parts** (int32) - Required - The number of equal parts to split the keyspace into.

#### Request Body
- **None**

### Request Example
{
  "example": "N/A"
}

### Response
#### Success Response (200)
- **parts** (int32) - Number of equal parts.
- **shardTemplate** (VitessShardTemplate) - Configuration for each shard.

#### Response Example
{
  "parts": 4,
  "shardTemplate": {
    "//implementation": "VitessShardTemplate"
  }
}
```

--------------------------------

### ExternalDatastore Configuration

Source: https://vitess-operator.planetscale.dev/api/index

Configuration parameters for connecting vttablet to an externally managed MySQL instance.

```APIDOC
## ExternalDatastore

### Description
Defines connection information for vttablet to connect to an externally managed MySQL.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Request Body
- **user** (string) - Required - Database user from externally managed MySQL; password must be in CredentialsSecret.
- **host** (string) - Required - Endpoint string to externally managed MySQL without port.
- **port** (int32) - Required - Port for the externally managed MySQL endpoint.
- **database** (string) - Required - Name of the database.
- **credentialsSecret** (SecretSource) - Required - Reference to JSON credentials file for connecting to MySQL.
- **serverCACertSecret** (SecretSource) - Optional - Certificate authority file if required by MySQL endpoint.

### Request Example
{
  "user": "vitess_user",
  "host": "mysql.example.com",
  "port": 3306,
  "database": "vitess_db",
  "credentialsSecret": {
    "name": "mysql-credentials"
  },
  "serverCACertSecret": {
    "name": "ca-cert-secret"
  }
}

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### VitessKeyspace Resource

Source: https://vitess-operator.planetscale.dev/api/index

Describes the VitessKeyspace resource used for deploying logical databases in Vitess. It outlines the metadata, specification, and status components.

```APIDOC
## VitessKeyspace

### Description
A VitessKeyspace represents the deployment of a logical database in Vitess. Each keyspace consists of a number of shards, which then consist of tablets. The tablets belonging to one VitessKeyspace can ultimately be deployed across various VitessCells.

### Method
GET

### Endpoint
/api/v1/vitesskeyspaces

### Parameters
#### Path Parameters
- **None**

#### Query Parameters
- **None**

#### Request Body
- **None**

### Request Example
{
  "example": "N/A"
}

### Response
#### Success Response (200)
- **metadata** (ObjectMeta) - Kubernetes meta information.
- **spec** (VitessKeyspaceSpec) - Specification for the VitessKeyspace.

#### Response Example
{
  "metadata": {
    "name": "example-keyspace"
  },
  "spec": {
    "globalLockserver": {
      "//implementation": "VitessLockserverParams"
    },
    "images": {
      "//implementation": "VitessKeyspaceImages"
    },
    "imagePullPolicies": {
      "//implementation": "VitessImagePullPolicies"
    },
    "imagePullSecrets": [],
    "zoneMap": {
      "cell1": "zone1"
    },
    "backupLocations": [],
    "backupEngine": "builtin",
    "extraVitessFlags": {},
    "topologyReconciliation": {
      "//implementation": "TopoReconcileConfig"
    },
    "updateStrategy": {
      "//implementation": "VitessClusterUpdateStrategy"
    }
  }
}
```

--------------------------------

### VitessKeyspaceTemplate Object

Source: https://vitess-operator.planetscale.dev/api/index

The VitessKeyspaceTemplate defines the user-configurable aspects of a Vitess Keyspace. It includes fields for the keyspace name, database name, orchestrator settings, partitioning strategy, turndown policy, and annotations.

```APIDOC
## VitessKeyspaceTemplate

### Description
VitessKeyspaceTemplate contains only the user-specified parts of a VitessKeyspace object. It allows for the configuration of keyspace-specific settings.

### Fields

#### `name` (string)
- **Description**: The name of the keyspace as provided to Vitess. This differs from the object's `metadata.name` generated by the operator. **WARNING**: Renaming a deployed keyspace is not supported and will result in deletion and recreation.
- **Required**: Yes

#### `databaseName` (string)
- **Description**: The name for the underlying MySQL database. This is usually hidden from Vitess clients but can be useful for direct MySQL access. Defaults to `vt_` prefixed keyspace name if unset or empty. Recommended to set it the same as the keyspace name for clarity.
- **Required**: No
- **Default**: Prefixes the keyspace name with `vt_`

#### `vitessOrchestrator` (VitessOrchestratorSpec)
- **Description**: Configures Vitess Orchestrator (vtorc) servers for the Keyspace. If enabled, it's recommended to set `disable_active_reparents=true` and `enable_semi_sync=false` for vtablets. **NOTE**: This API is experimental and not for production use.
- **Required**: No

#### `partitionings` ([]VitessKeyspacePartitioning)
- **Description**: Defines how the keyspace is divided into shards based on keyspace ID ranges. This is an operational concern for scaling, distinct from the VSchema's data modeling. All possible keyspace IDs must be covered without gaps. During resharding, both source and destination shards might be present. If configurations differ, the latter partitioning in the list takes precedence. It's advised to add new partitionings at the end and remove from the beginning. This field is required.
- **Required**: Yes

#### `turndownPolicy` (VitessKeyspaceTurndownPolicy)
- **Description**: Specifies the behavior when a keyspace is removed from the VitessCluster spec. The default (`RequireIdle`) prevents deletion unless the keyspace has zero total desired tablets, requiring manual cleanup to avoid orphaned resources. Setting to `Immediate` bypasses these safety checks, suitable for trusted automation.
- **Required**: No
- **Default**: `RequireIdle`

#### `annotations` (map[string]string)
- **Description**: Optional custom annotations to attach to the VitessKeyspace object.
- **Required**: No

### VitessKeyspaceTurndownPolicy (`string` alias)

#### Description
Defines the policy for turning down a Vitess Keyspace when it's removed from the cluster specification.

#### Values
- `RequireIdle`: The keyspace will only be turned down if it has zero total desired tablets across all shards. Manual intervention may be required to scale down tablets before removal.
- `Immediate`: The keyspace resources will be turned down immediately upon removal from the spec, bypassing safety checks.
```

--------------------------------

### VitessKeyspaceCondition

Source: https://vitess-operator.planetscale.dev/api/index

Describes the conditions of a VitessKeyspace.

```APIDOC
## VitessKeyspaceCondition

### Description
VitessKeyspaceCondition contains details for the current condition of this VitessKeyspace.

### Method
GET

### Endpoint
/api/v1/vitesskeyspaces/{name}/status/conditions

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the VitessKeyspace.

#### Query Parameters
- **None**

#### Request Body
- **None**

### Request Example
{
  "example": "N/A"
}

### Response
#### Success Response (200)
- **type** (VitessKeyspaceConditionType) - Type of the condition.
- **status** (ConditionStatus) - Status of the condition.
- **lastTransitionTime** (Time) - Last time the condition transitioned.
- **reason** (string) - Reason for the transition.
- **message** (string) - Message indicating details about the transition.

#### Response Example
{
  "type": "Ready",
  "status": "True",
  "lastTransitionTime": "2023-10-27T10:00:00Z",
  "reason": "Healthy",
  "message": "All shards are healthy."
}
```

--------------------------------

### VitessLockserverParams

Source: https://vitess-operator.planetscale.dev/api/index

VitessLockserverParams defines the parameters that Vitess requires to connect to a lockserver. It includes the implementation type, connection address, and root path for cluster data isolation. This structure is utilized across various Vitess specifications in the operator.

```APIDOC
## VitessLockserverParams

### Description
VitessLockserverParams contains only the values that Vitess needs to connect to a given lockserver.

### Appears On
LockserverSpec, VitessCellSpec, VitessKeyspaceSpec, VitessShardSpec

### Parameters
#### Fields
- **implementation** (string) - Implementation specifies which Vitess “topo” plugin to use.
- **address** (string) - Address is the host:port of the lockserver client endpoint.
- **rootPath** (string) - RootPath is a path prefix for all lockserver data belonging to a given Vitess cluster. Multiple Vitess clusters can share a lockserver as long as they have unique root paths.
```

--------------------------------

### GCSBackupLocation Configuration

Source: https://vitess-operator.planetscale.dev/api/index

Specifies configuration for storing Vitess backups in Google Cloud Storage.

```APIDOC
## GCSBackupLocation

### Description
Configuration for specifying a Google Cloud Storage location for Vitess backups.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Request Body
- **bucket** (string) - Required - Name of the GCS bucket to use.
- **keyPrefix** (string) - Optional - Prefix added to all object keys created by Vitess.
- **authSecret** (SecretSource) - Optional - Reference to the Secret containing GCS authentication credentials.

### Request Example
{
  "bucket": "vitess-backups",
  "keyPrefix": "cluster1/",
  "authSecret": {
    "name": "gcs-auth-secret"
  }
}

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### VitessOrchestratorSpec

Source: https://vitess-operator.planetscale.dev/api/index

VitessOrchestratorSpec provides deployment parameters for vtorc, the Vitess orchestrator. It allows customization of configuration secrets, resources, flags, environment variables, volumes, and more for orchestrator pods. Note that this API is experimental and not intended for production use.

```APIDOC
## VitessOrchestratorSpec

### Description
VitessOrchestratorSpec specifies deployment parameters for vtorc. THIS API IS EXPERIMENTAL: NOT TO BE USED IN PRODUCTION.

### Appears On
VitessKeyspaceTemplate, VitessShardSpec

### Parameters
#### Fields
- **configSecret** (SecretSource) - ConfigSecret contains the config file (with passwords) for vtorc.
- **resources** (Kubernetes core/v1.ResourceRequirements) - Resources determines the compute resources reserved for each vtorc replica.
- **extraFlags** (map[string]string) - ExtraFlags can optionally be used to override default flags set by the operator, or pass additional flags to vtorc. All entries must be key-value string pairs of the form “flag”: “value”. The flag name should not have any prefix (just “flag”, not “-flag”). To set a boolean flag, set the string value to either “true” or “false”.
- **extraEnv** ([]Kubernetes core/v1.EnvVar) - ExtraEnv can optionally be used to override default environment variables set by the operator, or pass additional environment variables.
- **extraVolumes** ([]Kubernetes core/v1.Volume) - ExtraVolumes can optionally be used to override default Pod volumes defined by the operator, or provide additional volumes to the Pod. Note that when adding a new volume, you should usually also add a volumeMount to specify where in each container’s filesystem the volume should be mounted.
- **extraVolumeMounts** ([]Kubernetes core/v1.VolumeMount) - ExtraVolumeMounts can optionally be used to override default Pod volumeMounts defined by the operator, or specify additional mounts. Typically, these are used to mount volumes defined through extraVolumes.
- **initContainers** ([]Kubernetes core/v1.Container) - InitContainers can optionally be used to supply extra init containers that will be run to completion one after another before any app containers are started.
- **sidecarContainers** ([]Kubernetes core/v1.Container) - SidecarContainers can optionally be used to supply extra containers that run alongside the main containers.
- **affinity** (Kubernetes core/v1.Affinity) - Affinity allows you to set rules that constrain the scheduling of your vtorc pods. WARNING: These affinity rules will override all default affinities that we set; in turn, we can’t guarantee optimal scheduling of your pods if you choose to set this field.
- **annotations** (map[string]string) - Annotations can optionally be used to attach custom annotations to Pods created for this component. These will be attached to the underlying Pods that the vtorc Deployment creates.
- **extraLabels** (map[string]string) - ExtraLabels can optionally be used to attach custom labels to Pods created for this component. These will be attached to the underlying Pods that the vtorc Deployment creates.
- **service** (ServiceOverrides) - Service can optionally be used to customize the vtorc Service.
- **tolerations** ([]Kubernetes core/v1.Toleration) - Tolerations allow you to schedule pods onto nodes with matching taints.
```
Tokens:
Raw