Browse Source

Deployed c19175a75 to main with MkDocs 1.6.1 and mike 1.2.0.dev0

Skarlso 5 months ago
parent
commit
ca32f64e49

+ 65 - 0
main/api/spec/index.html

@@ -6919,6 +6919,53 @@ External Secrets meta/v1.SecretKeySelector
 </tr>
 </tr>
 </tbody>
 </tbody>
 </table>
 </table>
+<h3 id="external-secrets.io/v1.CacheConfig">CacheConfig
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#external-secrets.io/v1.OnePasswordSDKProvider">OnePasswordSDKProvider</a>)
+</p>
+<p>
+<p>CacheConfig configures client-side caching for read operations.</p>
+</p>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>ttl</code></br>
+<em>
+<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
+Kubernetes meta/v1.Duration
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>TTL is the time-to-live for cached secrets.
+Format: duration string (e.g., &ldquo;5m&rdquo;, &ldquo;1h&rdquo;, &ldquo;30s&rdquo;)</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>maxSize</code></br>
+<em>
+int
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>MaxSize is the maximum number of secrets to cache.
+When the cache is full, least-recently-used entries are evicted.</p>
+</td>
+</tr>
+</tbody>
+</table>
 <h3 id="external-secrets.io/v1.CertAuth">CertAuth
 <h3 id="external-secrets.io/v1.CertAuth">CertAuth
 </h3>
 </h3>
 <p>
 <p>
@@ -12668,6 +12715,24 @@ OnePasswordSDKAuth
 <p>Auth defines the information necessary to authenticate against OnePassword API.</p>
 <p>Auth defines the information necessary to authenticate against OnePassword API.</p>
 </td>
 </td>
 </tr>
 </tr>
+<tr>
+<td>
+<code>cache</code></br>
+<em>
+<a href="#external-secrets.io/v1.CacheConfig">
+CacheConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Cache configures client-side caching for read operations (GetSecret, GetSecretMap).
+When enabled, secrets are cached with the specified TTL.
+Write operations (PushSecret, DeleteSecret) automatically invalidate relevant cache entries.
+If omitted, caching is disabled (default).
+cache: {} is a valid option to set.</p>
+</td>
+</tr>
 </tbody>
 </tbody>
 </table>
 </table>
 <h3 id="external-secrets.io/v1.OracleAuth">OracleAuth
 <h3 id="external-secrets.io/v1.OracleAuth">OracleAuth

+ 45 - 0
main/provider/1password-sdk/index.html

@@ -3543,6 +3543,17 @@
     </span>
     </span>
   </a>
   </a>
   
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#client-side-caching" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Client-Side Caching
+      
+    </span>
+  </a>
+  
 </li>
 </li>
         
         
           <li class="md-nav__item">
           <li class="md-nav__item">
@@ -4906,6 +4917,17 @@
     </span>
     </span>
   </a>
   </a>
   
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#client-side-caching" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Client-Side Caching
+      
+    </span>
+  </a>
+  
 </li>
 </li>
         
         
           <li class="md-nav__item">
           <li class="md-nav__item">
@@ -4995,6 +5017,29 @@ that has the same title as another label we won't know which one to update and a
 <span class="w">        </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">integration-info</span>
 <span class="w">        </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">integration-info</span>
 <span class="w">        </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
 <span class="w">        </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
 </code></pre></div>
 </code></pre></div>
+<h3 id="client-side-caching">Client-Side Caching</h3>
+<p>Optional client-side caching reduces 1Password API calls. Configure TTL and cache size in the store:</p>
+<div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1</span>
+<span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
+<span class="nt">metadata</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1password-cached</span>
+<span class="nt">spec</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">provider</span><span class="p">:</span>
+<span class="w">    </span><span class="nt">onepasswordSDK</span><span class="p">:</span>
+<span class="w">      </span><span class="nt">vault</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">production</span>
+<span class="w">      </span><span class="nt">auth</span><span class="p">:</span>
+<span class="w">        </span><span class="nt">serviceAccountSecretRef</span><span class="p">:</span>
+<span class="w">          </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">op-token</span>
+<span class="w">          </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">token</span>
+<span class="w">      </span><span class="nt">cache</span><span class="p">:</span>
+<span class="w">        </span><span class="nt">ttl</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5m</span><span class="w">      </span><span class="c1"># Optional, default: 5m</span>
+<span class="w">        </span><span class="nt">maxSize</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">100</span><span class="w"> </span><span class="c1"># Optional, default: 100</span>
+</code></pre></div>
+<p>Caching applies to read operations (<code>GetSecret</code>, <code>GetSecretMap</code>). Write operations (<code>PushSecret</code>, <code>DeleteSecret</code>) automatically invalidate relevant cache entries.</p>
+<div class="admonition warning">
+<p class="admonition-title">Experimental</p>
+<p>This is an experimental feature and if too long of a TTL is set, secret information might be out of date.</p>
+</div>
 <h3 id="getsecret">GetSecret</h3>
 <h3 id="getsecret">GetSecret</h3>
 <p>Valid secret references should use the following key format: <code>&lt;item&gt;/[section/]&lt;field&gt;</code>.</p>
 <p>Valid secret references should use the following key format: <code>&lt;item&gt;/[section/]&lt;field&gt;</code>.</p>
 <p>This is described here: <a href="https://developer.1password.com/docs/cli/secret-reference-syntax/">Secret Reference Syntax</a>.</p>
 <p>This is described here: <a href="https://developer.1password.com/docs/cli/secret-reference-syntax/">Secret Reference Syntax</a>.</p>

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


BIN
main/sitemap.xml.gz


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