update kubectl documentation #12867

Liujingfang1 · 2019-02-26T22:01:26Z

update the kubectl docs after kustomize is integrated. kubernetes/enhancements#633

Add examples for Secret/ConfigMap generators in docs for Secret/ConfigMap
replace kubectl create -f by kubectl apply -f
Add a page for kustomize support in kubectl.

k8sio-netlify-preview-bot · 2019-02-26T22:01:33Z

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

Building with commit 6d8c564

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

sftim · 2019-03-06T18:38:39Z

I'd reckon this could use a
/milestone 1.14

npentrel · 2019-03-07T13:31:38Z

Hi @Liujingfang1, is this ready for review? We need all docs PRs to be ready to review by March 11th at the very latest. Thanks!

Liujingfang1 · 2019-03-07T16:59:58Z

@npentrel This is not ready yet. I'll update it later today.

Liujingfang1 · 2019-03-07T19:32:02Z

~~This PR is ready for review. Here is some note about one link used in the doc.~~
Not ready yet. Sorry about that.

I add one link in the doc, which points to the kubectl book from Phil's app site https://pwittrock-kubectl.firebaseapp.com/.
We'll eventually host the book by kubectl.docs.kubernetes.io. The work for this is in progress and we hope we can have it available by 3/11.
Before the work is done, I'd keep this link pointing to Phil's app site : )
We are not going to add link to this book. Instead, I'll create new page under concepts/overview/object-management-kubectl. I'll update the PR tomorrow. @npentrel

DanyC97 · 2019-03-08T06:54:45Z

quick question: on master branch this PR landed which improved the consistency, how is that work going to be reflected in 1.14 branch and so in this PR ?

DanyC97 · 2019-03-08T07:23:03Z

i'm a bit confused by the introduction of this kustomize sub-command and how that fits with the rest of kubectl.

I've read the KEP and other comments however looking at this PR as an operator who have no knowledge about the sub-command motivation and what the benefits are i ask myself:

is kubectl create gone and replaced with kubectl apply ?
is the imperative command going away ?
if not then why the s/create/apply ?
in current docs we have some info about the generators although there is an open issue where the kubectl code is out of sync with the docs . As such is this existing kubectl generator going to be replaced with the kustomize sub-command generator ?

content/en/docs/concepts/cluster-administration/manage-deployment.md

content/en/docs/reference/kubectl/conventions.md

content/en/docs/reference/kubectl/overview.md

content/en/docs/concepts/cluster-administration/logging.md

content/en/docs/concepts/configuration/secret.md

content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md

content/en/docs/tutorials/configuration/configure-redis-using-configmap.md

Liujingfang1 · 2019-03-15T20:45:49Z

@kbhawkey Do you think this is ready to merge? Are there anything else need to change? Thank you.

soltysh

lgtm

kbhawkey · 2019-03-15T21:36:07Z

@Liujingfang1, I am not a doc maintainer, and cannot approve this doc. I cc'ed @cody-clark and @jimangel.
In general, things are looking good, 👍 . Since there are so many file changes (some trivial), I have not read through every file in detail. One question I had is that though some of the changes are trivial, such as swapping out kubectl create with kubectl apply, will the examples still work without changes to the yaml?

kbhawkey · 2019-03-15T21:36:54Z

/assign @jimangel

Liujingfang1 · 2019-03-15T22:07:54Z

@jimangel @cody-clark Let me know if you'd like to see further changes.

DanyC97 · 2019-03-15T22:54:03Z

content/en/docs/concepts/cluster-administration/logging.md

@@ -35,7 +35,7 @@ a container that writes some text to standard output once per second.
 To run this pod, use the following command:

 ```shell
-$ kubectl create -f https://k8s.io/examples/debug/counter-pod.yaml
+$ kubectl apply -f https://k8s.io/examples/debug/counter-pod.yaml


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:54:12Z

content/en/docs/concepts/cluster-administration/manage-deployment.md

@@ -26,23 +26,23 @@ Many applications require multiple resources to be created, such as a Deployment
 Multiple resources can be created the same way as a single resource:

 ```shell
