Skip to content

Commit

Permalink
docs: expose instructions for kubeclient rate limits (#103)
Browse files Browse the repository at this point in the history
Signed-off-by: Kostis Kapelonis <kostis@codefresh.io>
  • Loading branch information
kostis-codefresh authored Jan 14, 2025
1 parent 44ab8fd commit c054e2c
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 16 deletions.
4 changes: 4 additions & 0 deletions README.md
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

This file was deleted.

18 changes: 18 additions & 0 deletions docs/installation.md
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).

0 comments on commit c054e2c

Please sign in to comment.