Skip to content

Commit bcf2c89

Browse files
rleungxrleungx
authored
fix typo (#6024)
Signed-off-by: Ryan Leung <[email protected]>
1 parent 24fa283 commit bcf2c89

File tree

14 files changed

+63
-63
lines changed

14 files changed

+63
-63
lines changed

‎docs/api-references/docs.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10972,7 +10972,7 @@ message.</p>
1097210972
<a href="#tidbclusterspec">TidbClusterSpec</a>)
1097310973
</p>
1097410974
<p>
10975-
<p>PDMSSpec contains details of PD Micro Service</p>
10975+
<p>PDMSSpec contains details of PD microservice</p>
1097610976
</p>
1097710977
<table>
1097810978
<thead>
@@ -11020,7 +11020,7 @@ string
1102011020
</em>
1102111021
</td>
1102211022
<td>
11023-
<p>Name of the PD Micro Service</p>
11023+
<p>Name of the PD microservice</p>
1102411024
</td>
1102511025
</tr>
1102611026
<tr>
@@ -11068,7 +11068,7 @@ ServiceSpec
1106811068
</td>
1106911069
<td>
1107011070
<em>(Optional)</em>
11071-
<p>Service defines a Kubernetes service of PD Micro Service cluster.
11071+
<p>Service defines a Kubernetes service of PD microservice cluster.
1107211072
Optional: Defaults to <code>.spec.services</code> in favor of backward compatibility</p>
1107311073
</td>
1107411074
</tr>
@@ -11096,7 +11096,7 @@ PDConfigWraper
1109611096
</td>
1109711097
<td>
1109811098
<em>(Optional)</em>
11099-
<p>Config is the Configuration of pd Micro Service servers</p>
11099+
<p>Config is the configuration of PD microservice servers</p>
1110011100
</td>
1110111101
</tr>
1110211102
<tr>
@@ -11145,7 +11145,7 @@ string
1114511145
</td>
1114611146
<td>
1114711147
<em>(Optional)</em>
11148-
<p>The storageClassName of the persistent volume for PD Micro Service log storage.
11148+
<p>The storageClassName of the persistent volume for PD microservice log storage.
1114911149
Defaults to Kubernetes default storage class.</p>
1115011150
</td>
1115111151
</tr>
@@ -11160,7 +11160,7 @@ Defaults to Kubernetes default storage class.</p>
1116011160
</td>
1116111161
<td>
1116211162
<em>(Optional)</em>
11163-
<p>StorageVolumes configure additional storage for PD Micro Service pods.</p>
11163+
<p>StorageVolumes configure additional storage for PD microservice pods.</p>
1116411164
</td>
1116511165
</tr>
1116611166
<tr>
@@ -11182,7 +11182,7 @@ int
1118211182
<a href="#tidbclusterstatus">TidbClusterStatus</a>)
1118311183
</p>
1118411184
<p>
11185-
<p>PDMSStatus is PD Micro Service Status</p>
11185+
<p>PDMSStatus is PD microservice status</p>
1118611186
</p>
1118711187
<table>
1118811188
<thead>

‎pkg/apis/pingcap/v1alpha1/openapi_generated.go‎

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkg/apis/pingcap/v1alpha1/tidbcluster.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func (tc *TidbCluster) PDVersion() string {
9898
return getImageVersion(tc.PDImage())
9999
}
100100