-$ kubectl create -f https://k8s.io/examples/application/nginx-app.yaml
+$ kubectl apply -f https://k8s.io/examples/application/nginx-app.yaml


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:54:29Z

content/en/docs/concepts/cluster-administration/manage-deployment.md


 ```shell
-$ kubectl create -f https://k8s.io/examples/application/nginx/nginx-svc.yaml -f https://k8s.io/examples/application/nginx/nginx-deployment.yaml
+$ kubectl apply -f https://k8s.io/examples/application/nginx/nginx-svc.yaml -f https://k8s.io/examples/application/nginx/nginx-deployment.yaml


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:54:37Z

content/en/docs/concepts/cluster-administration/manage-deployment.md

 ```

 And a directory can be specified rather than or in addition to individual files:

 ```shell
-$ kubectl create -f https://k8s.io/examples/application/nginx/
+$ kubectl apply -f https://k8s.io/examples/application/nginx/


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:54:53Z

content/en/docs/concepts/cluster-administration/manage-deployment.md

@@ -52,7 +52,7 @@ It is a recommended practice to put resources related to the same microservice o
 A URL can also be specified as a configuration source, which is handy for deploying directly from configuration files checked into github:

 ```shell
-$ kubectl create -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/application/nginx/nginx-deployment.yaml
+$ kubectl apply -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/application/nginx/nginx-deployment.yaml


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:55:00Z

content/en/docs/concepts/cluster-administration/manage-deployment.md

@@ -83,7 +83,7 @@ service "my-nginx-svc" deleted
 Because `kubectl` outputs resource names in the same syntax it accepts, it's easy to chain operations using `$()` or `xargs`:

 ```shell
-$ kubectl get $(kubectl create -f docs/concepts/cluster-administration/nginx/ -o name | grep service)
+$ kubectl get $(kubectl apply -f docs/concepts/cluster-administration/nginx/ -o name | grep service)


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:55:08Z

content/en/docs/concepts/cluster-administration/manage-deployment.md

@@ -108,14 +108,14 @@ project/k8s/development
 By default, performing a bulk operation on `project/k8s/development` will stop at the first level of the directory, not processing any subdirectories. If we had tried to create the resources in this directory using the following command, we would have encountered an error:

 ```shell
-$ kubectl create -f project/k8s/development
+$ kubectl apply -f project/k8s/development


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:55:17Z

content/en/docs/concepts/cluster-administration/manage-deployment.md

 error: you must provide one or more resources by argument or filename (.json|.yaml|.yml|stdin)
 ```

 Instead, specify the `--recursive` or `-R` flag with the `--filename,-f` flag as such:

 ```shell
-$ kubectl create -f project/k8s/development --recursive
+$ kubectl apply -f project/k8s/development --recursive


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:57:08Z

content/en/docs/concepts/configuration/secret.md

+```
+Apply the kustomization directory to create the Secret object.
+```shell
+$ kubectl apply -k .


can you please remove $ to align on style guideline and be consistent

DanyC97 · 2019-03-15T22:58:35Z

content/en/docs/concepts/configuration/secret.md

