code review feedback

kubernetes · Dec 25, 2023 · 55cfdc2 · 55cfdc2
1 parent d536e46
commit 55cfdc2
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 38 deletions.
diff --git a/content/en/docs/reference/config-api/apiserver-audit.v1.md b/content/en/docs/reference/config-api/apiserver-audit.v1.md
@@ -253,7 +253,7 @@ be specified per rule in which case the union of both are omitted.</p>
 <td>
    <p>OmitManagedFields indicates whether to omit the managed fields of the request
 and response bodies from being written to the API audit log.
-This is used as a global default - a value of 'true' will omit the managed fields,
+This is used as a global default - a value of 'true' will omit the managed fileds,
 otherwise the managed fields will be included in the API audit log.
 Note that this can also be specified per rule in which case the value specified
 in a rule will override the global default.</p>
@@ -527,7 +527,7 @@ An empty list means no restrictions will apply.</p>
 and response bodies from being written to the API audit log.</p>
 <ul>
 <li>a value of 'true' will drop the managed fields from the API audit log</li>
-<li>a value of 'false' indicates that the managed fields should be included
+<li>a value of 'false' indicates that the managed fileds should be included
 in the API audit log
 Note that the value, if specified, in this rule will override the global default
 If a value is not specified then the global default specified in

diff --git a/content/en/docs/reference/config-api/kubeadm-config.v1beta4.md b/content/en/docs/reference/config-api/kubeadm-config.v1beta4.md
@@ -16,7 +16,7 @@ Use <code>APIServer.ExtraEnvs</code>, <code>ControllerManager.ExtraEnvs</code>,
 <code>Etcd.Local.ExtraEnvs</code>.</li>
 <li>The <code>ResetConfiguration</code> API type is now supported in v1beta4.
 Users are able to reset a node by passing a <code>--config</code> file to <code>kubeadm reset</code>.</li>
-<li><code>dry-run</code> mode is now configurable in InitConfiguration and JoinConfiguration config files.</li>
+<li><code>dry-run</code> mode is now configureable in InitConfiguration and JoinConfiguration config files.</li>
 <li>Replace the existing string/string extra argument maps with structured extra arguments
 that support duplicates. The change applies to <code>ClusterConfiguration</code> - <code>APIServer.ExtraArgs</code>,
 <code>ControllerManager.ExtraArgs</code>, <code>Scheduler.ExtraArgs</code>. Also to <code>NodeRegistrationOptions.KubeletExtraArgs</code>.</li>

diff --git a/content/en/docs/reference/config-api/kubelet-config.v1beta1.md b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md
@@ -545,7 +545,7 @@ Default: 50</p>
 <td>
    <p>eventBurst is the maximum size of a burst of event creations, temporarily
 allows event creations to burst to this number, while still not exceeding
-eventRecordQPS. This field cannot be a negative number and it is only used
+eventRecordQPS. This field canot be a negative number and it is only used
 when eventRecordQPS &gt; 0.
 Default: 100</p>
 </td>

diff --git a/content/en/docs/reference/config-api/kubelet-credentialprovider.v1.md b/content/en/docs/reference/config-api/kubelet-credentialprovider.v1.md
@@ -63,7 +63,7 @@ This response should be set to the same apiVersion as CredentialProviderRequest.
 <a href="#credentialprovider-kubelet-k8s-io-v1-PluginCacheKeyType"><code>PluginCacheKeyType</code></a>
 </td>
 <td>
-   <p>cacheKeyType indicates the type of caching key to use based on the image provided
+   <p>cacheKeyType indiciates the type of caching key to use based on the image provided
 in the request. There are three valid values for the cache key type: Image, Registry, and
 Global. If an invalid value is specified, the response will NOT be used by the kubelet.</p>
 </td>

diff --git a/content/en/docs/reference/instrumentation/metrics.md b/content/en/docs/reference/instrumentation/metrics.md
@@ -1482,14 +1482,14 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
 	</ul>
 	</div><div class="metric" data-stability="alpha">
 	<div class="metric_name">ephemeral_volume_controller_create_failures_total</div>
-	<div class="metric_help">Number of PersistentVolumeClaims creation requests</div>
+	<div class="metric_help">Number of PersistenVolumeClaims creation requests</div>
 	<ul>
 	<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
 	<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
 	</ul>
 	</div><div class="metric" data-stability="alpha">
 	<div class="metric_name">ephemeral_volume_controller_create_total</div>
