|
@@ -1,24 +1,46 @@
|
|
|
-# Getting started with Services APIs
|
|
|
|
|
|
|
+# Getting started
|
|
|
|
|
|
|
|
-## Installing CRDs
|
|
|
|
|
|
|
+External-secrets runs within your Kubernetes cluster as a deployment resource.
|
|
|
|
|
+It utilizes CustomResourceDefinitions to configure access to secret providers through SecretStore resources
|
|
|
|
|
+and manages Kubernetes secret resources with ExternalSecret resources.
|
|
|
|
|
|
|
|
-This project provides a collection of Custom Resource Definitions (CRDs) that
|
|
|
|
|
-can be installed into any Kubernetes (>= 1.16) cluster.
|
|
|
|
|
|
|
+> Note: The minimum supported version of Kubernetes is `1.16.0`. Users still running Kubernetes v1.15 or below should upgrade
|
|
|
|
|
+> to a supported version before installing external-secrets.
|
|
|
|
|
|
|
|
-To install the CRDs, please execute:
|
|
|
|
|
|
|
+## 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.
|
|
|
|
|
+
|
|
|
|
|
+Uncomment the relevant line in the next steps to enable this.
|
|
|
|
|
+
|
|
|
|
|
+### Option 1: Install from chart repository
|
|
|
|
|
+
|
|
|
|
|
+**Note:** No chart repository is yet available. See [Issue #105](https://github.com/external-secrets/external-secrets/issues/105) for details.
|
|
|
``` bash
|
|
``` bash
|
|
|
-kubectl kustomize "github.com/external-secrets/external-secrets/config/crd" \
|
|
|
|
|
-| kubectl apply -f -
|
|
|
|
|
|
|
+helm repo add external-secrets https://charts.external-secrets.io
|
|
|
|
|
+
|
|
|
|
|
+helm install external-secrets \
|
|
|
|
|
+ external-secrets/external-secrets \
|
|
|
|
|
+ -n external-secrets \
|
|
|
|
|
+ --create-namespace \
|
|
|
|
|
+ # --set installCRDs=true
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-## Install the controller
|
|
|
|
|
|
|
+### Option 2: Install chart from local build
|
|
|
|
|
+
|
|
|
|
|
+Build and install the Helm chart locally after cloning the repository.
|
|
|
|
|
|
|
|
``` bash
|
|
``` bash
|
|
|
-kubectl kustomize "github.com/external-secrets/external-secrets/config/default" \
|
|
|
|
|
-| kubectl apply -f -
|
|
|
|
|
|
|
+make helm.build
|
|
|
|
|
+
|
|
|
|
|
+helm install external-secrets \
|
|
|
|
|
+ ./bin/chart/external-secrets.tgz \
|
|
|
|
|
+ -n external-secrets \
|
|
|
|
|
+ --create-namespace \
|
|
|
|
|
+ # --set installCRDs=true
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
|
|
+
|
|
|
### Create your first SecretStore
|
|
### Create your first SecretStore
|
|
|
|
|
|
|
|
``` yaml
|
|
``` yaml
|
|
@@ -49,14 +71,21 @@ Events: <none>
|
|
|
For more advanced examples, please read the other
|
|
For more advanced examples, please read the other
|
|
|
[guides](guides-introduction.md).
|
|
[guides](guides-introduction.md).
|
|
|
|
|
|
|
|
-## Uninstalling the CRDs
|
|
|
|
|
|
|
+## Uninstalling
|
|
|
|
|
|
|
|
-To uninstall the CRDs and all resources created with them, run the following
|
|
|
|
|
-command. Note that this will remove all ExternalSecrets and SecretStore
|
|
|
|
|
-resources in your cluster. If you have been using these resources for any other
|
|
|
|
|
-purpose do not uninstall these CRDs.
|
|
|
|
|
|
|
+Before continuing, ensure that all external-secret resources that have been created by users have been deleted.
|
|
|
|
|
+You can check for any existing resources with the following command:
|
|
|
|
|
|
|
|
|
|
+```bash
|
|
|
|
|
+kubectl get SecretStores,ClusterSecretStores,ExternalSecrets --all-namespaces
|
|
|
```
|
|
```
|
|
|
-kubectl kustomize "github.com/external-secrets/external-secrets/config/crd" \
|
|
|
|
|
-| kubectl delete -f -
|
|
|
|
|
|
|
+
|
|
|
|
|
+Once all these resources have been deleted you are ready to uninstall external-secrets.
|
|
|
|
|
+
|
|
|
|
|
+### Uninstalling with Helm
|
|
|
|
|
+
|
|
|
|
|
+Uninstall the helm release using the delete command.
|
|
|
|
|
+
|
|
|
|
|
+```bash
|
|
|
|
|
+helm delete external-secrets --namespace external-secrets
|
|
|
```
|
|
```
|