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

Update plugin manifest doc #800

Merged
merged 1 commit into from
Sep 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions hack/krew.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ spec:
You can find documentation at
https://krew.sigs.k8s.io/docs/user-guide/quickstart/.

# The supported platforms for plugins are the ones that Krew itself is distributed in.
# See all supported platforms on the [releases page](https://github.com/kubernetes-sigs/krew/releases).
platforms:
- uri: https://github.com/kubernetes-sigs/krew/releases/download/KREW_TAG/krew-darwin_amd64.tar.gz
sha256: KREW_DARWIN_AMD64_CHECKSUM
Expand Down
8 changes: 7 additions & 1 deletion site/content/docs/developer-guide/plugin-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ spec:
Restarts a pod with the given name. The existing pod
will be deleted and created again, not a true restart.
# 'platforms' specify installation methods for various platforms (os/arch)
# See all supported platforms below.
platforms:
- selector:
matchExpressions:
Expand All @@ -49,7 +50,7 @@ spec:
- linux
# 'uri' specifies .zip or .tar.gz archive URL of a plugin
uri: https://github.com/achanda/kubectl-restart/archive/v0.0.3.zip
# 'sha256' is the sha256sum of the url above
# 'sha256' is the sha256sum of the url (archive file) above
sha256: d7079b79bf4e10e55ded435a2e862efe310e019b6c306a8ff04191238ef4b2b4
# 'files' lists which files should be extracted out from downloaded archive
files:
Expand Down Expand Up @@ -99,6 +100,11 @@ Krew makes it possible to install the same plugin on different operating systems
(e.g., `windows`, `darwin` (macOS), and `linux`) and different architectures
(e.g., `amd64`, `386`, `arm`, `arm64` and `ppc64le`).

**All supported platforms:**

The supported platforms for plugins are the ones that Krew itself is distributed in.
See all supported platforms on the [releases page](https://github.com/kubernetes-sigs/krew/releases).

To support multiple platforms, you may need to define multiple `platforms` in
the plugin manifest. The `selector` field matches to operating systems and
architectures using the keys `os` and `arch` respectively.
Expand Down