update relevant helm doc

operator-framework · Jul 20, 2020 · 8625124 · 8625124
1 parent 60c9ca2
commit 8625124
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/changelog/fragments/replace-max-workers.yaml → changelog/fragments/rename-max-workers.yaml b/changelog/fragments/replace-max-workers.yaml → changelog/fragments/rename-max-workers.yaml
@@ -2,11 +2,11 @@ entries:
   - description: >
       **(Valid only for Ansible/Helm-based Operators)**. The flag `--max-workers` is no longer supported. 
       Use `--max-concurrent-reconciles` instead.
-    kind: "removal"
+    kind: "change"
     breaking: true
     migration:
       header: Flag `max-workers` is no longer supported.
       body: |
-        The flag `max-workers` is no longer supported with ansible/helm binaries. It has been
-        renamed to to `--max-concurrent-reconciles`.
+        The flag `--max-workers` is no longer supported with ansible/helm binaries. It has been
+        renamed to `--max-concurrent-reconciles`.
 
diff --git a/website/content/en/docs/building-operators/helm/reference/advanced_features.md b/website/content/en/docs/building-operators/helm/reference/advanced_features.md
@@ -101,6 +101,11 @@ $ cat config/manager/manager.yaml
 ...
 ```
 
+While running locally, this flag can also be added to the helm binary. For example, running `helm-operator` binary with the above mentioned flag would give us a similar result:
+```
+helm-operator --max-concurrent-reconciles=10
+```
+
 **NOTE**: If you're using the default scaffolding, it is necessary to also apply this change to the `config/default/manager_auth_proxy_patch.yaml` file. This file is a `kustomize` patch to the operator deployment that configures [kube-rbac-proxy][kube-rbac-proxy] to require authorization for accessing your operator metrics. When `kustomize` applies this patch, it overrides the args defined in `config/manager/manager.yaml`
 
 ## Use `helm upgrade --force` for deployment