Browse Source

[Documentation] Align getting started documents regarding CRDs with actuality (installCRDs is true by default) (#2225)

Signed-off-by: Isaac Hui <ihui@dropbox.com>
Isaac 3 years ago
parent
commit
f3c5888bd5
1 changed files with 4 additions and 4 deletions
  1. 4 4
      docs/introduction/getting-started.md

+ 4 - 4
docs/introduction/getting-started.md

@@ -9,9 +9,9 @@ and manages Kubernetes secret resources with ExternalSecret resources.
 
 ## Installing with Helm
 
-To automatically install and manage the CRDs as part of your Helm release, you must add the --set installCRDs=true flag to your Helm installation command.
+The default install options will automatically install and manage the CRDs as part of your helm release. If you do not want the CRDs to be automatically upgraded and managed, you must set the `installCRDs` option to `false`. (e.g. `--set installCRDS=false`)
 
-Uncomment the relevant line in the next steps to enable this.
+Uncomment the relevant line in the next steps to disable the automatic install of CRDs.
 
 ### Option 1: Install from chart repository
 
@@ -22,7 +22,7 @@ helm install external-secrets \
    external-secrets/external-secrets \
     -n external-secrets \
     --create-namespace \
-  # --set installCRDs=true
+  # --set installCRDs=false
 ```
 
 ### Option 2: Install chart from local build
@@ -36,7 +36,7 @@ helm install external-secrets \
     ./bin/chart/external-secrets.tgz \
     -n external-secrets \
     --create-namespace \
-  # --set installCRDs=true
+  # --set installCRDs=false
 ```
 
 ### Create a secret containing your AWS credentials