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

Reference Documentation for Kubernetes Components and Tools for 1.17 #18010

Merged
merged 3 commits into from Dec 10, 2019
Merged

Reference Documentation for Kubernetes Components and Tools for 1.17 #18010

merged 3 commits into from Dec 10, 2019

Conversation

daminisatya
Copy link
Contributor

No description provided.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 9, 2019
@daminisatya daminisatya changed the base branch from master to dev-1.17 December 9, 2019 08:37
@daminisatya daminisatya changed the base branch from dev-1.17 to master December 9, 2019 08:38
@daminisatya daminisatya changed the base branch from master to dev-1.17 December 9, 2019 08:42
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Dec 9, 2019

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 25e8bc8

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5deed5baeac931000a637a8b

@netlify
Copy link

netlify bot commented Dec 9, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 92dbf83

https://deploy-preview-18010--kubernetes-io-master-staging.netlify.com

@daminisatya daminisatya changed the title Reference Documentation for Kubernetes Components and Tools Reference Documentation for Kubernetes Components and Tools for 1.17 Dec 9, 2019
@@ -913,7 +913,7 @@ kube-apiserver [flags]
<td colspan="2">--shutdown-delay-duration duration</td>
</tr>
<tr>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Time to delay the termination. During that time the server keeps serving requests normally and /healthz returns success, but /ready immediately returns failure. Graceful termination starts after this delay has elapsed. This can be used to allow load balancer to stop sending traffic to this server.</td>
<td></td><td style="line-height: 130%; word-wrap: break-word;">Time to delay the termination. During that time the server keeps serving requests normally and /healthz returns success, but /readzy immediately returns failure. Graceful termination starts after this delay has elapsed. This can be used to allow load balancer to stop sending traffic to this server.</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

readzy looks like a typo; does that need fixing upstream?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out that, actually, @sftim already did.
@daminisatya did you have revision kubernetes/kubernetes@70132b0 checked out when you generated the reference documentation?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I clone kubernetes/kubernetes and check out release-1.17 then run:

git annotate ./staging/src/k8s.io/apiserver/pkg/server/options/server_run_options.go | grep "returns success, but /r.*"

I see the fixed wording with /readyz.

Puzzled.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And ... it was fixed by you, @sftim :)

kubernetes/kubernetes@bbccdcd


<tr>
<td colspan="2">--cache-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "~/.kube/http-cache"</td>
<td colspan="2">--cache-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/Users/dsatya/.kube/http-cache"</td>
Copy link
Member

@neolit123 neolit123 Dec 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better to have something like /home/username/.kube... :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any idea how this username was inserted into the output? Perhaps check the proposed output against the current (v1.16) page.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neolit123 Can I apply this manually?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@neolit123
Copy link
Member

neolit123 commented Dec 9, 2019

i think for kubeadm we had more changes to the reference documentation, but i can't remember what else.. hm

EDIT: shouldn't there be a diff for the kubeadm /generated folder? or perhaps this is a separate PR.

@daminisatya daminisatya added this to the 1.17 milestone Dec 9, 2019
@daminisatya
Copy link
Contributor Author

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

I'll see about the upstream typo fix

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 9, 2019
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 9, 2019
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
One manual fixup suggestion


<tr>
<td colspan="2">--cache-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "~/.kube/http-cache"</td>
<td colspan="2">--cache-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/Users/username/.kube/http-cache"</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<td colspan="2">--cache-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "/Users/username/.kube/http-cache"</td>
<td colspan="2">--cache-dir string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: "~/.kube/http-cache"</td>

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 10, 2019
@zacharysarah zacharysarah changed the base branch from dev-1.17 to master December 10, 2019 00:26
@zacharysarah
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 10, 2019
@k8s-ci-robot k8s-ci-robot merged commit 75de70a into kubernetes:master Dec 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants