|
|
@@ -10,14 +10,14 @@
|
|
|
</p>
|
|
|
Resource Types:
|
|
|
<ul></ul>
|
|
|
-<h3 id="external-secrets.io/v1alpha1.AWSSMAuth">AWSSMAuth
|
|
|
+<h3 id="external-secrets.io/v1alpha1.AWSAuth">AWSAuth
|
|
|
</h3>
|
|
|
<p>
|
|
|
(<em>Appears on:</em>
|
|
|
-<a href="#external-secrets.io/v1alpha1.AWSSMProvider">AWSSMProvider</a>)
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
|
|
|
</p>
|
|
|
<p>
|
|
|
-<p>AWSSMAuth contains a secretRef for credentials.</p>
|
|
|
+<p>AWSAuth contains a secretRef for credentials.</p>
|
|
|
</p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
@@ -31,8 +31,8 @@ Resource Types:
|
|
|
<td>
|
|
|
<code>secretRef</code></br>
|
|
|
<em>
|
|
|
-<a href="#external-secrets.io/v1alpha1.AWSSMAuthSecretRef">
|
|
|
-AWSSMAuthSecretRef
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSAuthSecretRef">
|
|
|
+AWSAuthSecretRef
|
|
|
</a>
|
|
|
</em>
|
|
|
</td>
|
|
|
@@ -41,14 +41,14 @@ AWSSMAuthSecretRef
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
-<h3 id="external-secrets.io/v1alpha1.AWSSMAuthSecretRef">AWSSMAuthSecretRef
|
|
|
+<h3 id="external-secrets.io/v1alpha1.AWSAuthSecretRef">AWSAuthSecretRef
|
|
|
</h3>
|
|
|
<p>
|
|
|
(<em>Appears on:</em>
|
|
|
-<a href="#external-secrets.io/v1alpha1.AWSSMAuth">AWSSMAuth</a>)
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSAuth">AWSAuth</a>)
|
|
|
</p>
|
|
|
<p>
|
|
|
-<p>AWSSMAuthSecretRef holds secret references for aws credentials
|
|
|
+<p>AWSAuthSecretRef holds secret references for aws credentials
|
|
|
both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.</p>
|
|
|
</p>
|
|
|
<table>
|
|
|
@@ -83,14 +83,14 @@ github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
-<h3 id="external-secrets.io/v1alpha1.AWSSMProvider">AWSSMProvider
|
|
|
+<h3 id="external-secrets.io/v1alpha1.AWSProvider">AWSProvider
|
|
|
</h3>
|
|
|
<p>
|
|
|
(<em>Appears on:</em>
|
|
|
<a href="#external-secrets.io/v1alpha1.SecretStoreProvider">SecretStoreProvider</a>)
|
|
|
</p>
|
|
|
<p>
|
|
|
-<p>AWSSMProvider configures a store to sync secrets using the AWS Secret Manager provider.</p>
|
|
|
+<p>AWSProvider configures a store to sync secrets using the AWS Secret Manager provider.</p>
|
|
|
</p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
@@ -102,10 +102,23 @@ github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>
|
|
|
+<code>service</code></br>
|
|
|
+<em>
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSServiceType">
|
|
|
+AWSServiceType
|
|
|
+</a>
|
|
|
+</em>
|
|
|
+</td>
|
|
|
+<td>
|
|
|
+<p>Service defines which service should be used to fetch the secrets</p>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr>
|
|
|
+<td>
|
|
|
<code>auth</code></br>
|
|
|
<em>
|
|
|
-<a href="#external-secrets.io/v1alpha1.AWSSMAuth">
|
|
|
-AWSSMAuth
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSAuth">
|
|
|
+AWSAuth
|
|
|
</a>
|
|
|
</em>
|
|
|
</td>
|
|
|
@@ -141,6 +154,32 @@ string
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
+<h3 id="external-secrets.io/v1alpha1.AWSServiceType">AWSServiceType
|
|
|
+(<code>string</code> alias)</p></h3>
|
|
|
+<p>
|
|
|
+(<em>Appears on:</em>
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSProvider">AWSProvider</a>)
|
|
|
+</p>
|
|
|
+<p>
|
|
|
+<p>AWSServiceType is a enum that defines the service/API that is used to fetch the secrets</p>
|
|
|
+</p>
|
|
|
+<table>
|
|
|
+<thead>
|
|
|
+<tr>
|
|
|
+<th>Value</th>
|
|
|
+<th>Description</th>
|
|
|
+</tr>
|
|
|
+</thead>
|
|
|
+<tbody><tr><td><p>"ParameterStore"</p></td>
|
|
|
+<td><p>AWSServiceParameterStore is the AWS SystemsManager ParameterStore
|
|
|
+see: <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html">https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html</a></p>
|
|
|
+</td>
|
|
|
+</tr><tr><td><p>"SecretsManager"</p></td>
|
|
|
+<td><p>AWSServiceSecretsManager is the AWS SecretsManager
|
|
|
+see: <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html">https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html</a></p>
|
|
|
+</td>
|
|
|
+</tr></tbody>
|
|
|
+</table>
|
|
|
<h3 id="external-secrets.io/v1alpha1.ClusterSecretStore">ClusterSecretStore
|
|
|
</h3>
|
|
|
<p>
|
|
|
@@ -280,15 +319,15 @@ ExternalSecretTarget
|
|
|
<td>
|
|
|
<code>refreshInterval</code></br>
|
|
|
<em>
|
|
|
-string
|
|
|
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
|
|
|
+Kubernetes meta/v1.Duration
|
|
|
+</a>
|
|
|
</em>
|
|
|
</td>
|
|
|
<td>
|
|
|
-<em>(Optional)</em>
|
|
|
-<p>RefreshInterval is the amount of time before the values reading again from the SecretStore provider
|
|
|
-Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h” (from time.ParseDuration)
|
|
|
-May be set to zero to fetch and create it once
|
|
|
-TODO: Default to some value?</p>
|
|
|
+<p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
|
|
|
+Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
|
|
|
+May be set to zero to fetch and create it once. Defaults to 1h.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
@@ -524,15 +563,15 @@ ExternalSecretTarget
|
|
|
<td>
|
|
|
<code>refreshInterval</code></br>
|
|
|
<em>
|
|
|
-string
|
|
|
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta">
|
|
|
+Kubernetes meta/v1.Duration
|
|
|
+</a>
|
|
|
</em>
|
|
|
</td>
|
|
|
<td>
|
|
|
-<em>(Optional)</em>
|
|
|
-<p>RefreshInterval is the amount of time before the values reading again from the SecretStore provider
|
|
|
-Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h” (from time.ParseDuration)
|
|
|
-May be set to zero to fetch and create it once
|
|
|
-TODO: Default to some value?</p>
|
|
|
+<p>RefreshInterval is the amount of time before the values are read again from the SecretStore provider
|
|
|
+Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”
|
|
|
+May be set to zero to fetch and create it once. Defaults to 1h.</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
@@ -825,6 +864,12 @@ map[string]string
|
|
|
<p>GenericStore is a common interface for interacting with ClusterSecretStore
|
|
|
or a namespaced SecretStore.</p>
|
|
|
</p>
|
|
|
+<h3 id="external-secrets.io/v1alpha1.ProviderIdentity">ProviderIdentity
|
|
|
+</h3>
|
|
|
+<p>
|
|
|
+<p>ProviderIdentity returns the name of a secret store provider
|
|
|
+this interface must be implemented by every provider</p>
|
|
|
+</p>
|
|
|
<h3 id="external-secrets.io/v1alpha1.SecretStore">SecretStore
|
|
|
</h3>
|
|
|
<p>
|
|
|
@@ -946,16 +991,16 @@ SecretStoreStatus
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>
|
|
|
-<code>awssm</code></br>
|
|
|
+<code>aws</code></br>
|
|
|
<em>
|
|
|
-<a href="#external-secrets.io/v1alpha1.AWSSMProvider">
|
|
|
-AWSSMProvider
|
|
|
+<a href="#external-secrets.io/v1alpha1.AWSProvider">
|
|
|
+AWSProvider
|
|
|
</a>
|
|
|
</em>
|
|
|
</td>
|
|
|
<td>
|
|
|
<em>(Optional)</em>
|
|
|
-<p>AWSSM configures this store to sync secrets using AWS Secret Manager provider</p>
|
|
|
+<p>AWS configures this store to sync secrets using AWS Secret Manager provider</p>
|
|
|
</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
@@ -1158,25 +1203,6 @@ Kubernetes meta/v1.Time
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
-<h3 id="external-secrets.io/v1alpha1.StoreProvider">StoreProvider
|
|
|
-(<code>string</code> alias)</p></h3>
|
|
|
-<p>
|
|
|
-</p>
|
|
|
-<table>
|
|
|
-<thead>
|
|
|
-<tr>
|
|
|
-<th>Value</th>
|
|
|
-<th>Description</th>
|
|
|
-</tr>
|
|
|
-</thead>
|
|
|
-<tbody><tr><td><p>"AWSSM"</p></td>
|
|
|
-<td></td>
|
|
|
-</tr><tr><td><p>"GCPSM"</p></td>
|
|
|
-<td></td>
|
|
|
-</tr><tr><td><p>"VAULT"</p></td>
|
|
|
-<td></td>
|
|
|
-</tr></tbody>
|
|
|
-</table>
|
|
|
<hr/>
|
|
|
<p><em>
|
|
|
Generated with <code>gen-crd-api-reference-docs</code>.
|