mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2025-07-24 13:50:33 -07:00
Update docs for main
This commit is contained in:
github-actions
parent
ab2902304b
commit
deceee4e97
22 changed files with 1014 additions and 1005 deletions
|
|
@ -15,6 +15,7 @@
|
|||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
|
|
@ -106,20 +107,20 @@
|
|||
<div itemprop="articleBody">
|
||||
|
||||
<section id="ansible-collection-middleware-automation-keycloak">
|
||||
<h1>Ansible Collection - middleware_automation.keycloak<a class="headerlink" href="#ansible-collection-middleware-automation-keycloak" title="Permalink to this headline"></a></h1>
|
||||
<h1>Ansible Collection - middleware_automation.keycloak<a class="headerlink" href="#ansible-collection-middleware-automation-keycloak" title="Permalink to this heading"></a></h1>
|
||||
<p><a class="reference external" href="https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml"><img alt="Build Status" src="https://github.com/ansible-middleware/keycloak/workflows/CI/badge.svg?branch=main" /></a></p>
|
||||
<p>Collection to install and configure <a class="reference external" href="https://www.keycloak.org/">Keycloak</a> or <a class="reference external" href="https://access.redhat.com/products/red-hat-single-sign-on">Red Hat Single Sign-On</a>.</p>
|
||||
<!--start requires_ansible-->
|
||||
<section id="ansible-version-compatibility">
|
||||
<h2>Ansible version compatibility<a class="headerlink" href="#ansible-version-compatibility" title="Permalink to this headline"></a></h2>
|
||||
<h2>Ansible version compatibility<a class="headerlink" href="#ansible-version-compatibility" title="Permalink to this heading"></a></h2>
|
||||
<p>This collection has been tested against following Ansible versions: <strong>>=2.9.10</strong>.</p>
|
||||
<p>Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.</p>
|
||||
<!--end requires_ansible-->
|
||||
</section>
|
||||
<section id="installation">
|
||||
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
|
||||
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h2>
|
||||
<section id="installing-the-collection-from-ansible-galaxy">
|
||||
<h3>Installing the Collection from Ansible Galaxy<a class="headerlink" href="#installing-the-collection-from-ansible-galaxy" title="Permalink to this headline"></a></h3>
|
||||
<h3>Installing the Collection from Ansible Galaxy<a class="headerlink" href="#installing-the-collection-from-ansible-galaxy" title="Permalink to this heading"></a></h3>
|
||||
<p>Before using the collection, you need to install it with the Ansible Galaxy CLI:</p>
|
||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ansible-galaxy collection install middleware_automation.keycloak
|
||||
</pre></div>
|
||||
|
|
@ -140,7 +141,7 @@
|
|||
</div>
|
||||
</section>
|
||||
<section id="included-roles">
|
||||
<h3>Included roles<a class="headerlink" href="#included-roles" title="Permalink to this headline"></a></h3>
|
||||
<h3>Included roles<a class="headerlink" href="#included-roles" title="Permalink to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md"><code class="docutils literal notranslate"><span class="pre">keycloak</span></code></a>: role for installing the service.</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md"><code class="docutils literal notranslate"><span class="pre">keycloak_realm</span></code></a>: role for configuring a realm, user federation(s), clients and users, in an installed service.</p></li>
|
||||
|
|
@ -149,9 +150,9 @@
|
|||
</section>
|
||||
</section>
|
||||
<section id="usage">
|
||||
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
|
||||
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
|
||||
<section id="install-playbook">
|
||||
<h3>Install Playbook<a class="headerlink" href="#install-playbook" title="Permalink to this headline"></a></h3>
|
||||
<h3>Install Playbook<a class="headerlink" href="#install-playbook" title="Permalink to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak.yml"><code class="docutils literal notranslate"><span class="pre">playbooks/keycloak.yml</span></code></a> installs the upstream(Keycloak) based on the defined variables.</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/playbooks/rhsso.yml"><code class="docutils literal notranslate"><span class="pre">playbooks/rhsso.yml</span></code></a> installs Red Hat Single Sign-On(RHSSO) based on defined variables.</p></li>
|
||||
|
|
@ -160,15 +161,15 @@
|
|||
<p>For full service configuration details, refer to the <a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md">keycloak role README</a>.</p>
|
||||
</section>
|
||||
<section id="choosing-between-upstream-project-keycloak-and-red-hat-single-sign-on-rhsso">
|
||||
<h3>Choosing between upstream project (Keycloak) and Red Hat Single Sign-On (RHSSO)<a class="headerlink" href="#choosing-between-upstream-project-keycloak-and-red-hat-single-sign-on-rhsso" title="Permalink to this headline"></a></h3>
|
||||
<h3>Choosing between upstream project (Keycloak) and Red Hat Single Sign-On (RHSSO)<a class="headerlink" href="#choosing-between-upstream-project-keycloak-and-red-hat-single-sign-on-rhsso" title="Permalink to this heading"></a></h3>
|
||||
<p>The general flag <code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_enable</span></code> controls what to install between upstream (Keycloak, when <code class="docutils literal notranslate"><span class="pre">False</span></code>) or Red Hat Single Sign-On (when <code class="docutils literal notranslate"><span class="pre">True</span></code>).
|
||||
The default value for the flag if <code class="docutils literal notranslate"><span class="pre">True</span></code> when Red Hat Network credentials are defined, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
|
||||
<section id="install-upstream-keycloak-from-keycloak-releases">
|
||||
<h4>Install upstream (Keycloak) from keycloak releases<a class="headerlink" href="#install-upstream-keycloak-from-keycloak-releases" title="Permalink to this headline"></a></h4>
|
||||
<h4>Install upstream (Keycloak) from keycloak releases<a class="headerlink" href="#install-upstream-keycloak-from-keycloak-releases" title="Permalink to this heading"></a></h4>
|
||||
<p>This is the default approach when RHN credentials are not defined. Keycloak is downloaded from keycloak builds (hosted on github.com) locally, and distributed to target nodes.</p>
|
||||
</section>
|
||||
<section id="install-rhsso-from-the-red-hat-customer-support-portal">
|
||||
<h4>Install RHSSO from the Red Hat Customer Support Portal<a class="headerlink" href="#install-rhsso-from-the-red-hat-customer-support-portal" title="Permalink to this headline"></a></h4>
|
||||
<h4>Install RHSSO from the Red Hat Customer Support Portal<a class="headerlink" href="#install-rhsso-from-the-red-hat-customer-support-portal" title="Permalink to this heading"></a></h4>
|
||||
<p>Define the credentials as follows, and the default behaviour is to download a fresh archive of RHSSO on the controller node, then distribute to target nodes.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">rhn_username</span><span class="p">:</span><span class="w"> </span><span class="s">'<customer_portal_username>'</span><span class="w"></span>
|
||||
<span class="nt">rhn_password</span><span class="p">:</span><span class="w"> </span><span class="s">'<customer_portal_password>'</span><span class="w"></span>
|
||||
|
|
@ -177,7 +178,7 @@ The default value for the flag if <code class="docutils literal notranslate"><sp
|
|||
</div>
|
||||
</section>
|
||||
<section id="install-from-controller-node-local-source">
|
||||
<h4>Install from controller node (local source)<a class="headerlink" href="#install-from-controller-node-local-source" title="Permalink to this headline"></a></h4>
|
||||
<h4>Install from controller node (local source)<a class="headerlink" href="#install-from-controller-node-local-source" title="Permalink to this heading"></a></h4>
|
||||
<p>Making the keycloak zip archive (or the RHSSO zip archive), available to the playbook repository root directory, and setting <code class="docutils literal notranslate"><span class="pre">keycloak_offline_install</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>, allows to skip
|
||||
the download tasks. The local path for the archive matches the downloaded archive path, so it is also used as a cache when multiple hosts are provisioned in a cluster.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">keycloak_offline_install</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
|
|
@ -190,7 +191,7 @@ the download tasks. The local path for the archive matches the downloaded archiv
|
|||
</ul>
|
||||
</section>
|
||||
<section id="install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc">
|
||||
<h4>Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)<a class="headerlink" href="#install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc" title="Permalink to this headline"></a></h4>
|
||||
<h4>Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)<a class="headerlink" href="#install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc" title="Permalink to this heading"></a></h4>
|
||||
<p>For RHSSO:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">keycloak_rhsso_enable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="nt">keycloak_rhsso_download_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://<internal-nexus.private.net>/<path>/<to>/rh-sso-x.y.z-server-dist.zip"</span><span class="w"></span>
|
||||
|
|
@ -204,7 +205,7 @@ the download tasks. The local path for the archive matches the downloaded archiv
|
|||
</section>
|
||||
</section>
|
||||
<section id="example-installation-command">
|
||||
<h3>Example installation command<a class="headerlink" href="#example-installation-command" title="Permalink to this headline"></a></h3>
|
||||
<h3>Example installation command<a class="headerlink" href="#example-installation-command" title="Permalink to this heading"></a></h3>
|
||||
<p>Execute the following command from the source root directory</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">ansible-playbook -i <ansible_hosts> -e @rhn-creds.yml playbooks/keycloak.yml -e keycloak_admin_password=<changeme></span><span class="w"></span>
|
||||
</pre></div>
|
||||
|
|
@ -221,13 +222,13 @@ the download tasks. The local path for the archive matches the downloaded archiv
|
|||
</section>
|
||||
</section>
|
||||
<section id="configuration">
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
|
||||
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading"></a></h2>
|
||||
<section id="config-playbook">
|
||||
<h3>Config Playbook<a class="headerlink" href="#config-playbook" title="Permalink to this headline"></a></h3>
|
||||
<h3>Config Playbook<a class="headerlink" href="#config-playbook" title="Permalink to this heading"></a></h3>
|
||||
<p><a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm.yml"><code class="docutils literal notranslate"><span class="pre">playbooks/keycloak_realm.yml</span></code></a> creates or updates provided realm, user federation(s), client(s), client role(s) and client user(s).</p>
|
||||
</section>
|
||||
<section id="example-configuration-command">
|
||||
<h3>Example configuration command<a class="headerlink" href="#example-configuration-command" title="Permalink to this headline"></a></h3>
|
||||
<h3>Example configuration command<a class="headerlink" href="#example-configuration-command" title="Permalink to this heading"></a></h3>
|
||||
<p>Execute the following command from the source root directory:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e <span class="nv">keycloak_admin_password</span><span class="o">=</span><changeme> -e <span class="nv">keycloak_realm</span><span class="o">=</span><span class="nb">test</span>
|
||||
</pre></div>
|
||||
|
|
@ -246,11 +247,11 @@ the download tasks. The local path for the archive matches the downloaded archiv
|
|||
</section>
|
||||
</section>
|
||||
<section id="support">
|
||||
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline"></a></h2>
|
||||
<h2>Support<a class="headerlink" href="#support" title="Permalink to this heading"></a></h2>
|
||||
<p>Keycloak collection v1.0.0 is a Beta release and for <a class="reference external" href="https://access.redhat.com/support/offerings/techpreview">Technical Preview</a>. If you have any issues or questions related to collection, please don’t hesitate to contact us on Ansible-middleware-core@redhat.com or open an issue on https://github.com/ansible-middleware/keycloak/issues</p>
|
||||
</section>
|
||||
<section id="license">
|
||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
|
||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
||||
<p>Apache License v2.0 or later</p>
|
||||
<p>See <span class="xref myst">LICENSE</span> to view the full text.</p>
|
||||
</section>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue