|
|
@@ -77,7 +77,7 @@
|
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
|
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
|
|
|
|
|
|
- <a href="#getting-started-with-services-apis" tabindex="1" class="md-skip">
|
|
|
+ <a href="#getting-started" tabindex="1" class="md-skip">
|
|
|
Skip to content
|
|
|
</a>
|
|
|
|
|
|
@@ -358,19 +358,26 @@
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
- <a href="#installing-crds" class="md-nav__link">
|
|
|
- Installing CRDs
|
|
|
+ <a href="#installing-with-helm" class="md-nav__link">
|
|
|
+ Installing with Helm
|
|
|
+ </a>
|
|
|
+
|
|
|
+ <nav class="md-nav">
|
|
|
+ <ul class="md-nav__list">
|
|
|
+
|
|
|
+ <li class="md-nav__item">
|
|
|
+ <a href="#option-1-install-from-chart-repository" class="md-nav__link">
|
|
|
+ Option 1: Install from chart repository
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
-
|
|
|
- <li class="md-nav__item">
|
|
|
- <a href="#install-the-controller" class="md-nav__link">
|
|
|
- Install the controller
|
|
|
+
|
|
|
+ <li class="md-nav__item">
|
|
|
+ <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
|
|
|
+ Option 2: Install chart from local build
|
|
|
</a>
|
|
|
|
|
|
- <nav class="md-nav">
|
|
|
- <ul class="md-nav__list">
|
|
|
+</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#create-your-first-secretstore" class="md-nav__link">
|
|
|
@@ -392,11 +399,24 @@
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
- <a href="#uninstalling-the-crds" class="md-nav__link">
|
|
|
- Uninstalling the CRDs
|
|
|
+ <a href="#uninstalling" class="md-nav__link">
|
|
|
+ Uninstalling
|
|
|
+ </a>
|
|
|
+
|
|
|
+ <nav class="md-nav">
|
|
|
+ <ul class="md-nav__list">
|
|
|
+
|
|
|
+ <li class="md-nav__item">
|
|
|
+ <a href="#uninstalling-with-helm" class="md-nav__link">
|
|
|
+ Uninstalling with Helm
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
+
|
|
|
+ </ul>
|
|
|
+ </nav>
|
|
|
+
|
|
|
+</li>
|
|
|
|
|
|
|
|
|
|
|
|
@@ -711,19 +731,26 @@
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
- <a href="#installing-crds" class="md-nav__link">
|
|
|
- Installing CRDs
|
|
|
+ <a href="#installing-with-helm" class="md-nav__link">
|
|
|
+ Installing with Helm
|
|
|
+ </a>
|
|
|
+
|
|
|
+ <nav class="md-nav">
|
|
|
+ <ul class="md-nav__list">
|
|
|
+
|
|
|
+ <li class="md-nav__item">
|
|
|
+ <a href="#option-1-install-from-chart-repository" class="md-nav__link">
|
|
|
+ Option 1: Install from chart repository
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
-
|
|
|
- <li class="md-nav__item">
|
|
|
- <a href="#install-the-controller" class="md-nav__link">
|
|
|
- Install the controller
|
|
|
+
|
|
|
+ <li class="md-nav__item">
|
|
|
+ <a href="#option-2-install-chart-from-local-build" class="md-nav__link">
|
|
|
+ Option 2: Install chart from local build
|
|
|
</a>
|
|
|
|
|
|
- <nav class="md-nav">
|
|
|
- <ul class="md-nav__list">
|
|
|
+</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
<a href="#create-your-first-secretstore" class="md-nav__link">
|
|
|
@@ -745,11 +772,24 @@
|
|
|
</li>
|
|
|
|
|
|
<li class="md-nav__item">
|
|
|
- <a href="#uninstalling-the-crds" class="md-nav__link">
|
|
|
- Uninstalling the CRDs
|
|
|
+ <a href="#uninstalling" class="md-nav__link">
|
|
|
+ Uninstalling
|
|
|
+ </a>
|
|
|
+
|
|
|
+ <nav class="md-nav">
|
|
|
+ <ul class="md-nav__list">
|
|
|
+
|
|
|
+ <li class="md-nav__item">
|
|
|
+ <a href="#uninstalling-with-helm" class="md-nav__link">
|
|
|
+ Uninstalling with Helm
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
+
|
|
|
+ </ul>
|
|
|
+ </nav>
|
|
|
+
|
|
|
+</li>
|
|
|
|
|
|
|
|
|
|
|
|
@@ -770,18 +810,36 @@
|
|
|
<a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-getting-started.md" title="Edit this page" class="md-icon md-content__icon"></a>
|
|
|
|
|
|
|
|
|
- <h1 id="getting-started-with-services-apis">Getting started with Services APIs</h1>
|
|
|
-<h2 id="installing-crds">Installing CRDs</h2>
|
|
|
-<p>This project provides a collection of Custom Resource Definitions (CRDs) that
|
|
|
-can be installed into any Kubernetes (>= 1.16) cluster.</p>
|
|
|
-<p>To install the CRDs, please execute:</p>
|
|
|
-<div class="highlight"><pre><span></span>kubectl kustomize <span class="s2">"github.com/external-secrets/external-secrets/config/crd"</span> <span class="se">\</span>
|
|
|
-<span class="p">|</span> kubectl apply -f -
|
|
|
-</pre></div>
|
|
|
-
|
|
|
-<h2 id="install-the-controller">Install the controller</h2>
|
|
|
-<div class="highlight"><pre><span></span>kubectl kustomize <span class="s2">"github.com/external-secrets/external-secrets/config/default"</span> <span class="se">\</span>
|
|
|
-<span class="p">|</span> kubectl apply -f -
|
|
|
+ <h1 id="getting-started">Getting started</h1>
|
|
|
+<p>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.</p>
|
|
|
+<blockquote>
|
|
|
+<p>Note: The minimum supported version of Kubernetes is <code>1.16.0</code>. Users still running Kubernetes v1.15 or below should upgrade
|
|
|
+to a supported version before installing external-secrets.</p>
|
|
|
+</blockquote>
|
|
|
+<h2 id="installing-with-helm">Installing with Helm</h2>
|
|
|
+<p>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.</p>
|
|
|
+<p>Uncomment the relevant line in the next steps to enable this.</p>
|
|
|
+<h3 id="option-1-install-from-chart-repository">Option 1: Install from chart repository</h3>
|
|
|
+<p><strong>Note:</strong> No chart repository is yet available. See <a href="https://github.com/external-secrets/external-secrets/issues/105">Issue #105</a> for details.
|
|
|
+<div class="highlight"><pre><span></span>helm repo add external-secrets https://charts.external-secrets.io
|
|
|
+
|
|
|
+helm install external-secrets <span class="se">\</span>
|
|
|
+ external-secrets/external-secrets <span class="se">\</span>
|
|
|
+ -n external-secrets <span class="se">\</span>
|
|
|
+ --create-namespace <span class="se">\</span>
|
|
|
+ <span class="c1"># --set installCRDs=true</span>
|
|
|
+</pre></div></p>
|
|
|
+<h3 id="option-2-install-chart-from-local-build">Option 2: Install chart from local build</h3>
|
|
|
+<p>Build and install the Helm chart locally after cloning the repository.</p>
|
|
|
+<div class="highlight"><pre><span></span>make helm.build
|
|
|
+
|
|
|
+helm install external-secrets <span class="se">\</span>
|
|
|
+ ./bin/chart/external-secrets.tgz <span class="se">\</span>
|
|
|
+ -n external-secrets <span class="se">\</span>
|
|
|
+ --create-namespace <span class="se">\</span>
|
|
|
+ <span class="c1"># --set installCRDs=true</span>
|
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="create-your-first-secretstore">Create your first SecretStore</h3>
|
|
|
@@ -846,13 +904,16 @@ Events: <none>
|
|
|
|
|
|
<p>For more advanced examples, please read the other
|
|
|
<a href="../guides-introduction/">guides</a>.</p>
|
|
|
-<h2 id="uninstalling-the-crds">Uninstalling the CRDs</h2>
|
|
|
-<p>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.</p>
|
|
|
-<div class="highlight"><pre><span></span>kubectl kustomize "github.com/external-secrets/external-secrets/config/crd" \
|
|
|
-| kubectl delete -f -
|
|
|
+<h2 id="uninstalling">Uninstalling</h2>
|
|
|
+<p>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:</p>
|
|
|
+<div class="highlight"><pre><span></span>kubectl get SecretStores,ClusterSecretStores,ExternalSecrets --all-namespaces
|
|
|
+</pre></div>
|
|
|
+
|
|
|
+<p>Once all these resources have been deleted you are ready to uninstall external-secrets.</p>
|
|
|
+<h3 id="uninstalling-with-helm">Uninstalling with Helm</h3>
|
|
|
+<p>Uninstall the helm release using the delete command.</p>
|
|
|
+<div class="highlight"><pre><span></span>helm delete external-secrets --namespace external-secrets
|
|
|
</pre></div>
|
|
|
|
|
|
|