Skip to content

Commit

Permalink
docs: Update Documentation for Gateway API Plugin Versioning (#97)
Browse files Browse the repository at this point in the history
* docs: update plugin reference to reflect version changes

- Forked the repository because the documentation was outdated.
- Noted that updating the version requires attention as the '-' in the name was removed in version 4.0 (e.g., `gateway-api` to `gatewayapi`).
- Fixed the reference on line 27 to use `gatewayapi` instead of the outdated `gateway-api`.

Signed-off-by: nico <nico@nico>

* docs: update plugin reference to reflect version changes

- Forked the repository because the documentation was outdated.
- Noted that updating the version requires attention as the '-' in the name was removed in version 4.0 (e.g., `gateway-api` to `gatewayapi`).
- Fixed the reference on line 27 to use `gatewayapi` instead of the outdated `gateway-api`.

Signed-off-by: nico <nico@nico>
Signed-off-by: Nico <[email protected]>

---------

Signed-off-by: nico <nico@nico>
Signed-off-by: Nico <[email protected]>
  • Loading branch information
victornico15 authored Jan 4, 2025
1 parent 6d24af2 commit c50b467
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ metadata:
data:
trafficRouterPlugins: |-
- name: "argoproj-labs/gatewayAPI"
location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/<version>/gateway-api-plugin-<arch>"
location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/<version>/gatewayapi-plugin-<arch>"
```
You can find the available versions and architectures at the [Releases page](https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases).
Expand All @@ -40,7 +40,7 @@ metadata:
data:
trafficRouterPlugins: |-
- name: "argoproj-labs/gatewayAPI"
location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/v0.2.0/gateway-api-plugin-linux-amd64"
location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/v0.4.0/gatewayapi-plugin-linux-amd64"
```

Deploy this file with `kubectl apply -f gateway-plugin.yml -n argo-rollouts`. You can also use [Argo CD](https://argoproj.github.io/cd/) or any other Kubernetes deployment method that you prefer.
Expand All @@ -58,7 +58,7 @@ kubectl rollout restart deployment -n argo-rollouts argo-rollouts
Then check the controller logs. You should see a line for loading the plugin:
```
time="XXX" level=info msg="Downloading plugin argoproj-labs/gatewayAPI from: https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/v0.2.0/gateway-api-plugin-linux-amd64"
time="XXX" level=info msg="Downloading plugin argoproj-labs/gatewayAPI from: https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/v0.4.0/gatewayapi-plugin-linux-amd64"
time="YYY" level=info msg="Download complete, it took 7.792426599s"
```
Expand Down

0 comments on commit c50b467

Please sign in to comment.