Skip to content

Commit 3479c19

Browse files
committed
Docs: Fix installation page URLs, versioning, and SLSA verification instructions
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
1 parent 263b5df commit 3479c19

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

documentation/content/en/installation/kpt-cli.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@ Download pre-compiled binaries:
1313

1414
Optionally verify the [SLSA3 signatures](https://slsa.dev/) generated using the OpenSSF's
1515
[slsa-framework/slsa-github-generator](https://github.com/slsa-framework/slsa-github-generator) during the release
16-
process. To verify a release binary:
16+
process. To verify a release archive:
1717

1818
1. Install the verification tool from [slsa-framework/slsa-verifier#installation](https://github.com/slsa-framework/slsa-verifier#installation).
1919
2. Download the signature file `multiple.intoto.jsonl` from the [GitHub releases page](https://github.com/kptdev/kpt/releases).
2020
3. Run the verifier:
2121

2222
```shell
23-
slsa-verifier verify-artifact --provenance-path multiple.intoto.jsonl --source-uri github.com/kptdev/kpt --source-versioned-tag <the-tag> kpt_<os>_<arch>
23+
slsa-verifier verify-artifact --provenance-path multiple.intoto.jsonl --source-uri github.com/kptdev/kpt --source-versioned-tag <the-tag> kpt_<os>_<arch>-<version>.tar.gz
2424
```
2525

26-
On Linux and MacOS, make it executable:
26+
After downloading (and optionally verifying), extract the archive:
2727

2828
```shell
29-
chmod +x kpt
29+
tar -xzf kpt_<os>_<arch>-<version>.tar.gz
3030
```
3131

3232
On MacOS the first time, it may be necessary to open the program from the finder with _ctrl-click open_.
@@ -89,20 +89,20 @@ Running kpt via Docker does not install kpt on your machine. Each `docker run ..
8989
### `kpt`
9090

9191
```shell
92-
docker run ghcr.io/kptdev/kpt:{{< kpt_version >}} version
92+
docker run ghcr.io/kptdev/kpt:v{{< kpt_version >}} version
9393
```
9494

9595
To use kpt with files on your host, mount your current directory into the container and set a working directory:
9696

9797
```shell
98-
docker run --rm -v "$PWD":/workdir -w /workdir ghcr.io/kptdev/kpt:{{< kpt_version >}} pkg tree
99-
docker run --rm -v "$PWD":/workdir -w /workdir ghcr.io/kptdev/kpt:{{< kpt_version >}} fn render
98+
docker run --rm -v "$PWD":/workdir -w /workdir ghcr.io/kptdev/kpt:v{{< kpt_version >}} pkg tree
99+
docker run --rm -v "$PWD":/workdir -w /workdir ghcr.io/kptdev/kpt:v{{< kpt_version >}} fn render
100100
```
101101

102102
On Windows PowerShell, use `${PWD}.Path` for the current directory:
103103

104104
```shell
105-
docker run --rm -v "${PWD}.Path:/workdir" -w /workdir ghcr.io/kptdev/kpt:{{< kpt_version >}} pkg tree
105+
docker run --rm -v "${PWD}.Path:/workdir" -w /workdir ghcr.io/kptdev/kpt:v{{< kpt_version >}} pkg tree
106106
```
107107

108108
This pattern ensures kpt reads and writes files under `/workdir`, which maps to your current directory on the host.
@@ -168,11 +168,11 @@ kpt version
168168
[cloud-sdk]: https://github.com/GoogleCloudPlatform/cloud-sdk-docker
169169

170170
[linux-amd64]:
171-
https://github.com/kptdev/kpt/releases/download/{{< kpt_version >}}/kpt_linux_amd64
171+
https://github.com/kptdev/kpt/releases/download/v{{< kpt_version >}}/kpt_linux_amd64-{{< kpt_version >}}.tar.gz
172172
[linux-arm64]:
173-
https://github.com/kptdev/kpt/releases/download/{{< kpt_version >}}/kpt_linux_arm64
173+
https://github.com/kptdev/kpt/releases/download/v{{< kpt_version >}}/kpt_linux_arm64-{{< kpt_version >}}.tar.gz
174174
[darwin-amd64]:
175-
https://github.com/kptdev/kpt/releases/download/{{< kpt_version >}}/kpt_darwin_amd64
175+
https://github.com/kptdev/kpt/releases/download/v{{< kpt_version >}}/kpt_darwin_amd64-{{< kpt_version >}}.tar.gz
176176
[darwin-arm64]:
177-
https://github.com/kptdev/kpt/releases/download/{{< kpt_version >}}/kpt_darwin_arm64
177+
https://github.com/kptdev/kpt/releases/download/v{{< kpt_version >}}/kpt_darwin_arm64-{{< kpt_version >}}.tar.gz
178178
[bash-completion]: https://github.com/scop/bash-completion#installation
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{{- getenv "HUGO_KPT_VERSION" | default .Site.Params.kpt_version -}}
1+
{{- (getenv "HUGO_KPT_VERSION" | default .Site.Params.kpt_version) | strings.TrimPrefix "v" -}}

0 commit comments

Comments
 (0)