mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2025-08-22 14:01:51 -07:00
Update docs for main
This commit is contained in:
parent
fd9eb8d6a7
commit
1a2935b0b4
17 changed files with 177 additions and 175 deletions
|
@ -103,8 +103,8 @@
|
|||
<h2>Continuous integration<a class="headerlink" href="#continuous-integration" title="Permalink to this heading"></a></h2>
|
||||
<p>The collection is tested with a <a class="reference external" href="https://github.com/ansible-community/molecule">molecule</a> setup covering the included roles and verifying correct installation and idempotency.
|
||||
In order to run the molecule tests locally with python 3.9 available, after cloning the repository:</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">molecule test --all</span><span class="w"></span>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">molecule test --all</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
|
@ -123,22 +123,22 @@ A clustered multi-regional installation of keycloak with infinispan remote cache
|
|||
<section id="test-playbooks">
|
||||
<h2>Test playbooks<a class="headerlink" href="#test-playbooks" title="Permalink to this heading"></a></h2>
|
||||
<p>Sample playbooks are provided in the <code class="docutils literal notranslate"><span class="pre">playbooks/</span></code> directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows:</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># setup environment</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">pip install ansible-core</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># clone the repository</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">git clone https://github.com/ansible-middleware/keycloak</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">cd keycloak</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># install collection dependencies</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install -r requirements.yml</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># install collection python deps</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">pip install -r requirements.txt</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># create inventory for localhost</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">cat << EOF > inventory</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">[keycloak]</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">localhost ansible_connection=local</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">EOF</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># run the playbook</span><span class="w"></span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ansible-playbook -i inventory playbooks/keycloak.yml</span><span class="w"></span>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># setup environment</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">pip install ansible-core</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># clone the repository</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">git clone https://github.com/ansible-middleware/keycloak</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">cd keycloak</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># install collection dependencies</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install -r requirements.yml</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># install collection python deps</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">pip install -r requirements.txt</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># create inventory for localhost</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">cat << EOF > inventory</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">[keycloak]</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">localhost ansible_connection=local</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">EOF</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain"># run the playbook</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ansible-playbook -i inventory playbooks/keycloak.yml</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
|
@ -155,7 +155,7 @@ A clustered multi-regional installation of keycloak with infinispan remote cache
|
|||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2022, Red Hat, Inc..</p>
|
||||
<p>© Copyright 2023, Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue