Skip to content

Commit f23ea86

Browse files
docs(v0): pin cozystack download URLs in v0 docs (#548)
A user on the cozystack_ru Telegram channel reported that `kubectl apply -f https://github.com/cozystack/cozystack/releases/latest/download/cozystack-installer.yaml` from the v0 install docs returns 404. That asset was dropped in v1.0 when the installer manifest was split into `cozystack-crds.yaml` plus `cozystack-operator-{generic,hosted,talos}.yaml`, and `releases/latest/download/` now resolves to v1.4.x where the legacy name no longer exists. Two other v0 download URLs had the same failure mode: - `releases/latest/download/metal-amd64.{iso,raw.xz}` still resolves, but to the v1.4-era Talos build (Talos v1.13), which silently mismatches the Talos version the v0 installer manifest expects (Talos v1.11.6 in `v0.41.11`). A user following v0 docs ends up with a Talos image and installer combination that does not match. - `talm/releases/latest/download/talm-darwin-arm64` (the bare-binary asset name) was dropped in talm v0.17.0 in favor of `talm-darwin-arm64.tar.gz`, so the v0 Oracle Cloud guide's `wget` step also 404'd. Changes: - Add `data/versions/v0.yaml` with a single `cozystack_tag: "v0.41.11"` pin so the `version-pin` shortcode resolves on v0 pages — same pattern as `data/versions/v1.{3,4}.yaml`. - Replace every `releases/latest/download/<asset>` URL pointing into `cozystack/cozystack` under `content/en/docs/v0/` with `releases/download/{{< version-pin "cozystack_tag" >}}/<asset>`. Covers the installer manifest (3 pages) and the metal image downloads (2 pages). - Pin the "Cozystack releases page" link in the Oracle Cloud guide to the `tag/v0.41.11` page so the clickable link matches the `wget` command immediately below it. - Fix the talm download in the Oracle Cloud guide: switch from `releases/latest/download/talm-darwin-arm64` (404) to `releases/latest/download/talm-darwin-arm64.tar.gz` plus a `tar -xzf … talm` extraction step. talm stays floating on `latest` per the policy already documented in `data/versions/v1.4.yaml` ("Tools that stay backwards-compatible across minors — talm, boot-to-talos, talos-bootstrap install scripts — stay floating on main / latest in the markdown"). Out of scope: - `content/en/docs/v0/install/talos/boot-to-talos.md` keeps `boot-to-talos/releases/latest/download/...` by design — same floating policy as talm. - Older `cozystack/cozystack` `releases/download/$version/...` patterns where `$version` is a user-supplied literal (e.g. the v0 upgrade guide) are left untouched. - The 2024-08-16 blog post `aenix-io/cozystack/raw/v0.7.0/...` URL still resolves (HTTP 200) and is historical content. Verification: - `gh release view v0.41.11 --repo cozystack/cozystack` confirms every replaced asset is present. - `curl -fsI -L` on every replaced URL pattern: old URLs return 404, new pinned URLs return 200. - `hugo list all` parses all 132 v0 pages without errors. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated installation guides to reference version-pinned release artifacts instead of "latest" releases, ensuring documentation consistency and stability. * Improved Oracle Cloud installation instructions for clarity on binary extraction procedures. <!-- review_stack_entry_start --> [![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/cozystack/website/pull/548?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2 parents 94f043f + 676f9fd commit f23ea86

6 files changed

Lines changed: 21 additions & 7 deletions

File tree

content/en/docs/v0/getting-started/install-cozystack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ This file defines the Cozystack version.
9090
For tutorial, just take the latest stable version available on GitHub:
9191

9292
```bash
93-
kubectl apply -f https://github.com/cozystack/cozystack/releases/latest/download/cozystack-installer.yaml
93+
kubectl apply -f https://github.com/cozystack/cozystack/releases/download/{{< version-pin "cozystack_tag" >}}/cozystack-installer.yaml
9494
```
9595

9696
As the installation goes on, you can track the logs of installer:

content/en/docs/v0/install/cozystack/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Create a namespace `cozy-system` and install Cozystack system components:
9393
```bash
9494
kubectl create ns cozy-system --dry-run=client --output yaml | kubectl apply -f -
9595
kubectl apply -f cozystack.yaml
96-
kubectl apply -f https://github.com/cozystack/cozystack/releases/latest/download/cozystack-installer.yaml
96+
kubectl apply -f https://github.com/cozystack/cozystack/releases/download/{{< version-pin "cozystack_tag" >}}/cozystack-installer.yaml
9797
```
9898

9999
As the installation goes on, you can track the logs of installer:

content/en/docs/v0/install/providers/hetzner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ The final stage of deploying a Cozystack cluster on Hetzner is to install Cozyst
350350
```bash
351351
kubectl create ns cozy-system --dry-run=client --output yaml | kubectl apply -f -
352352
kubectl apply -f cozystack-config.yaml
353-
kubectl apply -f https://github.com/cozystack/cozystack/releases/latest/download/cozystack-installer.yaml
353+
kubectl apply -f https://github.com/cozystack/cozystack/releases/download/{{< version-pin "cozystack_tag" >}}/cozystack-installer.yaml
354354
```
355355
356356
The last command starts Cozystack installation, which will last for some time.

content/en/docs/v0/install/providers/oracle-cloud.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ or come and share your experience in the [Cozystack community](https://t.me/cozy
2727

2828
The first step is to make a Talos Linux installation image available for use in Oracle Cloud as a custom image.
2929

30-
1. Download the Talos Linux image archive from the [Cozystack releases page](https://github.com/cozystack/cozystack/releases/latest/) and unpack it:
30+
1. Download the Talos Linux image archive from the [Cozystack releases page](https://github.com/cozystack/cozystack/releases/tag/{{< version-pin "cozystack_tag" >}}) and unpack it:
3131

3232
```bash
33-
wget https://github.com/cozystack/cozystack/releases/latest/download/metal-amd64.raw.xz
33+
wget https://github.com/cozystack/cozystack/releases/download/{{< version-pin "cozystack_tag" >}}/metal-amd64.raw.xz
3434
xz -d metal-amd64.raw.xz
3535
```
3636

@@ -251,7 +251,8 @@ Make it executable and save it to `/usr/local/bin/talm`:
251251
252252
```bash
253253
# pick your preferred architecture from the release artifacts
254-
wget -O talm https://github.com/cozystack/talm/releases/latest/download/talm-darwin-arm64
254+
wget https://github.com/cozystack/talm/releases/latest/download/talm-darwin-arm64.tar.gz
255+
tar -xzf talm-darwin-arm64.tar.gz talm
255256
chmod +x talm
256257
mv talm /usr/local/bin/talm
257258
```

content/en/docs/v0/install/talos/iso.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Note that Cozystack provides its own Talos builds, which are tested and optimize
2121
1. Download Talos Linux asset from the Cozystack's [releases page](https://github.com/cozystack/cozystack/releases).
2222

2323
```bash
24-
wget https://github.com/cozystack/cozystack/releases/latest/download/metal-amd64.iso
24+
wget https://github.com/cozystack/cozystack/releases/download/{{< version-pin "cozystack_tag" >}}/metal-amd64.iso
2525
```
2626

2727
1. Boot your machine with ISO attached.

data/versions/v0.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Pinned upstream-tool versions for the Cozystack v0 docs.
2+
#
3+
# This file exists so the {{< version-pin "<key>" >}} shortcode can keep v0
4+
# download links pinned to a v0-era release. The legacy
5+
# `releases/latest/download/cozystack-installer.yaml` URL no longer resolves —
6+
# that asset was dropped in v1.0 when the installer manifest was split into
7+
# cozystack-crds.yaml plus cozystack-operator-*.yaml.
8+
#
9+
# Add more keys (talos, etc.) only when a v0 page introduces the corresponding
10+
# shortcode call.
11+
12+
# Last released Cozystack v0.x version, used as v-prefixed in GitHub URLs.
13+
cozystack_tag: "v0.41.11"

0 commit comments

Comments
 (0)