-	<div class="metric_help">Number of PersistentVolumeClaims creation requests</div>
+	<div class="metric_help">Number of PersistenVolumeClaims creation requests</div>
 	<ul>
 	<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
 	<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>

diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md
@@ -62,7 +62,7 @@ APIServiceSpec contains information for locating and communicating with a server
 
 - **groupPriorityMinimum** (int32), required
 
-  GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object.  (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
+  GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object.  (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
 
 - **versionPriority** (int32), required
 

diff --git a/.../en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md b/.../en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md
@@ -15,7 +15,7 @@ The file is auto-generated from the Go source code of the component using a gene
 [generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
 to generate the reference documentation, please read
 [Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
-To update the reference content, please follow the
+To update the reference content, please follow the 
 [Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
 guide. You can file document formatting bugs against the
 [reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
@@ -59,68 +59,68 @@ CSIDriverSpec is the specification of a CSIDriver.
 - **attachRequired** (boolean)
 
   attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.
-
+  
   This field is immutable.
 
 - **fsGroupPolicy** (string)
 
   fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details.
-
+  
   This field is immutable.
-
+  
   Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.
 
 - **podInfoOnMount** (boolean)
 
   podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false.
-
+  
   The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext.
-
-  The following VolumeContext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
+  
+  The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
                                   defined by a CSIVolumeSource, otherwise "false"
-
+  
   "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver.
-
+  
   This field is immutable.
 
 - **requiresRepublish** (boolean)
 
   requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.
-
+  
   Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.
 
 - **seLinuxMount** (boolean)
 
   seLinuxMount specifies if the CSI driver supports "-o context" mount option.
-
+  
   When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context.
-
+  
   When "false", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem.
-
+  
   Default is "false".
 
 - **storageCapacity** (boolean)
 
   storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true.
-
+  
   The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object.
-
+  
   Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.
-
+  
   This field was immutable in Kubernetes \<= 1.22 and now is mutable.
 
 - **tokenRequests** ([]TokenRequest)
 
   *Atomic: will be replaced during a merge*
-
+  
   tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": {
     "\<audience>": {
       "token": \<token>,
       "expirationTimestamp": \<expiration timestamp in RFC3339>,
     },
     ...
   }
-
+  
   Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.
 
   <a name="TokenRequest"></a>
@@ -137,13 +137,13 @@ CSIDriverSpec is the specification of a CSIDriver.
 - **volumeLifecycleModes** ([]string)
 
   *Set: unique values will be kept during a merge*
-
+  
   volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism.
-
+  
   The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume.
-
+  
   For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future.
-
+  
   This field is beta. This field is immutable.
 
 
@@ -297,7 +297,7 @@ POST /apis/storage.k8s.io/v1/csidrivers
 
 - **body**: <a href="{{< ref "../config-and-storage-resources/csi-driver-v1#CSIDriver" >}}">CSIDriver</a>, required
 
-
+  
 
 
 - **dryRun** (*in query*): string
@@ -349,7 +349,7 @@ PUT /apis/storage.k8s.io/v1/csidrivers/{name}
 
 - **body**: <a href="{{< ref "../config-and-storage-resources/csi-driver-v1#CSIDriver" >}}">CSIDriver</a>, required
 
-
+  
 
 
 - **dryRun** (*in query*): string
@@ -399,7 +399,7 @@ PATCH /apis/storage.k8s.io/v1/csidrivers/{name}
 
 - **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
 
-
+  
 
 
 - **dryRun** (*in query*): string
@@ -454,7 +454,7 @@ DELETE /apis/storage.k8s.io/v1/csidrivers/{name}
 
 - **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
 
-
+  
 
 
 - **dryRun** (*in query*): string
@@ -499,7 +499,7 @@ DELETE /apis/storage.k8s.io/v1/csidrivers
 
 - **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
 
-
+  
 
 
 - **continue** (*in query*): string
@@ -568,4 +568,5 @@ DELETE /apis/storage.k8s.io/v1/csidrivers
 
 200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
 
-401: Unauthorized
+401: Unauthorized
+
diff --git a/...s/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md b/...s/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md
@@ -75,7 +75,7 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request.
   source represents the volume that should be attached.
 
   <a name="VolumeAttachmentSource"></a>
-  *VolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.*
+  *VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.*
 
   - **source.inlineVolumeSpec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-v1#PersistentVolumeSpec" >}}">PersistentVolumeSpec</a>)
 

diff --git a/content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1.md b/content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1.md
@@ -139,7 +139,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
 
   - **ports.name** (string)
 
-    name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
+    name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
 
   - **ports.appProtocol** (string)