101-
// PDMSImage return the image used by specified PD MicroService.
101+
// PDMSImage return the image used by specified PD microservice.
102102
//
103103
// If PDMS isn't specified, return empty string.
104104
func (tc *TidbCluster) PDMSImage(spec *PDMSSpec) string {
@@ -127,7 +127,7 @@ func (tc *TidbCluster) PDMSImage(spec *PDMSSpec) string {
127127
return image
128128
}
129129

130-
// PDMSVersion return the image version used by specified PD MicroService.
130+
// PDMSVersion return the image version used by specified PD microservice.
131131
//
132132
// If PDMS isn't specified, return empty string.
133133
func (tc *TidbCluster) PDMSVersion(name string) string {

‎pkg/apis/pingcap/v1alpha1/types.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -600,12 +600,12 @@ type PDSpec struct {
600600
}
601601

602602
// +k8s:openapi-gen=true
603-
// PDMSSpec contains details of PD Micro Service
603+
// PDMSSpec contains details of PD microservice
604604
type PDMSSpec struct {
605605
ComponentSpec `json:",inline"`
606606
corev1.ResourceRequirements `json:",inline"`
607607

608-
// Name of the PD Micro Service
608+
// Name of the PD microservice
609609
// +kubebuilder:validation:Enum:="tso";"scheduling"
610610
Name string `json:"name"`
611611

@@ -621,7 +621,7 @@ type PDMSSpec struct {
621621
// +optional
622622
BaseImage *string `json:"baseImage"`
623623

624-
// Service defines a Kubernetes service of PD Micro Service cluster.
624+
// Service defines a Kubernetes service of PD microservice cluster.
625625
// Optional: Defaults to `.spec.services` in favor of backward compatibility
626626
// +optional
627627
Service *ServiceSpec `json:"service,omitempty"`
@@ -632,7 +632,7 @@ type PDMSSpec struct {
632632
// +optional
633633
MaxFailoverCount *int32 `json:"maxFailoverCount,omitempty"`
634634

635-
// Config is the Configuration of pd Micro Service servers
635+
// Config is the configuration of PD microservice servers
636636
// +optional
637637
// +kubebuilder:validation:Schemaless
638638
// +kubebuilder:validation:XPreserveUnknownFields
@@ -652,12 +652,12 @@ type PDMSSpec struct {
652652
// +kubebuilder:validation:Enum:="";"v1"
653653
StartUpScriptVersion string `json:"startUpScriptVersion,omitempty"`
654654

655-
// The storageClassName of the persistent volume for PD Micro Service log storage.
655+
// The storageClassName of the persistent volume for PD microservice log storage.
656656
// Defaults to Kubernetes default storage class.
657657
// +optional
658658
StorageClassName *string `json:"storageClassName,omitempty"`
659659

660-
// StorageVolumes configure additional storage for PD Micro Service pods.
660+
// StorageVolumes configure additional storage for PD microservice pods.
661661
// +optional
662662
StorageVolumes []StorageVolume `json:"storageVolumes,omitempty"`
663663

@@ -1522,7 +1522,7 @@ type PDStatus struct {
15221522
VolReplaceInProgress bool `json:"volReplaceInProgress,omitempty"`
15231523
}
15241524

1525-
// PDMSStatus is PD Micro Service Status
1525+
// PDMSStatus is PD microservice status
15261526
type PDMSStatus struct {
15271527
Name string `json:"name,omitempty"`
15281528
// +optional

‎pkg/manager/member/pd_member_manager.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func (m *pdMemberManager) Sync(tc *v1alpha1.TidbCluster) error {
8383

8484
if (tc.Spec.PD.Mode == "ms" && tc.Spec.PDMS == nil) ||
8585
(tc.Spec.PDMS != nil && tc.Spec.PD.Mode != "ms") {
86-
klog.Infof("tidbcluster: [%s/%s]'s enable micro service failed, please check `PD.Mode` and `PDMS`", tc.GetNamespace(), tc.GetName())
86+
klog.Infof("tidbcluster: [%s/%s]'s enable microservice failed, please check `PD.Mode` and `PDMS`", tc.GetNamespace(), tc.GetName())
8787
}
8888

8989
// skip sync if pd is suspended

‎pkg/manager/member/pd_ms_member_manager.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ func NewPDMSMemberManager(dependencies *controller.Dependencies, pdMSScaler Scal
5656
}
5757
}
5858

59-
// Sync for all PD Micro Service components.
59+
// Sync for all PD microservice components.
6060
func (m *pdMSMemberManager) Sync(tc *v1alpha1.TidbCluster) error {
6161
// Need to start PD API
6262
if tc.Spec.PDMS != nil && tc.Spec.PD == nil {
63-
klog.Infof("PD Micro Service is enabled, but PD is not enabled, skip syncing PD Micro Service")
63+
klog.Infof("PD microservice is enabled, but PD is not enabled, skip syncing PD microservice")
6464
return nil
6565
}
66-
// remove all micro service components if PDMS is not enabled
66+
// remove all microservice components if PDMS is not enabled
6767
// PDMS need to be enabled when PD.Mode is ms && PDMS is not nil
6868
if tc.Spec.PDMS == nil || (tc.Spec.PD != nil && tc.Spec.PD.Mode != "ms") {
6969
for _, comp := range tc.Status.PDMS {
@@ -95,7 +95,7 @@ func (m *pdMSMemberManager) Sync(tc *v1alpha1.TidbCluster) error {
9595
return nil
9696
}
9797

98-
// init PD Micro Service status
98+
// init PD microservice status
9999
if tc.Status.PDMS == nil {
100100
tc.Status.PDMS = make(map[string]*v1alpha1.PDMSStatus)
101101
}
@@ -115,10 +115,10 @@ func (m *pdMSMemberManager) Sync(tc *v1alpha1.TidbCluster) error {
115115
return nil
116116
}
117117

118-
// syncSingleService for single PD Micro Service components.
118+
// syncSingleService for single PD microservice components.
119119
func (m *pdMSMemberManager) syncSingleService(tc *v1alpha1.TidbCluster, curSpec *v1alpha1.PDMSSpec) error {
120120
curService := curSpec.Name
121-
// Skip sync if PD Micro Service is suspended
121+
// Skip sync if PD microservice is suspended
122122
componentMemberType := v1alpha1.PDMSMemberType(curService)
123123
needSuspend, err := m.suspender.SuspendComponent(tc, componentMemberType)
124124
if err != nil {
@@ -129,17 +129,17 @@ func (m *pdMSMemberManager) syncSingleService(tc *v1alpha1.TidbCluster, curSpec
129129
return nil
130130
}
131131

132-
// Sync PD Micro Service
132+
// Sync PD microservice
133133
if err := m.syncPDMSService(tc, curSpec); err != nil {
134134
return err
135135
}
136136

137-
// Sync PD Micro Service Headless Service
137+
// Sync PD microservice headless service
138138
if err := m.syncPDMSHeadlessService(tc, curSpec); err != nil {
139139
return err
140140
}
141141

142-
// Sync PD Micro Service StatefulSet
142+
// Sync PD microservice statefulSet
143143
return m.syncPDMSStatefulSet(tc, curSpec)
144144
}
145145

‎pkg/manager/member/pd_ms_scaler.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ type pdMSScaler struct {
2828
generalScaler
2929
}
3030

31-
// NewPDMSScaler returns a PD Micro Service Scaler.
31+
// NewPDMSScaler returns a PD microservice scaler.
3232
func NewPDMSScaler(deps *controller.Dependencies) *pdMSScaler {
3333
return &pdMSScaler{generalScaler: generalScaler{deps: deps}}
3434
}

‎pkg/manager/member/pd_ms_upgrader.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ type pdMSUpgrader struct {
3131
deps *controller.Dependencies
3232
}
3333

34-
// NewPDMSUpgrader returns a PD Micro Service Upgrader
34+
// NewPDMSUpgrader returns a PD microservice upgrader
3535
func NewPDMSUpgrader(deps *controller.Dependencies) Upgrader {
3636
return &pdMSUpgrader{
3737
deps: deps,
@@ -129,7 +129,7 @@ func (u *pdMSUpgrader) gracefulUpgrade(tc *v1alpha1.TidbCluster, oldSet *apps.St
129129

130130
func (u *pdMSUpgrader) upgradePDMSPod(tc *v1alpha1.TidbCluster, ordinal int32, newSet *apps.StatefulSet, curService string) error {
131131
// Only support after `8.3.0` to keep compatibility.
132-
if check, err := pdMSSupportMicroServicesWithName.Check(tc.PDMSVersion(curService)); check && err == nil {
132+
if check, err := pdMSSupportMicroservicesWithName.Check(tc.PDMSVersion(curService)); check && err == nil {
133133
ns := tc.GetNamespace()
134134
tcName := tc.GetName()
135135
upgradePDMSName := PDMSName(tcName, ordinal, tc.Namespace, tc.Spec.ClusterDomain, tc.Spec.AcrossK8s, curService)
@@ -206,9 +206,9 @@ func choosePDMSToTransferFromMembers(tc *v1alpha1.TidbCluster, newSet *apps.Stat
206206
return targetName
207207
}
208208

209-
// PDMSSupportMicroServicesWithName returns true if the given version of PDMS supports microservices with name.
209+
// PDMSSupportMicroservicesWithName returns true if the given version of PDMS supports microservices with name.
210210
// related https://github.com/tikv/pd/pull/8157.
211-
var pdMSSupportMicroServicesWithName, _ = cmpver.NewConstraint(cmpver.GreaterOrEqual, "v8.3.0")
211+
var pdMSSupportMicroservicesWithName, _ = cmpver.NewConstraint(cmpver.GreaterOrEqual, "v8.3.0")
212212

213213
type fakePDMSUpgrader struct{}
214214

‎pkg/manager/member/pvc_resizer.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ func (p *pvcResizer) buildContextForTC(tc *v1alpha1.TidbCluster, status v1alpha1
203203
ctx.desiredVolumeQuantity[v1alpha1.GetStorageVolumeName("", v1alpha1.PDMemberType)] = quantity
204204
}
205205
storageVolumes = tc.Spec.PD.StorageVolumes
206-
// PD Micro Service
206+
// PD microservice
207207
case v1alpha1.PDMSTSOMemberType, v1alpha1.PDMSSchedulingMemberType:
208208
pdmsRequirement := util.MustNewRequirement(label.ComponentLabelKey, selection.Equals, []string{label.PDMSLabel(comp.String())})
209209
ctx.selector = selector.Add(*pdmsRequirement)

‎pkg/manager/member/startscript/v2/common.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ fi
4242
`
4343
dnsAwaitPart = "<<dns-await-part>>"
4444

45-
pdEnableMicroService = "<<pd-enable-micro-service>>"
45+
pdEnableMicroservice = "<<pd-enable-micro-service>>"
4646

4747
componentCommonWaitForDnsIpMatchScript = `
4848
elapseTime=0

0 commit comments

Comments
 (0)