Skip to content

Commit

Permalink
deploy: c291624
Browse files Browse the repository at this point in the history
  • Loading branch information
@felixfontein
felixfontein committed Jun 23, 2024
1 parent a01b2c9 commit 63e2b7e
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 18 deletions.
9 changes: 9 additions & 0 deletions branch/main/environment_variables.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,15 @@
<a class="reference internal" href="sops_vars.html#ansible-collections-community-sops-sops-vars"><span class="std std-ref">community.sops.sops vars plugin</span></a></p>
</dd></dl>

<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS">
<span class="sig-name descname"><span class="pre">ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS</span></span><a class="headerlink" href="#envvar-ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS" title="Link to this definition"></a></dt>
<dd><p>Check all of these extensions when looking for ‘variable’ files.</p>
<p>These files must be SOPS encrypted YAML or JSON files. The plugin will produce errors when encountering files matching these extensions that are not SOPS encrypted. (This might change in a future version.)</p>
<p><em>Used by:</em>
<a class="reference internal" href="sops_vars.html#ansible-collections-community-sops-sops-vars"><span class="std std-ref">community.sops.sops vars plugin</span></a></p>
</dd></dl>

<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY">
<span class="sig-name descname"><span class="pre">SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY</span></span><a class="headerlink" href="#envvar-SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY" title="Link to this definition"></a></dt>
Expand Down
Binary file modified branch/main/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion branch/main/searchindex.js
View file

Large diffs are not rendered by default.

