1
0
Fork 0
mirror of https://github.com/external-secrets/external-secrets.git synced 2024-12-14 11:57:59 +00:00
external-secrets/docs/guides-getting-started.md
Moritz Johner 7b883778e9
feat: add docs (#39)
* feat: add docs

Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
2021-03-01 08:31:02 +01:00

1.5 KiB

Getting started with Services APIs

Installing CRDs

This project provides a collection of Custom Resource Definitions (CRDs) that can be installed into any Kubernetes (>= 1.16) cluster.

To install the CRDs, please execute:

kubectl kustomize "github.com/external-secrets/external-secrets/config/crd" \
| kubectl apply -f -

Install the controller

kubectl kustomize "github.com/external-secrets/external-secrets/config/default" \
| kubectl apply -f -

Create your first SecretStore

{% include 'basic-secret-store.yaml' %}

Create your first ExternalSecret

{% include 'basic-external-secret.yaml' %}
kubectl describe externalsecret example
# [...]
Name:  example
Status:
  Conditions:
    Last Transition Time:  2021-02-24T16:45:23Z
    Message:               Secret was synced
    Reason:                SecretSynced
    Status:                True
    Type:                  Ready
  Refresh Time:            2021-02-24T16:45:24Z
Events:                    <none>

For more advanced examples, please read the other guides.

Uninstalling the CRDs

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.

kubectl kustomize "github.com/external-secrets/external-secrets/config/crd" \
| kubectl delete -f -