Skip to content

Commit

Permalink
chore: run helm-docs
Browse files Browse the repository at this point in the history
Signed-off-by: Matthias Riegler <[email protected]>
  • Loading branch information
xvzf committed Oct 30, 2024
1 parent 2b5b999 commit 1270609
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ and deploying to your cluster. Please be aware that it is using the cluster your

Some part of the project docs may be autogenerated and require running a script.

#### Re-generating helm docs after modifying the chart
` ./.github/scripts/generate-helm-docs.sh`

#### CRDs Docs
If you modified or added crds to the project, then you should recreate the crds.md file. To do so run:

Expand Down
3 changes: 2 additions & 1 deletion chart/open-feature-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ The command removes all the Kubernetes components associated with the chart and

| Name | Description | Value |
| ------------------------------------------ | ------------------------------------------------------------------------------- | ---------------------------------- |
| `flagdProxyConfiguration.replicaCount` | sets the number of replicas for the flagd-proxy deployment. | `1` |
| `flagdProxyConfiguration.port` | Sets the port to expose the sync API on. | `8015` |
| `flagdProxyConfiguration.managementPort` | Sets the port to expose the management API on. | `8016` |
| `flagdProxyConfiguration.image.repository` | Sets the image for the flagd-proxy deployment. | `ghcr.io/open-feature/flagd-proxy` |
Expand Down Expand Up @@ -177,7 +178,7 @@ The command removes all the Kubernetes components associated with the chart and
| `controllerManager.kubeRbacProxy.resources.requests.cpu` | Sets cpu resource requests for kube-rbac-proxy. | `5m` |
| `controllerManager.kubeRbacProxy.resources.requests.memory` | Sets memory resource requests for kube-rbac-proxy. | `64Mi` |
| `controllerManager.manager.image.repository` | Sets the image for the operator. | `ghcr.io/open-feature/open-feature-operator` |
| `controllerManager.manager.image.tag` | Sets the version tag for the operator. | `v0.7.2` |
| `controllerManager.manager.image.tag` | Sets the version tag for the operator. | `v0.8.0` |
| `controllerManager.manager.resources.limits.cpu` | Sets cpu resource limits for operator. | `500m` |
| `controllerManager.manager.resources.limits.memory` | Sets memory resource limits for operator. | `128Mi` |
| `controllerManager.manager.resources.requests.cpu` | Sets cpu resource requests for operator. | `10m` |
Expand Down

0 comments on commit 1270609

Please sign in to comment.