✨ Add kubectl workspace plugin and adjust usage output

[hardys]

Summary

Elsewhere we describe aliases of ws/workspace/workspaces but the
plugin only works with ws/workspaces atm - this makes it consistent
and allows us to share the same usage with the underlying kcp
plugin subcommand.

Related issue(s)

Discussed in #687 and may enable some clearer and/or more consistent docs, but doesn't actually fix that issue

[ncdc]

Just FYI, I have a ton of plugin structural changes in #1701, in case you're interested.

[hardys]

Just FYI, I have a ton of plugin structural changes in #1701, in case you're interested.

Ah thanks, will review! 👍

[hardys]

I reviewed #1701 and tried it locally - lgtm but doesn't address the issues covered in the PR so I rebased this and adjusted the workspace plugin part to use symlinks instead of further duplicated code (this also removes the current duplication between kubectl-ws and kubectl-workspaces)

[hardys]

Ready for another review, previous comments addressed - thanks for the feedback!

One thing to mention - this only symlinks in the install Makefile target - this means we won't have the CLI aliases in the container image, because the Dockerfile uses the build target then copies kubectl-*

Do we want/need the ws/workspaces aliases in the Dockerfile (or build target) to resolve that?

[hardys]

/retest

[ncdc]

goreleaser config needs updating

[ncdc]

Re the Dockerfile, we should probably ensure the symlinks get into the image. Would it be possible to have them created in the build target?

[hardys]

Re the Dockerfile, we should probably ensure the symlinks get into the image. Would it be possible to have them created in the build target?

Yes this seems like the best option given that COPY resolves any symlinks created by the build target in the makefile - now updated

[hardys]

goreleaser config needs updating

Ack now updated to reflect the new binary naming, although looking at the docs it seems like we can only create symlinks when generating OS packages - I'll double check this though as I'm not very familiar with goreleaser.

[hardys]

@ncdc I updated the goreleaser config - AFAICS to generate symlinks in the archive I need to create them in a post build hook, then copy the resulting files, this seems to work running locally but happy to hear if there is a cleaner way :)

$ tar -tvf dist/kubectl-kcp-plugin_0.1.0-SNAPSHOT-c6d4c591_linux_amd64.tar.gz
lrwxrwxrwx shardy/shardy     0 2022-09-26 15:50 bin/kubectl-workspaces -> kubectl-workspace
lrwxrwxrwx shardy/shardy     0 2022-09-26 15:50 bin/kubectl-ws -> kubectl-workspace
-rwxrwxr-x shardy/shardy 94323912 2022-09-26 15:50 bin/kubectl-workspace
-rwxrwxr-x shardy/shardy 101777416 2022-09-26 15:50 bin/kubectl-kcp

[hardys]

@ncdc this is ready for another review pass when you get a moment, thanks!

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ncdc

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 [ncdc]

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