Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: shortcode formatting and typo(s) #48622

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ kubectl expose deployment/my-nginx
service/my-nginx exposed
```

This is equivalent to `kubectl apply -f` the following yaml:
This is equivalent to `kubectl apply -f` in the following yaml:

{{% code_sample file="service/networking/nginx-svc.yaml" %}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ graceful connection draining.

## Termination process for Pods and their endpoints

There are often cases when you need to terminate a Pod - be it for upgrade or scale down.
There are often cases when you need to terminate a Pod - be it to upgrade or scale down.
In order to improve application availability, it may be important to implement
a proper active connections draining.

Expand All @@ -29,12 +29,12 @@ a simple nginx web server to demonstrate the concept.

## Example flow with endpoint termination

The following is the example of the flow described in the
The following is the example flow described in the
[Termination of Pods](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination)
document.

Let's say you have a Deployment containing of a single `nginx` replica
(just for demonstration purposes) and a Service:
Let's say you have a Deployment containing a single `nginx` replica
(say just for the sake of demonstration purposes) and a Service:

{{% code_sample file="service/pod-with-graceful-termination.yaml" %}}

Expand Down Expand Up @@ -158,10 +158,10 @@ The output is similar to this:
```

This allows applications to communicate their state during termination
and clients (such as load balancers) to implement a connections draining functionality.
and clients (such as load balancers) to implement connection draining functionality.
These clients may detect terminating endpoints and implement a special logic for them.

In Kubernetes, endpoints that are terminating always have their `ready` status set as as `false`.
In Kubernetes, endpoints that are terminating always have their `ready` status set as `false`.
This needs to happen for backward
compatibility, so existing load balancers will not use it for regular traffic.
If traffic draining on terminating pod is needed, the actual readiness can be
Expand Down
2 changes: 1 addition & 1 deletion layouts/shortcodes/version-check.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
{{ T "version_check_mustbe" }}{{ $minVersion }}.
{{ else if $minVersion}}
{{ T "version_check_mustbeorlater" }}{{ $minVersion }}.
{{ end }} {{ T "version_check_tocheck" }}<code>kubectl version</code>.
{{ end }} <p>{{ T "version_check_tocheck" }} <code>kubectl version</code>.</p>
sftim marked this conversation as resolved.
Show resolved Hide resolved