Browse Source

Deployed 027f28e to main with MkDocs 1.2.3 and mike 1.1.2

Docs 4 years ago
parent
commit
f16ee65487

+ 21 - 7
main/provider-oracle-vault/index.html

@@ -1321,7 +1321,9 @@
 <h2 id="oracle-vault">Oracle Vault</h2>
 <p>External Secrets Operator integrates with <a href="https://github.com/oracle/oci-go-sdk">OCI API</a> to sync secret on the Oracle Vault to secrets held on the Kubernetes cluster.</p>
 <h3 id="authentication">Authentication</h3>
-<p>The API requires a userOCID, tenancyOCID, fingerprint, key file and a region. The fingerprint and key file should be supplied in the secret with the rest being provided in the secret store.</p>
+<p>If <code>auth</code> is not specified, the operator uses the instance principal.</p>
+<p>For using a specific user credentials, userOCID, tenancyOCID, fingerprint and private key are required.
+The fingerprint and key file should be supplied in the secret with the rest being provided in the secret store.</p>
 <p>See url for what region you you are accessing.
 <img alt="userOCID-details" src="../pictures/screenshot_region.png" /></p>
 <p>Select tenancy in the top right to see your user OCID as shown below.
@@ -1352,19 +1354,31 @@ This will automatically generate a fingerprint.
 <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
 <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
 <span class="nt">metadata</span><span class="p">:</span>
-  <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example</span>
+  <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-instance-principal</span>
+<span class="nt">spec</span><span class="p">:</span>
+  <span class="nt">provider</span><span class="p">:</span>
+    <span class="nt">oracle</span><span class="p">:</span>
+      <span class="nt">vault</span><span class="p">:</span> <span class="c1"># The vault OCID</span>
+      <span class="nt">region</span><span class="p">:</span> <span class="c1"># The vault region</span>
+
+<span class="nn">---</span>
+
+<span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
+<span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
+<span class="nt">metadata</span><span class="p">:</span>
+  <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-auth</span>
 <span class="nt">spec</span><span class="p">:</span>
   <span class="nt">provider</span><span class="p">:</span>
-    <span class="nt">oracle</span><span class="p">:</span> <span class="c1">#Needs to match value in secretstore_types.go</span>
+    <span class="nt">oracle</span><span class="p">:</span>
       <span class="nt">vault</span><span class="p">:</span> <span class="c1"># The vault OCID</span>
-      <span class="nt">user</span><span class="p">:</span>
-      <span class="nt">tenancy</span><span class="p">:</span>
-      <span class="nt">region</span><span class="p">:</span>
+      <span class="nt">region</span><span class="p">:</span> <span class="c1"># The vault region</span>
       <span class="nt">auth</span><span class="p">:</span>
+        <span class="nt">user</span><span class="p">:</span> <span class="c1"># A user OCID</span>
+        <span class="nt">tenancy</span><span class="p">:</span> <span class="c1"># A user&#39;s tenancy</span>
         <span class="nt">secretRef</span><span class="p">:</span>
           <span class="nt">privatekey</span><span class="p">:</span>
             <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oracle-secret</span>
-            <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">privateKey</span> <span class="c1">#Needs to match stringData val in secret_oracle.yml</span>
+            <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">privateKey</span>
           <span class="nt">fingerprint</span><span class="p">:</span>
             <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oracle-secret</span>
             <span class="nt">key</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">fingerprint</span>

File diff suppressed because it is too large
+ 0 - 0
main/search/search_index.json


+ 35 - 35
main/sitemap.xml

@@ -2,177 +2,177 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2022-02-08</lastmod>
+         <lastmod>2022-02-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>

BIN
main/sitemap.xml.gz


+ 18 - 6
main/snippets/oracle-secret-store.yaml

@@ -1,19 +1,31 @@
 apiVersion: external-secrets.io/v1alpha1
 kind: SecretStore
 metadata:
-  name: example
+  name: example-instance-principal
 spec:
   provider:
-    oracle: #Needs to match value in secretstore_types.go
+    oracle:
       vault: # The vault OCID
-      user:
-      tenancy:
-      region:
+      region: # The vault region
+
+---
+
+apiVersion: external-secrets.io/v1alpha1
+kind: SecretStore
+metadata:
+  name: example-auth
+spec:
+  provider:
+    oracle:
+      vault: # The vault OCID
+      region: # The vault region
       auth:
+        user: # A user OCID
+        tenancy: # A user's tenancy
         secretRef:
           privatekey:
             name: oracle-secret
-            key: privateKey #Needs to match stringData val in secret_oracle.yml
+            key: privateKey
           fingerprint:
             name: oracle-secret
             key: fingerprint

+ 33 - 31
main/spec/index.html

@@ -3145,6 +3145,28 @@ string
 <tbody>
 <tr>
 <td>
+<code>tenancy</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>Tenancy is the tenancy OCID where user is located.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>user</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>User is an access OCID specific to the account.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>secretRef</code></br>
 <em>
 <a href="#external-secrets.io/v1alpha1.OracleSecretRef">
@@ -3178,59 +3200,39 @@ backend.</p>
 <tbody>
 <tr>
 <td>
-<code>auth</code></br>
-<em>
-<a href="#external-secrets.io/v1alpha1.OracleAuth">
-OracleAuth
-</a>
-</em>
-</td>
-<td>
-<p>Auth configures how secret-manager authenticates with the Oracle Vault.</p>
-</td>
-</tr>
-<tr>
-<td>
-<code>user</code></br>
-<em>
-string
-</em>
-</td>
-<td>
-<p>User is an access OCID specific to the account.</p>
-</td>
-</tr>
-<tr>
-<td>
-<code>tenancy</code></br>
+<code>region</code></br>
 <em>
 string
 </em>
 </td>
 <td>
-<p>Tenancy is the tenancy OCID where secret is located.</p>
+<p>Region is the region where vault is located.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>region</code></br>
+<code>vault</code></br>
 <em>
 string
 </em>
 </td>
 <td>
-<p>Region is the region where secret is located.</p>
+<p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>vault</code></br>
+<code>auth</code></br>
 <em>
-string
+<a href="#external-secrets.io/v1alpha1.OracleAuth">
+OracleAuth
+</a>
 </em>
 </td>
 <td>
-<p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
+<em>(Optional)</em>
+<p>Auth configures how secret-manager authenticates with the Oracle Vault.
+If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
 </td>
 </tr>
 </tbody>

Some files were not shown because too many files changed in this diff