From 9785feafbba7e3f1aea6f05e6bceb6609b0ef996 Mon Sep 17 00:00:00 2001 From: astraw99 Date: Sun, 4 Sep 2022 22:16:03 +0800 Subject: [PATCH] Update plugin manifest doc --- hack/krew.yaml | 2 ++ site/content/docs/developer-guide/plugin-manifest.md | 8 +++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/hack/krew.yaml b/hack/krew.yaml index 8d7e8ab2..8eeef0db 100644 --- a/hack/krew.yaml +++ b/hack/krew.yaml @@ -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 diff --git a/site/content/docs/developer-guide/plugin-manifest.md b/site/content/docs/developer-guide/plugin-manifest.md index 468d0122..b50f4f05 100644 --- a/site/content/docs/developer-guide/plugin-manifest.md +++ b/site/content/docs/developer-guide/plugin-manifest.md @@ -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: @@ -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: @@ -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.