update plugin documentation under docs>tasks>extend-kubectl #10259

juanvallejo · 2018-09-10T17:54:56Z

Updates kubectl plugin documentation under docs > tasks > extend-kubectl to include information and examples relevant to the plugin mechanism update in 1.12.

cc @soltysh

/sig cli

k8sio-netlify-preview-bot · 2018-09-10T17:58:56Z

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

Built with commit 7abf2ad

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

k8sio-netlify-preview-bot · 2018-09-10T17:59:36Z

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

Built with commit 5c95867

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

soltysh

/lgtm
@kubernetes/sig-docs-pr-reviews ptal

tengqm · 2018-09-13T02:20:00Z

content/en/docs/tasks/extend-kubectl/kubectl-plugins.md

@@ -10,131 +11,147 @@ content_template: templates/task

 {{< feature-state state="alpha" >}}

-This guide shows you how to install and write extensions for [kubectl](/docs/user-guide/kubectl/). Usually called *plugins* or *binary extensions*, this feature allows you to extend the default set of commands available in `kubectl` by adding new subcommands to perform new tasks and extend the set of features available in the main distribution of `kubectl`.
+This guide shows you how to install and write extensions for [kubectl](/docs/user-guide/kubectl/). By thinking of core `kubectl` commands as essential building blocks for interacting with a Kubernetes cluster, we can think


You may want to take this chance to revise the kubectl link to /docs/reference/kubectl/kubectl/. The current one used is a redirection.

juanvallejo · 2018-09-17T01:57:37Z

@tengqm Thanks, review comment addressed

juanvallejo · 2018-09-19T19:53:17Z

@tengqm @MistyHacks friendly ping

mdlinville · 2018-09-20T02:35:31Z

/unassign

tengqm · 2018-09-25T02:19:00Z

@juanvallejo This should go to release-1.12 branch?

soltysh · 2018-09-25T11:37:30Z

@tengqm that is correct

juanvallejo · 2018-09-26T01:22:11Z

/hold

Will update this PR with additional information regarding the creation of plugin commands with dashes in their names

juanvallejo · 2018-09-27T18:16:23Z

/hold cancel

@soltysh @tengqm this PR should be good to go

soltysh

/lgtm

kbhawkey · 2018-09-27T20:28:17Z

