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

### Custom Resources

* [ConfigChange](#configchange)

### Sub Resources

* [ConfigChangeComponentMemberStatus](#configchangecomponentmemberstatus)
* [ConfigChangeComponentStatus](#configchangecomponentstatus)
* [ConfigChangeDBStatus](#configchangedbstatus)
* [ConfigChangeList](#configchangelist)
* [ConfigChangeSpec](#configchangespec)
* [ConfigChangeStatus](#configchangestatus)
* [ConfigChangeStep](#configchangestep)

#### ConfigChange

ConfigChange is a Job type CRD. you can create a ConfigChange to change and then apply a new ConfigRevision to the cluster.

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ObjectMeta | false |
| spec |  | [ConfigChangeSpec](#configchangespec) | false |
| status |  | [ConfigChangeStatus](#configchangestatus) | false |

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

#### ConfigChangeComponentMemberStatus



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| name |  | string | true |
| done |  | bool | true |

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

#### ConfigChangeComponentStatus



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| updatedReplicas | UpdatedReplicas is used for RollingRestart strategy | int32 | true |
| done |  | bool | true |
| reason |  | string | true |
| changedCategories | ChangedCategories represents what of this component will be changed | []ConfigChangeCategory | true |

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

#### ConfigChangeDBStatus



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| pd |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |
| tidb |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |
| tikv |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |
| tiflash |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |
| tiflashLearner |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |
| tiproxy |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |
| ticdc |  | *[ConfigChangeComponentStatus](#configchangecomponentstatus) | false |

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

#### ConfigChangeList

ConfigChangeList contains a list of ConfigChange

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

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

#### ConfigChangeSpec

ConfigChangeSpec defines the desired state of ConfigChange

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| clusterName | ClusterName is the name of Cluster you want to change ConfigRevision | string | true |
| configRevisionName | the name of target ConfigRevision | string | true |
| changeStrategy | ChangeStrategy represents how to apply config to cluster | ConfigChangeStrategy | true |
| paused | Paused specifies whether to pause the reconciliation loop for ConfigChange CR | *bool | false |

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

#### ConfigChangeStatus

ConfigChangeStatus defines the observed state of ConfigChange

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| lastConfigRevisionName | LastConfigRevisionName is name of last used ConfigRevision | string | true |
| phase | Phase is lifecycle phase of the ConfigChange | ConfigChangePhase | true |
| reason | Reason explains why the ConfigChange is in current phase to human, reason is not supposed to be parsed by program, Phase should be used instead. | string | false |
| beginTime |  | *metav1.Time | false |
| endTime |  | *metav1.Time | false |
| duration |  | string | false |
| lastEventSendTime | LastEventSendTime records the last time we send events to avoid send too more events to clinic | *metav1.Time | false |
| steps |  | []*[ConfigChangeStep](#configchangestep) | false |
| changedCategories | ChangedCategories represents what will be changed by this ConfigChange | []ConfigChangeCategory | false |
| changedComponents | ChangedComponents represents which components will be affected by this ConfigChange | []ComponentType | false |
| db | DB represents the status of the ConfigChange | [ConfigChangeDBStatus](#configchangedbstatus) | false |

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

#### ConfigChangeStep



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| name |  | ConfigChangeStepName | true |
| status |  | ConfigChangeStepStatus | true |
| reason |  | string | true |

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