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.

Sign up for GitHub

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

docs: expose instructions for kubeclient rate limits #103

Merged
merged 1 commit into from
Jan 14, 2025
Merged

docs: expose instructions for kubeclient rate limits #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,9 @@ please [tell us about it](https://github.com/argoproj-labs/rollouts-plugin-traff

If you also want to add an example with your favorite [gateway API provider](https://rollouts-plugin-trafficrouter-gatewayapi.readthedocs.io/en/latest/provider-status/) please open a [Pull Request](https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/pulls).

## Contact

You can find us at the `#argo-rollouts` channel [at the CNCF slack](https://argoproj.github.io/community/join-slack).



16 changes: 0 additions & 16 deletions docs/features/cli-options.md
View file
Open in desktop

This file was deleted.

18 changes: 18 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,21 @@ time="YYY" level=info msg="Download complete, it took 7.792426599s"
```

You are now ready to use the Gateway API in your [Rollout definitions](https://argoproj.github.io/argo-rollouts/features/specification/). See also our [Quick Start Guide](quick-start.md).

## Configuration

The `kubeClientQPS` and `kubeClientBurst` options configure the behavior of the Kubernetes client. These
values may need to be increased if you operate Argo Rollouts in a large cluster. These values can be specified
using the `args` block of the plugin configuration:

```yaml
trafficRouterPlugins:
trafficRouterPlugins: |-
- name: "argoproj-labs/gatewayAPI"
location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/vX.X.X/gatewayapi-plugin-linux-amd64"
args:
- "-kubeClientQPS=40"
- "-kubeClientBurst=80"
```

Notice that this setting applies **only** to the plugin process. The main Argo Rollouts controller is not affected (or any other additional plugins you might have already).
Loading