content/en/docs/tasks/extend-kubectl/kubectl-plugins.md

 ```

-### Accessing runtime attributes
+In the above scenario, the warning under `/usr/local/bin/moreplugins/kubectl-foo` tells us that this plugin will never be executed. Instead, the executable that appears first in our PATH, `/usr/local/bin/plugins/kubectl-foo`, willalways be found and executed first by the `kubectl` plugin mechanism.


nit: will always

tfogo · 2018-09-27T20:29:40Z

If this is for 1.12 it should not be against master.

/hold

We can see what @zparnold says but I think the best thing might be to hold off on this until the release-1.12 branch hits master.

tfogo · 2018-09-27T20:31:06Z

/assign @zparnold

tfogo · 2018-09-27T20:46:35Z

@juanvallejo To add a bit of clarification here, the release-1.12 branch is being merged today so we probably don't want to add something last minute. The deadline for additions to the 1.12 branch was a while ago and this PR should have been made against the release-1.12 branch. Sorry if the process for getting these docs into the 1.12 release was unclear. But we can definitely work on getting them into the docs shortly after the initial release 👍

zparnold · 2018-09-27T20:55:56Z

/approve

kbhawkey · 2018-09-27T20:58:13Z

content/en/docs/tasks/extend-kubectl/kubectl-plugins.md

+
+#### Name conflicts and overshadowing
+
+It can be possible to have multiple pluins with the same filename in different locations throughout your PATH.


pluins -> plugins

kbhawkey · 2018-09-27T21:28:45Z

content/en/docs/tasks/extend-kubectl/kubectl-plugins.md

+#### Names with dashes and underscores
+
+Although the `kubectl` plugin mechanism uses the dashes (`-`) in plugin filenames to determine the sequence of sub-commands that should invoke them, it is still possible to create a plugin
+command containing dashes in its commandline invocation by using underscores `_` in its filename.


nit: to be consistent, use (_)
nit, how does this read to you: uses the dash (-) in plugin filenames to separate the sequence of sub-commands processed by the plugin, it is still possible to create ...

k8sio-netlify-preview-bot · 2018-09-27T23:32:05Z

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

Built with commit 4ff391e

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

zparnold · 2018-09-27T23:32:41Z

/lgtm
/approve

k8s-ci-robot · 2018-09-27T23:32:50Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zparnold

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:

~~OWNERS~~ [zparnold]

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

zparnold · 2018-09-27T23:34:56Z

/hold cancel

k8sio-netlify-preview-bot · 2018-09-27T23:36:47Z

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

Built with commit 4ff391e

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

* Update docs for fields allowed at root of CRD schema (#9973) * add plugin docs and examples (#10053) * docs update to promote TaintNodesByCondition to beta (#9626) * HPA Specificity Improvements (#8757) Updated the HPA docs to reference the `autoscaling/v2beta2` API version, and added documentation about the new fields. * adjust docs for pod ready++ (#10049) * Remove --cadvisor-port - has been deprecated since v1.10 (#10023) Change-Id: Id2a685473a243aef492a98ff450759f39e362557 * Add Documentation for Snapshot Feature (#9948) * Add documentation for snapshot feature * Update volume-snapshots.md * Add dry-run to api-concepts (#10033) * kubeadm-init: Update the offline support section (#10062) The update includes the following things (in mind with Kubernetes 1.12): - Remove the 1.8 image versions - Add the 1.10 image versions that were missing until now - Include a comment for the missing arch suffixes in 1.12 Signed-off-by: Rostislav M. Georgiev <rostislavg@vmware.com> * Say bye to `DynamicProvisioningScheduling` (#10157) The mentioned feature gate is now collapsed into `VolumeScheduling`. xref: kubernetes/kubernetes#67432 * Update ResourceQuota per PriorityClass state for 1.12 (#10229) * TokenRequest and TokenRequestProjection now beta (#10161) xref: kubernetes/kubernetes#67349 * Change feature state for kms provider to beta. (#10230) KMS Provider will be graduating to beta in v1.12, reflecting this change on the website. * coredns default (#10200) * Promote ShareProcessNamespace to beta in docs (#9996) * Add CoreDNS details to DNS Debug docs (#10201) * add coredns details * address nits, add query logging section * Update docs with topology aware dynamic provisioning (#9939) * Document topology aware volume binding feature * update for readability * Update storage-classes.md * comma splice * don't abbreviate * HPA Algorithm Information Improvements (#9780) * Update HPA docs with more algorithm details The HPA docs pointed to an out-of-date document for information on the algorithm details, which users were finding confusing. This sticks a section on the algorithm in the HPA docs instead, documenting both general behavior and corner cases. * Add glossary info, HPA docs on quantities People often ask about the quantity notation when working with the metrics APIs, so this adds a glossary entry on quantities (since they're used elsewhere in the system), and a short explantation in the HPA walkthough. * Information about HPA readiness and stabilization This adds information about the new changes to HPA readiness and stabilization from kubernetes/enhancements#591, and other minor changes that landed in Kubernetes 1.12. * Update horizontal-pod-autoscale.md * Audit 1.12 doc (#9953) * audit 1.12 document * remove legacy audit feature kubernetes/kubernetes#65862 * update feature gate doc * MountPropagation is now GA (#10090) * RuntimeClass documentation (#10102) * RuntimeClass documentation * Update runtime-class.md * Add documentation for Scheduler performance tuning (#10048) * Add documentation for Scheduler performance tuning * Update scheduler-perf-tuning.md * TTL controller for cleaning up finished resources (#10064) * TTL controller for cleaning up finished resources * Address comments * Update ttlafterfinished.md * Bump quota configuration api version (#10217) * Incremental update from master (#10278) * fix invalid href of cloud controller manager (#10240) * fix invalid yaml format (#10238) * update storage-limits doc with Azure disk part (#10224) update storage-limits doc with Azure disk part fix comments * Update kubelet-config-file.md (#10222) Update link to KubeletConfiguration struct. * fix a trivial misspelling (#10244) * Fix cassandra-statefulset.yaml indent level (#10243) * Mention minimum etcd versions (#10208) Source: https://groups.google.com/d/msg/kubernetes-dev/jMPA4JzKiY4/HIx2ugvLBAAJ * fix 404 error (#10250) * Small verb tweak (#10190) Present participle, ftw. * Add AnchorJS logic for header links (#10155) * Add AnchorJS JavaScript * Remove existing inpage_heading logic * Remove underline from anchor tags * Use single icon and add touch visibility * Use paragraph link icon for AnchorJS * Update Sass to use code formatting in docsContent headers * Update header size coverage to H3-H6 * fix broken link in kubefed.md (#10254) * Update the version numbers for the X-Remote-Extra- and Impersonate-Extra- key fixes (#9827) The fix was cherry picked into 1.11.3, 1.10.7, and 1.9.11: kubernetes/kubernetes#67162 kubernetes/kubernetes#67163 kubernetes/kubernetes#67164 * fix typo (#10168) * fix typo * addressing comments. * Update setup-ha-etcd-with-kubeadm.md * fix typos (#10252) * fix description of contribute guide (#10253) * describe truncate feature about advanced audit (#10236) * describe truncate feature about advanced audit * Update audit.md * docs update to promote ScheduleDaemonSetPods to beta (#9923) * Dynamic volume limit updates for 1.12 (#10211) * add a placeholder commit * Update docs for csi volume limits * Update storage-limits.md * Add "MayRunAs" value among other GroupStrategies (#9888) * Add CoreDNS details to the customize DNS doc (#10228) * Add CoreDNS details to the customize DNS doc Rewrite the document to include more details about CoreDNS, since it's now the default from v1.12 * Address comments * Improve doc wording * Fix link * Update dns-custom-nameservers.md * Update dns-custom-nameservers.md * Fix secrets docs in 1.12 branch (#10056) * Fix secrets docs * Update secret.md * Revert CoreDNS Docs (#10319) * Revert "Add CoreDNS details to DNS Debug docs (#10201)" This reverts commit 462817a. * Revert "Add CoreDNS details to the customize DNS doc (#10228)" This reverts commit e7319ee. * Revert "coredns default (#10200)" This reverts commit 698e93b. * Add CRI installation instructions page Added cri-installation page with CRI installation instructions Referenced it from kubeadm-init and install-kubeadm pages. * kubeadm: update API types documentation for 1.12 (#10283) v1alpha2 -> v1alpha3 MasterConfiguration -> [new-api-types] * TokenRequest feature documentation (#10295) * AdvancedAuditing is now GA (#10156) xref: kubernetes/kubernetes#65862 `AdvancedAuditing` feature is GA in 1.12. This PR adjusts the related docs. * update runtime-class.md (#10332) * update runtime-class.md * Update runtime-class.md * Document cross-authorizer permissions for creating RBAC roles (#10015) * Document cross-authorizer permissions for creating RBAC roles * Update rbac.md * kubeadm: update authored content for 1.12 (reference docs and cluster creation) (#10348) * kubeadm: update authored content in reference docs for 1.12 * kubeadm: add time frame in create-cluster-kubeadm for 1.12 * add AllowedProcMountTypes and ProcMountType to docs (#9911) Signed-off-by: Jess Frazelle <acidburn@microsoft.com> * kubeadm: add new command line reference (#10306) Add: - placeholder files - include place holder files - include "renew" sub command - add missing tabs for "alpha phase kubelet" * Documenting SCTP support in Kubernetes (#10279) * Documenting SCTP support in Kubernetes Service, Endpoint, NetworkPolicy and Pod * Updates based on comments on the PR * kubectl expose update with SCTP support * Updated according to comments in the PR * Revert "kubectl expose update with SCTP support" This reverts commit 0d5a1e6. * TLS Bootstrap and Server Cert Rotation feature documentation (#10232) * TokenRequest feature documentation * line wrapping to make review not insane * update content for GA without major refactor * Update kubelet-tls-bootstrapping.md * Add clarifications for volume snapshots (#10296) * Update kubadm ha installation for 1.12 (#10264) * Update kubadm ha installation for 1.12 Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * update stable version Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * Update stacked control plane for v1.12 (#2) * use v1alpha3 Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * more v1alpha3 (#4) * updates Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * Document how to run in-tree cloud providers with kubeadm (#10357) Change-Id: Iab6b996a830503d74a6eb0c507c5f8ca7a39235b * kubeadm reference doc for release 1.12 (#10359) * Revert "Revert "Add CoreDNS details to DNS Debug docs (#10201)"" This reverts commit bb30f4d. * Revert "Revert "Add CoreDNS details to the customize DNS doc (#10228)"" This reverts commit bc23d45. * Revert "Revert "coredns default (#10200)"" This reverts commit 7f4350d. * add missing instruction for ha guide (#10374) Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * kubeadm - Ha upgrade updates (#10340) * Update HA upgrade docs * Adds external etcd HA upgrade guide Signed-off-by: Chuck Ha <ha.chuck@gmail.com> * copyedit * more edits * add runasgroup in psp (#10076) * update KubeletPluginsWatcher feature gate (#10205) * generated 1.12 docs * Building Multi-arch images with Manifests (#10379) In 1.12, a variety of images used in a typical kubernetes installation have started to using manifests to better support environments with arm or ppc64le architectures. For example all images used with kubeadm by default have manifests, another would be all the tests in the conformance test suite. Here we capture the best practices for everyone to start using manifests in their own workflows. Change-Id: I5ba4c5fe55ffc9486a8251760f3352be4f2e1494 * Upgrade docs for v1.12 (#10344) * generated assets and docs * remove 1.7 * update 1.12 * update plugin documentation under docs>tasks>extend-kubectl (#10259) * update plugin documentation under docs>tasks>extend-kubectl * Update kubectl-plugins.md

k8s-ci-robot added sig/cli Categorizes an issue or PR as relevant to SIG CLI. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 10, 2018

k8s-ci-robot requested review from fabianofranz and xiangpengzhao September 10, 2018 17:55

soltysh approved these changes Sep 12, 2018

View reviewed changes

k8s-ci-robot assigned soltysh Sep 12, 2018

k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Sep 12, 2018

tengqm reviewed Sep 13, 2018

View reviewed changes

juanvallejo force-pushed the jvallejo/update-more-plugin-docs branch from 7abf2ad to 0a1de57 Compare September 17, 2018 01:57

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 17, 2018

xiangpengzhao removed their request for review September 20, 2018 03:37

juanvallejo force-pushed the jvallejo/update-more-plugin-docs branch 2 times, most recently from 11cd4f9 to c20a616 Compare September 21, 2018 21:44

juanvallejo mentioned this pull request Sep 26, 2018

[1.12] plugin commands with dashes cannot be invoked with their original names kubernetes/kubectl#540

Closed

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 26, 2018

juanvallejo mentioned this pull request Sep 27, 2018

Need a real "get-all" command kubernetes/kubectl#527

Closed

juanvallejo force-pushed the jvallejo/update-more-plugin-docs branch from c20a616 to cb9dc1f Compare September 27, 2018 18:15

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 27, 2018

juanvallejo force-pushed the jvallejo/update-more-plugin-docs branch from cb9dc1f to 484002c Compare September 27, 2018 18:46

soltysh approved these changes Sep 27, 2018

View reviewed changes

kbhawkey reviewed Sep 27, 2018

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 27, 2018

k8s-ci-robot assigned zparnold Sep 27, 2018

zparnold changed the base branch from master to release-1.12 September 27, 2018 20:55

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 27, 2018

kbhawkey reviewed Sep 27, 2018

View reviewed changes

Update kubectl-plugins.md

4ff391e

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 27, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 27, 2018

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 27, 2018

zparnold merged commit 29dec80 into kubernetes:release-1.12 Sep 27, 2018

juanvallejo added a commit to juanvallejo/website that referenced this pull request Sep 28, 2018

address additional comments from pr kubernetes#10259

e9b22f0

juanvallejo mentioned this pull request Sep 28, 2018

Followup to PR#10259 #10422

Merged

k8s-ci-robot pushed a commit that referenced this pull request Oct 4, 2018

address additional comments from pr #10259 (#10422)

01677e2

juanvallejo added a commit to juanvallejo/website that referenced this pull request Oct 8, 2018

address additional comments from pr kubernetes#10259

dbbd282

juanvallejo added a commit to juanvallejo/website that referenced this pull request Oct 8, 2018

address additional comments from pr kubernetes#10259

6853276

juanvallejo added a commit to juanvallejo/website that referenced this pull request Oct 9, 2018

address additional comments from pr kubernetes#10259

b819e62

k8s-ci-robot pushed a commit that referenced this pull request Oct 10, 2018

address additional comments from pr #10259 (#10539)

275c8c6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update plugin documentation under docs>tasks>extend-kubectl #10259

update plugin documentation under docs>tasks>extend-kubectl #10259

juanvallejo commented Sep 10, 2018

k8sio-netlify-preview-bot commented Sep 10, 2018

k8sio-netlify-preview-bot commented Sep 10, 2018 •

edited

Loading

soltysh left a comment

tengqm Sep 13, 2018

juanvallejo commented Sep 17, 2018

juanvallejo commented Sep 19, 2018

mdlinville commented Sep 20, 2018

tengqm commented Sep 25, 2018

soltysh commented Sep 25, 2018

juanvallejo commented Sep 26, 2018

juanvallejo commented Sep 27, 2018

soltysh left a comment

kbhawkey Sep 27, 2018

tfogo commented Sep 27, 2018

tfogo commented Sep 27, 2018

tfogo commented Sep 27, 2018

zparnold commented Sep 27, 2018

kbhawkey Sep 27, 2018

kbhawkey Sep 27, 2018

k8sio-netlify-preview-bot commented Sep 27, 2018

zparnold commented Sep 27, 2018

k8s-ci-robot commented Sep 27, 2018

zparnold commented Sep 27, 2018

k8sio-netlify-preview-bot commented Sep 27, 2018


		#### Name conflicts and overshadowing

		It can be possible to have multiple pluins with the same filename in different locations throughout your PATH.

update plugin documentation under docs>tasks>extend-kubectl #10259

update plugin documentation under docs>tasks>extend-kubectl #10259

Conversation

juanvallejo commented Sep 10, 2018

k8sio-netlify-preview-bot commented Sep 10, 2018

k8sio-netlify-preview-bot commented Sep 10, 2018 • edited Loading

soltysh left a comment

Choose a reason for hiding this comment

tengqm Sep 13, 2018

Choose a reason for hiding this comment

juanvallejo commented Sep 17, 2018

juanvallejo commented Sep 19, 2018

mdlinville commented Sep 20, 2018

tengqm commented Sep 25, 2018

soltysh commented Sep 25, 2018

juanvallejo commented Sep 26, 2018

juanvallejo commented Sep 27, 2018

soltysh left a comment

Choose a reason for hiding this comment

kbhawkey Sep 27, 2018

Choose a reason for hiding this comment

tfogo commented Sep 27, 2018

tfogo commented Sep 27, 2018

tfogo commented Sep 27, 2018

zparnold commented Sep 27, 2018

kbhawkey Sep 27, 2018

Choose a reason for hiding this comment

kbhawkey Sep 27, 2018

Choose a reason for hiding this comment

k8sio-netlify-preview-bot commented Sep 27, 2018

zparnold commented Sep 27, 2018

k8s-ci-robot commented Sep 27, 2018

zparnold commented Sep 27, 2018

k8sio-netlify-preview-bot commented Sep 27, 2018

k8sio-netlify-preview-bot commented Sep 10, 2018 •

edited

Loading