From 0a32933ebe2961874a7f4971b73a63225305497d Mon Sep 17 00:00:00 2001 From: Song Gao <2695690803@qq.com> Date: Mon, 23 Mar 2020 14:56:07 +0800 Subject: [PATCH] revise Note --- docs/api-references/docs.html | 20 +++++++++---------- manifests/crd.yaml | 14 ++++++------- .../pingcap/v1alpha1/openapi_generated.go | 12 +++++------ pkg/apis/pingcap/v1alpha1/pd_config.go | 20 +++++++++---------- 4 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/api-references/docs.html b/docs/api-references/docs.html index ec633fbef6..21287666be 100644 --- a/docs/api-references/docs.html +++ b/docs/api-references/docs.html @@ -4355,8 +4355,8 @@

PDReplicationConfig (Optional)

StrictlyMatchLabel strictly checks if the label of TiKV is matched with LocaltionLabels. -Immutable, change should be made through pd-ctl after cluster creation -imported from v3.1.0

+Immutable, change should be made through pd-ctl after cluster creation. +Imported from v3.1.0

@@ -4499,9 +4499,9 @@

PDScheduleConfig (Optional)

LeaderScheduleLimit is the max coexist leader schedules. -Immutable, change should be made through pd-ctl after cluster creation -Optional: Defaults to 4 -imported from v3.1.0

+Immutable, change should be made through pd-ctl after cluster creation. +Optional: Defaults to 4. +Imported from v3.1.0

@@ -4585,8 +4585,8 @@

PDScheduleConfig (Optional)

TolerantSizeRatio is the ratio of buffer size for balance scheduler. -Immutable, change should be made through pd-ctl after cluster creation -imported from v3.1.0

+Immutable, change should be made through pd-ctl after cluster creation. +Imported from v3.1.0

@@ -4756,7 +4756,7 @@

PDScheduleConfig (Optional)

EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into the next region of it. -imported from v3.1.0

+Imported from v3.1.0

@@ -4770,7 +4770,7 @@

PDScheduleConfig (Optional)

EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. This option only works when key type is “table”. -imported from v3.1.0

+Imported from v3.1.0

@@ -4929,7 +4929,7 @@

PDServerConfig (Optional)

MetricStorage is the cluster metric storage. Currently we use prometheus as metric storage, we may use PD/TiKV as metric storage later. -imported from v3.1.0

+Imported from v3.1.0