47 changes: 30 additions & 17 deletions branch/main/sops_vars.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ <h1>community.sops.sops vars – Loading sops-encrypted vars files<a class="head
<section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Load encrypted YAML files into corresponding groups/hosts in group_vars/ and host_vars/ directories.</p></li>
<li><p>Files are encrypted prior to reading, making this plugin an effective companion to host_group_vars plugin.</p></li>
<li><p>Files are restricted to .sops.yaml, .sops.yml, .sops.json extensions.</p></li>
<li><p>Load encrypted YAML files into corresponding groups/hosts in <code class="docutils literal notranslate"><span class="pre">group_vars/</span></code> and <code class="docutils literal notranslate"><span class="pre">host_vars/</span></code> directories.</p></li>
<li><p>Files are encrypted prior to reading, making this plugin an effective companion to <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/builtin/host_group_vars_vars.html#ansible-collections-ansible-builtin-host-group-vars-vars" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.builtin.host_group_vars</span></a> plugin.</p></li>
<li><p>Files are restricted to <code class="ansible-value docutils literal notranslate"><span class="pre">.sops.yaml</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">.sops.yml</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">.sops.json</span></code> extensions, unless configured otherwise with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-sops-sops-vars-parameter-valid-extensions"><span class="std std-ref"><span class="pre">_valid_extensions</span></span></a></strong></code>.</p></li>
<li><p>Hidden files are ignored.</p></li>
</ul>
</section>
Expand Down Expand Up @@ -205,9 +205,22 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
<div class="ansibleOptionAnchor" id="parameter-_valid_extensions"></div><p class="ansible-option-title" id="ansible-collections-community-sops-sops-vars-parameter-valid-extensions"><strong>_valid_extensions</strong></p>
<a class="ansibleOptionLink" href="#parameter-_valid_extensions" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Check all of these extensions when looking for ‘variable’ files which should be YAML or JSON or vaulted versions of these.</p>
<p>This affects vars_files, include_vars, inventory and vars plugins among others.</p>
<td><div class="ansible-option-cell"><p>Check all of these extensions when looking for ‘variable’ files.</p>
<p>These files must be SOPS encrypted YAML or JSON files. The plugin will produce errors when encountering files matching these extensions that are not SOPS encrypted. (This might change in a future version.)</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[&quot;.sops.yml&quot;,</span> <span class="pre">&quot;.sops.yaml&quot;,</span> <span class="pre">&quot;.sops.json&quot;]</span></code></p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul>
<li><p>INI entry:</p>
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">[</span><span class="nv">community.sops</span><span class="p p-Indicator">]</span>
<span class="l l-Scalar l-Scalar-Plain">valid_extensions = .sops.yml, .sops.yaml, .sops.json</span>
</pre></div>
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.7.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.7.0</em></p>
</li>
</ul>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
Expand All @@ -219,7 +232,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
<p>Will be set as the <code class="xref std std-envvar docutils literal notranslate"><span class="pre">SOPS_AGE_KEY</span></code> environment variable when calling sops.</p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul class="simple">
<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AGE_KEY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AGE_KEY</span></code></a></p></li>
<li><p>Environment variable: <span class="target" id="index-2"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AGE_KEY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AGE_KEY</span></code></a></p></li>
</ul>
</div></td>
</tr>
Expand All @@ -239,7 +252,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</pre></div>
</div>
</li>
<li><p>Environment variable: <span class="target" id="index-2"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AGE_KEYFILE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AGE_KEYFILE</span></code></a></p></li>
<li><p>Environment variable: <span class="target" id="index-3"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AGE_KEYFILE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AGE_KEYFILE</span></code></a></p></li>
</ul>
</div></td>
</tr>
Expand All @@ -259,7 +272,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-3"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_ACCESS_KEY_ID"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_ACCESS_KEY_ID</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-4"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_ACCESS_KEY_ID"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_ACCESS_KEY_ID</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand All @@ -281,7 +294,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-4"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_PROFILE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_PROFILE</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-5"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_PROFILE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_PROFILE</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand All @@ -296,7 +309,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
<p>Sets the environment variable <code class="xref std std-envvar docutils literal notranslate"><span class="pre">AWS_SECRET_ACCESS_KEY</span></code> for the sops call.</p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul>
<li><p>Environment variable: <span class="target" id="index-5"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_SECRET_ACCESS_KEY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_SECRET_ACCESS_KEY</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-6"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_SECRET_ACCESS_KEY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_SECRET_ACCESS_KEY</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand All @@ -318,7 +331,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-6"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_SESSION_TOKEN"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_SESSION_TOKEN</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-7"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_AWS_SESSION_TOKEN"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_AWS_SESSION_TOKEN</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand Down Expand Up @@ -346,7 +359,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</pre></div>
</div>
</li>
<li><p>Environment variable: <span class="target" id="index-7"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_VARS_SOPS_PLUGIN_CACHE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_VARS_SOPS_PLUGIN_CACHE</span></code></a></p></li>
<li><p>Environment variable: <span class="target" id="index-8"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_VARS_SOPS_PLUGIN_CACHE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_VARS_SOPS_PLUGIN_CACHE</span></code></a></p></li>
</ul>
</div></td>
</tr>
Expand All @@ -367,7 +380,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-8"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_CONFIG_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_CONFIG_PATH</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-9"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_CONFIG_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_CONFIG_PATH</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand All @@ -394,7 +407,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-9"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-10"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand All @@ -417,7 +430,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-10"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_KEYSERVICE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_KEYSERVICE</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-11"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_KEYSERVICE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_KEYSERVICE</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand All @@ -439,7 +452,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</div>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
<li><p>Environment variable: <span class="target" id="index-11"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_BINARY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_BINARY</span></code></a></p>
<li><p>Environment variable: <span class="target" id="index-12"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_SOPS_BINARY"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_SOPS_BINARY</span></code></a></p>
<p><em class="ansible-option-versionadded">added in community.sops 1.2.0</em></p>
</li>
</ul>
Expand Down Expand Up @@ -469,7 +482,7 @@ <h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a clas
</pre></div>
</div>
</li>
<li><p>Environment variable: <span class="target" id="index-12"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_VARS_SOPS_PLUGIN_STAGE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_VARS_SOPS_PLUGIN_STAGE</span></code></a></p></li>
<li><p>Environment variable: <span class="target" id="index-13"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_VARS_SOPS_PLUGIN_STAGE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_VARS_SOPS_PLUGIN_STAGE</span></code></a></p></li>
</ul>
</div></td>
</tr>
Expand Down

0 comments on commit 63e2b7e

Please sign in to comment.