Update guide to choose OS for the plugin #1038
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
Hi @tcnksm. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
needs-ok-to-test
| # Seletct the OS and architecture type (from v0.5.2) where you run the plugin. | ||
| # Currently, you can choose "linux_amd64" or "darwin_amd64" (Mac). | ||
| HNC_PLATFORM=linux_amd64 | ||
|
|
||
| # Download the plugin | ||
| curl -L https://github.com/kubernetes-sigs/multi-tenancy/releases/download/hnc-${HNC_VERSION}/kubectl-hns -o ./kubectl-hns | ||
|
|
||
| # Download the plugin (from v0.5.2) | ||
| curl -L https://github.com/kubernetes-sigs/multi-tenancy/releases/download/hnc-${HNC_VERSION}/kubectl-hns_${HNC_PLATFORM} -o ./kubectl-hns | ||
|
|
There was a problem hiding this comment.
Firstly, there's a typo ("Select", not "Seletct").
Secondly, this has a 0.5.2 instruction, then an instruction that doesn't appear to care which version it's for (but actually does), then another 0.5.2 instruction. How about grouping them:
# HNC v0.5.1 or earlier: download the plugin (Linux only)
curl ...
# HNC v0.5.2 or later: set the platform and download the plugin. The support platforms are:
# * linux_amd64 (Linux on Intel/AMD)
# * darwin_amd64 (MacOS on Intel)
HNC_PLATFORM=linux_amd64
curl ...
| # Set the desired OS and architecture (from v0.5.2) | ||
| HNC_PLATFORM=linux_amd64 | ||
|
|
There was a problem hiding this comment.
This isn't needed to install the Docker image
| #### Download the kubectl plugin (Linux only) | ||
| #### Download the kubectl plugin | ||
|
|
||
| The `kubectl-hns` plugin makes most HNC use and administration much easier; we | ||
| strongly recommend installing it. Run the following commands from any directory | ||
| on your `PATH`. | ||
|
|
||
| ```bash | ||
| # Download the plugin | ||
| curl -L https://github.com/kubernetes-sigs/multi-tenancy/releases/download/hnc-${HNC_VERSION}/kubectl-hns -o ./kubectl-hns | ||
|
|
||
| # Download the plugin (from v0.5.2) | ||
| curl -L https://github.com/kubernetes-sigs/multi-tenancy/releases/download/hnc-${HNC_VERSION}/kubectl-hns_$HNC_PLATFORM} -o ./kubectl-hns | ||
|
|
||
| chmod +x ./kubectl-hns | ||
| ``` |
There was a problem hiding this comment.
This section is now sufficiently complicated that I don't think it makes sense to repeat it twice. Instead of a full separate section, can you just add a link to #use-prepare to reference the earlier section?
There was a problem hiding this comment.
Ok! Make sense. Let me change it.
Now HNC plugin release binary supports both linux and darwin. This updates installation guide for it.
tcnksm
force-pushed
the
feature/installation-guide
branch
from
6083f16 to
a824c2b
Compare
|
Thank you for the review. Updated and squashed. |
|
/ok-to-test Thanks @tcnksm for this documentation! |
k8s-ci-robot
added
ok-to-test
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: adrianludwin, tcnksm 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 |
k8s-ci-robot
added
the
approved
This changes the plugin installation URL so update the user guide to support it.