This resource is namespace scoped, refer to [Namespace](./namespace.md) for details.

### Custom Resources

* [ClusterConfig](#clusterconfig)

### Sub Resources

* [ClusterConfigList](#clusterconfiglist)
* [ClusterConfigSpec](#clusterconfigspec)
* [ConfigMeta](#configmeta)
* [Configuration](#configuration)

#### ClusterConfig

ClusterConfig is the Schema for the clusterconfigs API

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ObjectMeta | false |
| spec |  | [ClusterConfigSpec](#clusterconfigspec) | false |
| status |  | [ClusterConfigStatus](#clusterconfigstatus) | false |

[Back to Custom Resources](#custom-resources)

#### ClusterConfigList

ClusterConfigList contains a list of ClusterConfig

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ListMeta | false |
| items |  | [][ClusterConfig](#clusterconfig) | true |

[Back to Custom Resources](#custom-resources)

#### ClusterConfigSpec

ClusterConfigSpec defines the desired state of ClusterConfig

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| version | TiDB cluster version | string | true |
| configMeta | ConfigMeta contains metadata information of configurations | *[ConfigMeta](#configmeta) | false |
| tidb | TiDB contains all default and overlay configurations of tidb server | *[Configuration](#configuration) | false |
| pd | PD contains all default and overlay configurations of pd server | *[Configuration](#configuration) | false |
| tikv | TiKV contains all default and overlay configurations of tikv server | *[Configuration](#configuration) | false |
| tiflash | TiFlash contains all default and overlay configurations of tiflash server | *[Configuration](#configuration) | false |
| tiflashLearner | TiFlashLearner contains all default and overlay configurations of tiflash learner | *[Configuration](#configuration) | false |
| backup | Backup contains all configurations about backup job | *[Configuration](#configuration) | false |
| restore | Restore contains all configurations about restore job | *[Configuration](#configuration) | false |
| lightning | Lightning contains all configurations about a lightning job | *[Configuration](#configuration) | false |
| ticdc | TiCDC contains all configurations about a ticdc cluster | *[Configuration](#configuration) | false |
| updatePolicy |  | UpdatePolicy | false |
| priority | Priority used for overlay in server side Higher priority config will overwrite lower priority config | Priority | false |
| selector | Label selector for clusters, it wll match the cluster object's labels. | *metav1.LabelSelector | true |

[Back to Custom Resources](#custom-resources)

#### ConfigMeta



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| gitCommitID | GitCommitID is git commit ID of cluster configuration | string | true |
| configVersion | ConfigVersion is configuration version, version will auto-increment to aviod old version overrides new version configuration | uint64 | true |

[Back to Custom Resources](#custom-resources)

#### Configuration



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| baseImage | BaseImage of the component | *string | false |
| tag | Tag is component image tag, if not specipy, will use global version value. | *string | false |
| config | Config is the default configuration of component | *TomlConfig | true |

[Back to Custom Resources](#custom-resources)