diff --git a/manifests/crd.yaml b/manifests/crd.yaml index 702784c663..82319d3035 100644 --- a/manifests/crd.yaml +++ b/manifests/crd.yaml @@ -1446,7 +1446,7 @@ spec: metric-storage: description: MetricStorage is the cluster metric storage. Currently we use prometheus as metric storage, we may - use PD/TiKV as metric storage later. imported from v3.1.0 + use PD/TiKV as metric storage later. Imported from v3.1.0 type: string use-region-storage: description: UseRegionStorage enables the independent region @@ -1474,8 +1474,8 @@ spec: strictly-match-label: description: StrictlyMatchLabel strictly checks if the label of TiKV is matched with LocaltionLabels. Immutable, change - should be made through pd-ctl after cluster creation imported - from v3.1.0 + should be made through pd-ctl after cluster creation. + Imported from v3.1.0 type: string type: object schedule: @@ -1525,12 +1525,12 @@ spec: description: EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. This option only works when - key type is "table". imported from v3.1.0 + key type is "table". Imported from v3.1.0 type: string enable-one-way-merge: description: EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into - the next region of it. imported from v3.1.0 + the next region of it. Imported from v3.1.0 type: string high-space-ratio: description: HighSpaceRatio is the highest usage ratio of @@ -1558,7 +1558,7 @@ spec: leader-schedule-limit: description: 'LeaderScheduleLimit is the max coexist leader schedules. Immutable, change should be made through pd-ctl - after cluster creation Optional: Defaults to 4 imported + after cluster creation. Optional: Defaults to 4. Imported from v3.1.0' format: int64 type: integer @@ -1665,7 +1665,7 @@ spec: tolerant-size-ratio: description: TolerantSizeRatio is the ratio of buffer size for balance scheduler. Immutable, change should be made - through pd-ctl after cluster creation imported from v3.1.0 + through pd-ctl after cluster creation. Imported from v3.1.0 format: double type: number type: object diff --git a/pkg/apis/pingcap/v1alpha1/openapi_generated.go b/pkg/apis/pingcap/v1alpha1/openapi_generated.go index 944ed491bf..43ced8f3e3 100644 --- a/pkg/apis/pingcap/v1alpha1/openapi_generated.go +++ b/pkg/apis/pingcap/v1alpha1/openapi_generated.go @@ -1766,7 +1766,7 @@ func schema_pkg_apis_pingcap_v1alpha1_PDReplicationConfig(ref common.ReferenceCa }, "strictly-match-label": { SchemaProps: spec.SchemaProps{ - Description: "StrictlyMatchLabel strictly checks if the label of TiKV is matched with LocaltionLabels. Immutable, change should be made through pd-ctl after cluster creation imported from v3.1.0", + Description: "StrictlyMatchLabel strictly checks if the label of TiKV is matched with LocaltionLabels. Immutable, change should be made through pd-ctl after cluster creation. Imported from v3.1.0", Type: []string{"string"}, Format: "", }, @@ -1842,7 +1842,7 @@ func schema_pkg_apis_pingcap_v1alpha1_PDScheduleConfig(ref common.ReferenceCallb }, "leader-schedule-limit": { SchemaProps: spec.SchemaProps{ - Description: "LeaderScheduleLimit is the max coexist leader schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 4 imported from v3.1.0", + Description: "LeaderScheduleLimit is the max coexist leader schedules. Immutable, change should be made through pd-ctl after cluster creation. Optional: Defaults to 4. Imported from v3.1.0", Type: []string{"integer"}, Format: "int64", }, @@ -1884,7 +1884,7 @@ func schema_pkg_apis_pingcap_v1alpha1_PDScheduleConfig(ref common.ReferenceCallb }, "tolerant-size-ratio": { SchemaProps: spec.SchemaProps{ - Description: "TolerantSizeRatio is the ratio of buffer size for balance scheduler. Immutable, change should be made through pd-ctl after cluster creation imported from v3.1.0", + Description: "TolerantSizeRatio is the ratio of buffer size for balance scheduler. Immutable, change should be made through pd-ctl after cluster creation. Imported from v3.1.0", Type: []string{"number"}, Format: "double", }, @@ -1982,14 +1982,14 @@ func schema_pkg_apis_pingcap_v1alpha1_PDScheduleConfig(ref common.ReferenceCallb }, "enable-one-way-merge": { SchemaProps: spec.SchemaProps{ - Description: "EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into the next region of it. imported from v3.1.0", + Description: "EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into the next region of it. Imported from v3.1.0", Type: []string{"string"}, Format: "", }, }, "enable-cross-table-merge": { SchemaProps: spec.SchemaProps{ - Description: "EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. This option only works when key type is \"table\". imported from v3.1.0", + Description: "EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. This option only works when key type is \"table\". Imported from v3.1.0", Type: []string{"string"}, Format: "", }, @@ -2093,7 +2093,7 @@ func schema_pkg_apis_pingcap_v1alpha1_PDServerConfig(ref common.ReferenceCallbac }, "metric-storage": { SchemaProps: spec.SchemaProps{ - Description: "MetricStorage is the cluster metric storage. Currently we use prometheus as metric storage, we may use PD/TiKV as metric storage later. imported from v3.1.0", + Description: "MetricStorage is the cluster metric storage. Currently we use prometheus as metric storage, we may use PD/TiKV as metric storage later. Imported from v3.1.0", Type: []string{"string"}, Format: "", }, diff --git a/pkg/apis/pingcap/v1alpha1/pd_config.go b/pkg/apis/pingcap/v1alpha1/pd_config.go index 7556f92898..e308e37548 100644 --- a/pkg/apis/pingcap/v1alpha1/pd_config.go +++ b/pkg/apis/pingcap/v1alpha1/pd_config.go @@ -178,8 +178,8 @@ type PDReplicationConfig struct { // +optional LocationLabels StringSlice `toml:"location-labels,omitempty" json:"location-labels,omitempty"` // StrictlyMatchLabel strictly checks if the label of TiKV is matched with LocaltionLabels. - // Immutable, change should be made through pd-ctl after cluster creation - // imported from v3.1.0 + // Immutable, change should be made through pd-ctl after cluster creation. + // Imported from v3.1.0 // +optional StrictlyMatchLabel *bool `toml:"strictly-match-label,omitempty" json:"strictly-match-label,string,omitempty"` @@ -251,9 +251,9 @@ type PDScheduleConfig struct { // +optional MaxStoreDownTime string `toml:"max-store-down-time,omitempty" json:"max-store-down-time,omitempty"` // LeaderScheduleLimit is the max coexist leader schedules. - // Immutable, change should be made through pd-ctl after cluster creation - // Optional: Defaults to 4 - // imported from v3.1.0 + // Immutable, change should be made through pd-ctl after cluster creation. + // Optional: Defaults to 4. + // Imported from v3.1.0 // +optional LeaderScheduleLimit *uint64 `toml:"leader-schedule-limit,omitempty" json:"leader-schedule-limit,omitempty"` // RegionScheduleLimit is the max coexist region schedules. @@ -283,8 +283,8 @@ type PDScheduleConfig struct { // +optional HotRegionCacheHitsThreshold *uint64 `toml:"hot-region-cache-hits-threshold,omitempty" json:"hot-region-cache-hits-threshold,omitempty"` // TolerantSizeRatio is the ratio of buffer size for balance scheduler. - // Immutable, change should be made through pd-ctl after cluster creation - // imported from v3.1.0 + // Immutable, change should be made through pd-ctl after cluster creation. + // Imported from v3.1.0 // +optional TolerantSizeRatio *float64 `toml:"tolerant-size-ratio,omitempty" json:"tolerant-size-ratio,omitempty"` // @@ -349,12 +349,12 @@ type PDScheduleConfig struct { SchedulersPayload map[string]string `toml:"schedulers-payload" json:"schedulers-payload,omitempty"` // EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into the next region of it. - // imported from v3.1.0 + // Imported from v3.1.0 // +optional EnableOneWayMerge *bool `toml:"enable-one-way-merge" json:"enable-one-way-merge,string,omitempty"` // EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. // This option only works when key type is "table". - // imported from v3.1.0 + // Imported from v3.1.0 // +optional EnableCrossTableMerge *bool `toml:"enable-cross-table-merge" json:"enable-cross-table-merge,string,omitempty"` } @@ -410,7 +410,7 @@ type PDServerConfig struct { UseRegionStorage *bool `toml:"use-region-storage,omitempty" json:"use-region-storage,string,omitempty"` // MetricStorage is the cluster metric storage. // Currently we use prometheus as metric storage, we may use PD/TiKV as metric storage later. - // imported from v3.1.0 + // Imported from v3.1.0 // +optional MetricStorage *string `toml:"metric-storage" json:"metric-storage,omitempty"` }