You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/en/docs/concepts/extend-kubernetes/operator.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -124,6 +124,6 @@ that can act as a [client for the Kubernetes API](/docs/reference/using-api/clie
124
124
you implement yourself
125
125
* using the [Operator Framework](https://operatorframework.io)
126
126
*[Publish](https://operatorhub.io/) your operator for other people to use
127
-
* Read [CoreOS' original article](https://coreos.com/blog/introducing-operators.html) that introduced the Operator pattern
127
+
* Read [CoreOS' original article](https://web.archive.org/web/20170129131616/https://coreos.com/blog/introducing-operators.html) that introduced the Operator pattern (this is an archived version of the original article).
128
128
* Read an [article](https://cloud.google.com/blog/products/containers-kubernetes/best-practices-for-building-kubernetes-operators-and-stateful-apps) from Google Cloud about best practices for building Operators
Copy file name to clipboardexpand all lines: content/en/docs/concepts/overview/working-with-objects/labels.md
+4-1
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,10 @@ If the prefix is omitted, the label Key is presumed to be private to the user. A
52
52
53
53
The `kubernetes.io/` and `k8s.io/` prefixes are reserved for Kubernetes core components.
54
54
55
-
Valid label values must be 63 characters or less and must be empty or begin and end with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
55
+
Valid label value:
56
+
* must be 63 characters or less (cannot be empty),
57
+
* must begin and end with an alphanumeric character (`[a-z0-9A-Z]`),
58
+
* could contain dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
56
59
57
60
For example, here's the configuration file for a Pod that has two labels `environment: production` and `app: nginx` :
Copy file name to clipboardexpand all lines: content/en/docs/contribute/localization.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -267,7 +267,7 @@ Teams must merge localized content into the same release branch from which the c
267
267
268
268
An approver must maintain a development branch by keeping it current with its source branch and resolving merge conflicts. The longer a development branch stays open, the more maintenance it typically requires. Consider periodically merging development branches and opening new ones, rather than maintaining one extremely long-running development branch.
269
269
270
-
At the beginning of every team milestone, it's helpful to open an issue [comparing upstream changes](https://github.com/kubernetes/website/blob/master/scripts/upstream_changes.py) between the previous development branch and the current development branch.
270
+
At the beginning of every team milestone, it's helpful to open an issue comparing upstream changes between the previous development branch and the current development branch. There are two scripts for comparing upstream changes. [`upstream_changes.py`](https://github.com/kubernetes/website/tree/master/scripts#upstream_changespy) is useful for checking the changes made to a specific file. And [`diff_l10n_branches.py`](https://github.com/kubernetes/website/tree/master/scripts#diff_l10n_branchespy) is useful for creating a list of outdated files for a specific localization branch.
271
271
272
272
While only approvers can open a new development branch and merge pull requests, anyone can open a pull request for a new development branch. No special permissions are required.
Copy file name to clipboardexpand all lines: content/en/docs/contribute/style/style-guide.md
+48-41
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,6 @@ Changes to the style guide are made by SIG Docs as a group. To propose a change
17
17
or addition, [add it to the agenda](https://docs.google.com/document/d/1ddHwLK3kUMX1wVFIwlksjTk0MsqitBnWPe1LRa1Rx5A/edit) for an upcoming SIG Docs meeting, and attend the meeting to participate in the
18
18
discussion.
19
19
20
-
21
-
22
20
<!-- body -->
23
21
24
22
{{< note >}}
@@ -48,12 +46,11 @@ When you refer specifically to interacting with an API object, use [UpperCamelCa
48
46
49
47
When you are generally discussing an API object, use [sentence-style capitalization](https://docs.microsoft.com/en-us/style-guide/text-formatting/using-type/use-sentence-style-capitalization).
50
48
51
-
You may use the word "resource", "API", or "object" to clarify a Kubernetes resource type in a sentence.
49
+
You may use the word "resource", "API", or "object" to clarify a Kubernetes resource type in a sentence.
52
50
53
-
Don't split the API object name into separate words. For example, use
54
-
PodTemplateList, not Pod Template List.
51
+
Don't split an API object name into separate words. For example, use PodTemplateList, not Pod Template List.
55
52
56
-
The following examples focus on capitalization. Review the related guidance on [Code Style](#code-style-inline-code) for more information on formatting API objects.
53
+
The following examples focus on capitalization. For more information about formatting API object names, review the related guidance on [Code Style](#code-style-inline-code).
57
54
58
55
{{< table caption = "Do and Don't - Use Pascal case for API objects" >}}
59
56
Do | Don't
@@ -65,17 +62,18 @@ Every ConfigMap object is part of a namespace. | Every configMap object is part
65
62
For managing confidential data, consider using the Secret API. | For managing confidential data, consider using the secret API.
66
63
{{< /table >}}
67
64
68
-
69
65
### Use angle brackets for placeholders
70
66
71
67
Use angle brackets for placeholders. Tell the reader what a placeholder
72
-
represents.
68
+
represents, for example:
73
69
74
-
1.Display information about a pod:
70
+
Display information about a pod:
75
71
76
-
kubectl describe pod <pod-name> -n <namespace>
72
+
```shell
73
+
kubectl describe pod <pod-name> -n <namespace>
74
+
```
77
75
78
-
If the namespace of the pod is `default`, you can omit the '-n' parameter.
76
+
If the namespace of the pod is `default`, you can omit the '-n' parameter.
79
77
80
78
### Use bold for user interface elements
81
79
@@ -189,7 +187,6 @@ Set the value of `image` to nginx:1.16. | Set the value of `image` to `nginx:1.1
189
187
Set the value of the `replicas` field to 2. | Set the value of the `replicas` field to `2`.
190
188
{{< /table >}}
191
189
192
-
193
190
## Code snippet formatting
194
191
195
192
### Don't include the command prompt
@@ -200,17 +197,20 @@ Do | Don't
200
197
kubectl get pods | $ kubectl get pods
201
198
{{< /table >}}
202
199
203
-
204
200
### Separate commands from output
205
201
206
202
Verify that the pod is running on your chosen node:
207
203
208
-
kubectl get pods --output=wide
204
+
```shell
205
+
kubectl get pods --output=wide
206
+
```
209
207
210
208
The output is similar to this:
211
209
212
-
NAME READY STATUS RESTARTS AGE IP NODE
213
-
nginx 1/1 Running 0 13s 10.200.0.4 worker0
210
+
```console
211
+
NAME READY STATUS RESTARTS AGE IP NODE
212
+
nginx 1/1 Running 0 13s 10.200.0.4 worker0
213
+
```
214
214
215
215
### Versioning Kubernetes examples
216
216
@@ -263,17 +263,17 @@ Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create d
263
263
264
264
2. Use the following syntax to apply a style:
265
265
266
-
```
267
-
{{</* note */>}}
268
-
No need to include a prefix; the shortcode automatically provides one. (Note:, Caution:, etc.)
269
-
{{</* /note */>}}
270
-
```
266
+
```none
267
+
{{</* note */>}}
268
+
No need to include a prefix; the shortcode automatically provides one. (Note:, Caution:, etc.)
269
+
{{</* /note */>}}
270
+
```
271
271
272
-
The output is:
272
+
The output is:
273
273
274
-
{{< note >}}
275
-
The prefix you choose is the same text for the tag.
276
-
{{< /note >}}
274
+
{{< note >}}
275
+
The prefix you choose is the same text for the tag.
276
+
{{< /note >}}
277
277
278
278
### Note
279
279
@@ -403,7 +403,7 @@ The output is:
403
403
404
404
1. Prepare the batter, and pour into springform pan.
405
405
406
-
{{< note >}}Grease the pan for best results.{{< /note >}}
406
+
{{< note >}}Grease the pan for best results.{{< /note >}}
407
407
408
408
1. Bake for 20-25 minutes or until set.
409
409
@@ -417,13 +417,14 @@ Shortcodes inside include statements will break the build. You must insert them
417
417
{{</* /note */>}}
418
418
```
419
419
420
-
421
420
## Markdown elements
422
421
423
422
### Line breaks
423
+
424
424
Use a single newline to separate block-level content like headings, lists, images, code blocks, and others. The exception is second-level headings, where it should be two newlines. Second-level headings follow the first-level (or the title) without any preceding paragraphs or texts. A two line spacing helps visualize the overall structure of content in a code editor better.
425
425
426
426
### Headings
427
+
427
428
People accessing this documentation may use a screen reader or other assistive technology (AT). [Screen readers](https://en.wikipedia.org/wiki/Screen_reader) are linear output devices, they output items on a page one at a time. If there is a lot of content on a page, you can use headings to give the page an internal structure. A good page structure helps all readers to easily navigate the page or filter topics of interest.
428
429
429
430
{{< table caption = "Do and Don't - Headings" >}}
@@ -453,24 +454,24 @@ Write hyperlinks that give you context for the content they link to. For example
453
454
Write Markdown-style links: `[link text](URL)`. For example: `[Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/#table-captions)` and the output is [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/#table-captions). | Write HTML-style links: `<a href="/media/examples/link-element-example.css" target="_blank">Visit our tutorial!</a>`, or create links that open in new tabs or windows. For example: `[example website](https://example.com){target="_blank"}`
454
455
{{< /table >}}
455
456
456
-
457
457
### Lists
458
+
458
459
Group items in a list that are related to each other and need to appear in a specific order or to indicate a correlation between multiple items. When a screen reader comes across a list—whether it is an ordered or unordered list—it will be announced to the user that there is a group of list items. The user can then use the arrow keys to move up and down between the various items in the list.
459
460
Website navigation links can also be marked up as list items; after all they are nothing but a group of related links.
460
461
461
-
- End each item in a list with a period if one or more items in the list are complete sentences. For the sake of consistency, normally either all items or none should be complete sentences.
462
+
- End each item in a list with a period if one or more items in the list are complete sentences. For the sake of consistency, normally either all items or none should be complete sentences.
462
463
463
-
{{< note >}} Ordered lists that are part of an incomplete introductory sentence can be in lowercase and punctuated as if each item was a part of the introductory sentence.{{< /note >}}
464
+
{{< note >}} Ordered lists that are part of an incomplete introductory sentence can be in lowercase and punctuated as if each item was a part of the introductory sentence.{{< /note >}}
464
465
465
-
- Use the number one (`1.`) for ordered lists.
466
+
- Use the number one (`1.`) for ordered lists.
466
467
467
-
- Use (`+`), (`*`), or (`-`) for unordered lists.
468
+
- Use (`+`), (`*`), or (`-`) for unordered lists.
468
469
469
-
- Leave a blank line after each list.
470
+
- Leave a blank line after each list.
470
471
471
-
- Indent nested lists with four spaces (for example, ⋅⋅⋅⋅).
472
+
- Indent nested lists with four spaces (for example, ⋅⋅⋅⋅).
472
473
473
-
- List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be indented by either four spaces or one tab.
474
+
- List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be indented by either four spaces or one tab.
474
475
475
476
### Tables
476
477
@@ -490,7 +491,6 @@ Do | Don't
490
491
This command starts a proxy. | This command will start a proxy.
491
492
{{< /table >}}
492
493
493
-
494
494
Exception: Use future or past tense if it is required to convey the correct
495
495
meaning.
496
496
@@ -503,7 +503,6 @@ You can explore the API using a browser. | The API can be explored using a brows
503
503
The YAML file specifies the replica count. | The replica count is specified in the YAML file.
504
504
{{< /table >}}
505
505
506
-
507
506
Exception: Use passive voice if active voice leads to an awkward construction.
508
507
509
508
### Use simple and direct language
@@ -527,7 +526,6 @@ You can create a Deployment by ... | We'll create a Deployment by ...
527
526
In the preceding output, you can see... | In the preceding output, we can see ...
528
527
{{< /table >}}
529
528
530
-
531
529
### Avoid Latin phrases
532
530
533
531
Prefer English terms over Latin abbreviations.
@@ -539,7 +537,6 @@ For example, ... | e.g., ...
539
537
That is, ...| i.e., ...
540
538
{{< /table >}}
541
539
542
-
543
540
Exception: Use "etc." for et cetera.
544
541
545
542
## Patterns to avoid
@@ -557,7 +554,6 @@ Kubernetes provides a new feature for ... | We provide a new feature ...
557
554
This page teaches you how to use pods. | In this page, we are going to learn about pods.
558
555
{{< /table >}}
559
556
560
-
561
557
### Avoid jargon and idioms
562
558
563
559
Some readers speak English as a second language. Avoid jargon and idioms to help them understand better.
@@ -569,7 +565,6 @@ Internally, ... | Under the hood, ...
569
565
Create a new cluster. | Turn up a new cluster.
570
566
{{< /table >}}
571
567
572
-
573
568
### Avoid statements about the future
574
569
575
570
Avoid making promises or giving hints about the future. If you need to talk about
@@ -592,6 +587,18 @@ In version 1.4, ... | In the current version, ...
592
587
The Federation feature provides ... | The new Federation feature provides ...
593
588
{{< /table >}}
594
589
590
+
### Avoid words that assume a specific level of understanding
591
+
592
+
Avoid words such as "just", "simply", "easy", "easily", or "simple". These words do not add value.
Copy file name to clipboardexpand all lines: content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md
+1
Original file line number
Diff line number
Diff line change
@@ -308,6 +308,7 @@ The following networking functionality is not supported on Windows nodes
308
308
* Host networking mode is not available for Windows pods
309
309
* Local NodePort access from the node itself fails (works for other nodes or external clients)
310
310
* Accessing service VIPs from nodes will be available with a future release of Windows Server
311
+
* A single service can only support up to 64 backend pods / unique destination IPs
311
312
* Overlay networking support in kube-proxy is an alpha release. In addition, it requires [KB4482887](https://support.microsoft.com/en-us/help/4482887/windows-10-update-kb4482887) to be installed on Windows Server 2019
312
313
* Local Traffic Policy and DSR mode
313
314
* Windows containers connected to l2bridge, l2tunnel, or overlay networks do not support communicating over the IPv6 stack. There is outstanding Windows platform work required to enable these network drivers to consume IPv6 addresses and subsequent Kubernetes work in kubelet, kube-proxy, and CNI plugins.
0 commit comments