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

[WIP] New reference docs for kubectl #9081

Closed
wants to merge 44 commits into from

Conversation

tengqm
Copy link
Contributor

@tengqm tengqm commented Jun 15, 2018

This is collection of kubectl reference docs generated in the same way
as we do for kube-apiserver, kubelet, kubeadm etc. This is different
from the way we do today for kubectl (see #9080). Sending this to get
comments from reviewers.

resouer and others added 30 commits June 4, 2018 10:20
* Doc about PID pressure condition.

Signed-off-by: Da K. Ma <[email protected]>

* "so" -> "too"
* Feature gate: StorageObjectInUseProtection is GA

Update feature gate reference for 1.11

* Trivial commit to re-trigger Netlify
* Seperate priority and preemption (kubernetes#8144)

* CRIContainerLogRotation is Beta in 1.11

xref: kubernetes/kubernetes#64046
* StorageObjectInUseProtection is GA (kubernetes#8291)

* Feature gate: StorageObjectInUseProtection is GA

Update feature gate reference for 1.11

* Trivial commit to re-trigger Netlify

* Bring StorageObjectInUseProtection feature to GA

StorageObjectInUseProtection is Beta in K8s 1.10.

It's brought to GA in K8s 1.11.

* Fixed typo and added feature state tags.
The support to the KUBER_API_VERSIONS environment variable is completely
dropped (no deprecation). This PR removes the related doc in
release-1.11.

xref: kubernetes/kubernetes#63165
* Remove docs related to in-tree support to GPU

The in-tree support to GPU is completely removed in release 1.11.
This PR removes the related docs in release-1.11 branch.

xref: kubernetes/kubernetes#61498

* Update content updated by PR to Hugo syntax

Signed-off-by: Misty Stanley-Jones <[email protected]>
CoreDNS is installed by default in 1.11.
Add notes on how to install kube-dns instead.

Update notes about CoreDNS->CoreDNS upgrades as in 1.11
the Corefile is retained.

Add example on upgrading from kube-dns to CoreDNS.
Update note about CoreDNS feature gate.

This change also updates a tab as a kubeadm sub-command
will change.

It looks for a new generated file:
generated/kubeadm_alpha_phase_addon_coredns.md
instead of:
generated/kubeadm_alpha_phase_addon_kube-dns.md
* Update cloud controller manager docs to beta 1.11

* Use Hugo shortcode for feature state
…es#8617)

Also:
- Include note that this was added in 1.11.
- Modify the note about upgrade guidance.
Give CoreDNS instead of kube-dns examples in:
- docs/setup/independent/create-cluster-kubeadm.md
- docs/setup/independent/troubleshooting-kubeadm.md
* update 1.11 --server-print info

* Copyedit
* Update version selector for 1.11

* Mark ExpandPersistentVolumes Beta

xref: kubernetes/kubernetes#64288
Add info to install kube-dns instead of CoreDNS, as CoreDNS
is the default DNS server in 1.11.

Add notes that kubeadm config images can be used to list and pull
the required images in 1.11.
)

- Replace examples from kube-dns to CoreDNS
- Add notes about the CoreDNS feature gate status in 1.11
- Add note that the service name for CoreDNS is also
called `kube-dns`
* Update block device support for 1.11

* Copyedits
- Add includes for the generated pages
- Include placeholder generated pages
…tes#8958)

- include godocs link for MasterConfiguration
- include example MasterConfiguration
- add note that `kubeadm config print-default` can be used
Add notes and includes for these new commands in 1.11:
- kubeadm config print-default
- kubeadm config migrate
- kubeadm config images list
- kubeadm config images pull

Include placeholder generated files for the above.
It was requested that for this page a couple of methods
should be outlined:
- manual installation for CoreDNS explained at the Kubernetes
section of the GitHub project for CoreDNS
- installation and upgrade via kubeadm

Make the above changes and also add a section "About CoreDNS".

This commit also lowercases a section title.
* Add docs for volume expansion going beta

* Copyedit

* Address feedback
@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 15, 2018
@tengqm
Copy link
Contributor Author

tengqm commented Jun 15, 2018

@steveperry-53 This is the other option (may be your preferred one?). Let's see if this approach works.

@tengqm tengqm force-pushed the new-kubectl-ref branch from 6fe4ac7 to 36767bb Compare June 15, 2018 02:49
This is collection of kubectl reference docs generated in the same way
as we do for kube-apiserver, kubelet, kubeadm etc. This is different
from the way we do today for kubectl (see kubernetes#9080). Sending this to get
comments from reviewers.
@tengqm tengqm force-pushed the new-kubectl-ref branch from 36767bb to b8c5417 Compare June 15, 2018 02:54
@steveperry-53
Copy link
Contributor

@tengqm Thanks for doing this. It will be good to have this for discussion.

@steveperry-53
Copy link
Contributor

@MistyHacks This PR is for preview and discussion purposes only.

@mdlinville mdlinville added this to the 1.12 milestone Jun 21, 2018
@mdlinville mdlinville force-pushed the release-1.11 branch 2 times, most recently from 8ea8f16 to bae709e Compare June 27, 2018 20:07
@zacharysarah
Copy link
Contributor

@tengqm @steveperry-53 👋 Please feel free to reopen this PR if it's still relevant to preview/discussion.

@tengqm
Copy link
Contributor Author

tengqm commented Aug 28, 2018

/reopen

@k8s-ci-robot k8s-ci-robot reopened this Aug 28, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: tengqm

If they are not already assigned, you can assign the PR to them by writing /assign @tengqm in a comment when ready.

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

@tfogo
Copy link
Contributor

tfogo commented Aug 29, 2018

@tengqm Awesome! Is your proposal that we then remove this version of the kubectl documentation? https://5b232a7711b73b3d64fc79b6--kubernetes-io-vnext-staging.netlify.com/docs/reference/generated/kubectl/kubectl-commands

@tengqm
Copy link
Contributor Author

tengqm commented Aug 30, 2018

@tfogo Yes.

@tfogo
Copy link
Contributor

tfogo commented Aug 30, 2018

Cool. So where are we at with regards to a decision on this? It looks like this was discussed at the sig meeting on June 19, but there wasn't any clear outcome.

@xiangpengzhao xiangpengzhao removed their request for review August 31, 2018 02:03
@zparnold
Copy link
Member

zparnold commented Sep 9, 2018

Does this need to have its base switched to 1.12 or is it needed at all?

@zparnold zparnold changed the base branch from release-1.11 to release-1.12 September 21, 2018 23:35
@zacharysarah
Copy link
Contributor

@tengqm 👋 Please feel free to reopen this PR when you're ready to address feedback. ☝️

@tengqm tengqm deleted the new-kubectl-ref branch July 5, 2020 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.