+$ kubectl apply -k .
+secret/db-user-pass-dddghtt9b5 created
+```
+Note that the generated Secrets name has a suffix appended by hashing the contents. This ensures that a new


can you please use the note shortcode - https://kubernetes.io/docs/contribute/style/style-guide/#shortcodes

DanyC97 · 2019-03-15T23:05:01Z

content/en/docs/concepts/configuration/secret.md

-    kubectl create secret generic dev-db-secret --from-literal=username=devuser --from-literal=password=S\\!B\\\*d\\$zDsb
-
-You do not need to escape special characters in passwords from files (`--from-file`).
-{{< /note >}}


any particular reason why this note was removed ? if i understand correctly, those who won't use the new sub-command will still need to use the above, am i missing something ?

or is that in 1.14 we are saying kustomization.yaml is the only way to go from kubectl standpoint ?

kustomization.yaml is recommended in one of the many ways. I'll add this note back.

DanyC97 · 2019-03-15T23:12:33Z

@Liujingfang1 i left you some comments around style guidelines, if you want to tackle them in this PR awesome, if not no prob, i'll come and clean it up in a follow up PR

Liujingfang1 · 2019-03-15T23:22:38Z

@DanyC97 I updated the changed according to your comments.
For $ in front of the shell command, it's better to clean it up in a different PR. As I can see, $ is used in many files and this PR only touches a portion of it.

jimangel · 2019-03-16T17:38:32Z

/lgtm
/approve

k8s-ci-robot · 2019-03-16T17:38:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jimangel

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:

~~content/en/OWNERS~~ [jimangel]

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

* Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S. (#11752) * Added documentation about Poseidon-Firmament scheduler * Fixed some style issues. * Udpated the document as per the review comments. * Fixed some typos and updated the document * Updated the document as per the review comments. * Document timeout attribute for kms-plugin. (#12158) See 72540. * Official documentation on Poseidon/Firmament, a new multi-scheduler (#12343) * Removed the old version of the Poseidon documentation. Incorrect location. * Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S (#12069) * Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S. (#11752) * Added documentation about Poseidon-Firmament scheduler * Fixed some style issues. * Udpated the document as per the review comments. * Fixed some typos and updated the document * Updated the document as per the review comments. * Updated the document as per review comments. Added config details. * Updated the document as per the latest review comments. Fixed nits * Made changes as per latest suggestions. * Some more changes added. * Updated as per suggestions. * Changed the release process section. * SIG Docs edits Small edits to match style guidelines. * add plus to feature state * capitalization * revert feature state shortcode since this is a Kubernetes extension, not a direct feature, it shouldn't use the regular feature state tagging. (cherry picked from commit 7730c15) * Remove initializers from doc. It will be removed in 1.14 (#12331) * kubeadm: Document CRI auto detection functionality (#12462) Signed-off-by: Rostislav M. Georgiev <[email protected]> * Minor doc change for GAing Pod DNS Config (#12514) * Graduate ExpandInUsePersistentVolumes feature to beta (#10574) * Rename 2018-11-07-grpc-load-balancing-with-linkerd.md.md file (#12594) * Add dynamic percentage of node scoring to user docs (#12235) * Add dynamic percentage of node scoring to user docs * addressed review comments * delete special symbol (#12445) * Update documentation for VolumeSubpathEnvExpansion (#11843) * Update documentation for VolumeSubpathEnvExpansion * Address comments - improve descriptions * Graduate Pod Priority and Preemption to GA (#12428) * Added Instana links to the documentation (#12977) * Added link to the Instana Kubernetes integration * Added Instana link for services section Added Instana and a link to the Kubernetes integration to the analytics services section and broadened the scope to APM, monitoring and analytics. * Oxford comma /flex * More Oxford commas, because they matter * Update kubectl plugins to stable (#12847) * documentation for CSI topology beta (#12889) * Document changes to default RBAC discovery ClusterRole(Binding)s (#12888) * Document changes to default RBAC discovery ClusterRole(Binding)s Documentation for kubernetes/enhancements#789 and kubernetes/kubernetes#73807 * documentation review feedback * CSI raw block to beta (#12931) * Change incorrect string raw to block (#12926) Fixes #12925 * Update documentation on node OS/arch labels (#12976) These labels have been promoted to GA: kubernetes/enhancements#793 * local pv GA doc updates (#12915) * Publish CRD OpenAPI Documentation (#12910) * add documentation for CustomResourcePublishOpenAPI * address comments fix links, ordered lists, style and typo * kubeadm: add document for upgrading from 1.13 to 1.14 (single CP and HA) (#13189) * kubeadm: add document for upgrading from 1.13 to 1.14 - remove doc for upgrading 1.10 -> 1.11 * kubeadm: apply amends to upgrade-1.14 doc * kubeadm: apply amends to upgrade-1.14 doc (part2) * kubeadm: apply amends to upgrade-1.14 doc (part3) * kubeadm: add note about "upgrade node experimental-control-plane" + add comment about `upgrade plan` * kubeadm: add missing "You should see output similar to this" * fix bullet indentation (#13214) * mark PodReadinessGate GA (#12800) * Update RuntimeClass documentation for beta (#13043) * Update RuntimeClass documentation for beta * Update feature gate & add upgrade section * formatting fixes * Highlight upgrade action required * Address feedback * CSI ephemeral volume alpha documentation (#10934) * update kubectl documentation (#12867) * update kubectl documentation * add document for Secret/ConfigMap generators * replace `kubectl create -f` by `kubectl apply -f` * Add page for kustomization support in kubectl * fix spelling errors and address comments * Documentation for Windows GMSA feature (#12936) * Documentation for Windows GMSA feature Signed-off-by: Deep Debroy <[email protected]> * Enhancements to GMSA docs Signed-off-by: Deep Debroy <[email protected]> * Fix links Signed-off-by: Deep Debroy <[email protected]> * Fix GMSA link Signed-off-by: Deep Debroy <[email protected]> * Add GMSA feature flag in feature flag list Signed-off-by: Deep Debroy <[email protected]> * Relocate GMSA to container configuration Signed-off-by: Deep Debroy <[email protected]> * Add example for container spec Signed-off-by: Deep Debroy <[email protected]> * Remove changes in Windows index Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Update configure-gmsa.md * Update configure-gmsa.md * Update configure-gmsa.md * Rearrange the steps into two sections and other edits Signed-off-by: Deep Debroy <[email protected]> * Fix links Signed-off-by: Deep Debroy <[email protected]> * Add reference to script to generate GMSA YAMLs Signed-off-by: Deep Debroy <[email protected]> * Some more clarifications for GMSA Signed-off-by: Deep Debroy <[email protected]> * HugePages graduated to GA (#13004) * HugePages graduated to GA * fixing nit for build * Docs for node PID limiting (kubernetes/kubernetes#73651) (#12932) * kubeadm: update the reference documentation for 1.14 (#12911) * kubeadm: update list of generated files for 1.14 NOTE: PLACEHOLDERS! these files are generated by SIG Docs each release, but we need them to pass the k/website PR CI. - add join_phase* (new sub phases of join) - add init_phase_upload-certs.md (new upload certs phase for init) - remove alpha-preflight (now both init and join have this) * kubeadm: update reference docs includes for 1.14 - remove includes from alpha.md - add upload-certs to init-phase.md - add join-phase.md and it's phases * kubeadm: update the editorial content of join and init - cleanup master->control-plane node - add some notes about phases and join - remove table about pre-pulling images - remove outdated info about self-hosting * kubeadm: update target release for v1alpha3 removal 1.14 -> 1.15 * kubeadm: copy edits for 1.14 reference docs (part1) * kubeadm: use "shell" for code blocks * kubeadm: update the 1.14 HA guide (#13191) * kubeadm: update the 1.14 HA guide * kubeadm: try to fix note/caution indent in HA page * kubeadm: fix missing sudo and minor amends in HA doc * kubeadm: apply latest amends to the HA doc for 1.14 * fixed a few missed merge conflicts * Admission Webhook new features doc (#12938) - kubernetes/kubernetes#74998 - kubernetes/kubernetes#74477 - kubernetes/kubernetes#74562 * Clarifications and fixes in GMSA doc (#13226) * Clarifications and fixes in GMSA doc Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Reformat to align headings and pre-reqs better Signed-off-by: Deep Debroy <[email protected]> * Reformat to align headings and pre-reqs better Signed-off-by: Deep Debroy <[email protected]> * Reformat to fix bullets Signed-off-by: Deep Debroy <[email protected]> * Reword application of sample gmsa Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Address feedback to use active voice Signed-off-by: Deep Debroy <[email protected]> * Address feedback to use active voice Signed-off-by: Deep Debroy <[email protected]> * RunAsGroup documentation for Progressing this to Beta (#12297) * start serverside-apply documentation (#13077) * start serverside-apply documentation * add more concept info on server side apply * Update api concepts * Update api-concepts.md * fix style issues * Document CSI update (#12928) * Document CSI update * Finish CSI documentation Also fix mistake with ExpandInUsePersistentVolumes documented as beta * Overall docs for CSI Migration feature (#12935) * Placeholder docs for CSI Migration feature Signed-off-by: Deep Debroy <[email protected]> * Address CR comments and update feature gates Signed-off-by: Deep Debroy <[email protected]> * Add mappings for CSI plugins Signed-off-by: Deep Debroy <[email protected]> * Add sections for AWS and GCE PD migration Signed-off-by: Deep Debroy <[email protected]> * Add docs for Cinder and CSI Migration info Signed-off-by: Deep Debroy <[email protected]> * Clarify scope to volumes with file system Signed-off-by: Deep Debroy <[email protected]> * Change the format of EBS and Cinder CSI Migration sections to follow the GCE template Signed-off-by: Deep Debroy <[email protected]> * Windows documentation updates for 1.14 (#12929) * Updated the note to indicate doc work for 1.14 * first attempt at md export from gdoc * simplifyig * big attempt * moving DRAFT windows content to PR for review * moving content to PR in markdown for review * updated note tags * Delete windows-contributing.md deleting this file as it is already ported to the github contributor guide * fixed formatting in intro and cluster setup guide * updating formatting for running containers guide * rejiggered end of troubleshooting * fixed minor typos * Clarified the windows binary download step * Update _index.md making updates based on feedback * Update _index.md updating ovn-kubernetes docs * Update _index.md * Update _index.md * updating relative docs links updating all the links to be relative links to /docs * Update _index.md * Update _index.md updates for windows services and ovn-kubernetes * formatted for correct step numbering * fix typos * Update _index.md updates for flannel PR in troubleshooting * Update _index.md * Update _index.md updating a few sections like roadmap, services, troubleshooting/filing tickets * Update _index.md * Update _index.md * Update _index.md * Fixed a few whitespace issues * Update _index.md * Update _index.md * Update _index.md * add section on upgrading CoreDNS (#12909) * documentation for kubelet resource metrics endpoint (#12934) * windows docs updates for 1.14 (#13279) * Delete sample-l2bridge-wincni-config.json this file is not used anywhere * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Rename content/en/docs/getting-started-guides/windows/_index.md to content/en/docs/setup/windows/_index.md moving to new location * Delete flannel-master-kubectl-get-ds.png * Delete flannel-master-kubeclt-get-pods.png * Delete windows-docker-error.png * Add files via upload * Rename _index.md to add-windows-nodes.md * Create _index.md * Update _index.md * Update add-windows-nodes.md * Update add-windows-nodes.md * Create user-guide-windows-nodes.md * Create user-guide-windows-containers.md * Update and rename add-windows-nodes.md to intro-windows-nodes.md * Update user-guide-windows-containers.md * Rename intro-windows-nodes.md to intro-windows-in-kubernetes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-containers.md * Update user-guide-windows-containers.md * Update user-guide-windows-nodes.md * Update user-guide-windows-containers.md * Update _index.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md fixing the pause image * Update intro-windows-in-kubernetes.md changing tables from html to MD * Update user-guide-windows-nodes.md converting tables from HTML to MD * Update intro-windows-in-kubernetes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-nodes.md updating the numbering , even though it messes up the notes a little bit. Jim will file a ticket to follow up * Update user-guide-windows-nodes.md * update to windows docs for 1.14 (#13322) * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update user-guide-windows-containers.md * Update user-guide-windows-nodes.md * Update intro-windows-in-kubernetes.md (#13344) * server side apply followup (#13321) * change some parts of serverside apply docs in response to comments * fix typos and wording * Update config.toml (#13365)

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 26, 2019

k8s-ci-robot requested review from xiangpengzhao and zhangxiaoyu-zidif February 26, 2019 22:01

Liujingfang1 mentioned this pull request Feb 26, 2019

integrate Kustomize into kubectl kubernetes/enhancements#633

Closed

update kubectl documentation

a6b6173

k8s-ci-robot added the language/en Issues or PRs related to English language label Feb 28, 2019

Liujingfang1 added 2 commits March 7, 2019 09:54

add document for Secret/ConfigMap generators

829cf2b

replace kubectl create -f by kubectl apply -f

8e0a7e4

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 7, 2019

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 7, 2019