Skip to content

Commit

Permalink
update docs for 4.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
evgeni committed Jul 17, 2024
1 parent a5d8d76 commit 49158f5
Show file tree
Hide file tree
Showing 386 changed files with 146,524 additions and 1 deletion.
4 changes: 4 additions & 0 deletions 4.1.0/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8472ed6cac576841eb55f43f46fc81a2
tags: 645f666f9bcd5a90fca523b33c5a78b7
1,176 changes: 1,176 additions & 0 deletions 4.1.0/CHANGELOG.html
View file

Large diffs are not rendered by default.

210 changes: 210 additions & 0 deletions 4.1.0/README.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Red Hat Satellite Ansible Collection &mdash; Red Hat Satellite Ansible Collection documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Redhat.Satellite" href="plugins/index.html" />
<link rel="prev" title="Welcome to Red Hat Satellite Ansible Collection’ documentation!" href="index.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home">
Red Hat Satellite Ansible Collection
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Red Hat Satellite Ansible Collection</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#installation-from-automation-hub">Installation from Automation Hub</a></li>
<li class="toctree-l3"><a class="reference internal" href="#installation-via-rpm">Installation via RPM</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contributing">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#support">Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="#release-notes-and-roadmap">Release Notes and Roadmap</a></li>
<li class="toctree-l2"><a class="reference internal" href="#related-information">Related Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license-information">License Information</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Redhat.Satellite</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="cvmanager.html">Migrating from <code class="docutils literal notranslate"><span class="pre">cvmanager</span></code> to Red Hat Satellite Ansible Collection</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developing.html">How to write modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html"><code class="docutils literal notranslate"><span class="pre">foreman_helper</span></code> module</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing Foreman Ansible Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing the collection</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Red Hat Satellite Ansible Collection</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Red Hat Satellite Ansible Collection</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="red-hat-satellite-ansible-collection">
<h1>Red Hat Satellite Ansible Collection<a class="headerlink" href="#red-hat-satellite-ansible-collection" title="Link to this heading"></a></h1>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading"></a></h2>
<p>Ansible modules for interacting with the Satellite API.</p>
</section>
<section id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://pypi.org/project/PyYAML/"><code class="docutils literal notranslate"><span class="pre">PyYAML</span></code></a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/requests/"><code class="docutils literal notranslate"><span class="pre">requests</span></code></a></p></li>
<li><p>The Python <code class="docutils literal notranslate"><span class="pre">rpm</span></code> bindings for the RPM support in the <code class="docutils literal notranslate"><span class="pre">content_upload</span></code> module</p></li>
</ul>
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
<p>Before using this collection, you need to install it, either directly from Automation Hub or via RPMs provided by Red Hat.</p>
<p>The GitHub repository serves as the source for the release and should not be used for direct installation and consumption of the collection.</p>
<section id="installation-from-automation-hub">
<h3>Installation from Automation Hub<a class="headerlink" href="#installation-from-automation-hub" title="Link to this heading"></a></h3>
<p>To install it with the Ansible Galaxy command-line tool:</p>
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install redhat.satellite</span>
</pre></div>
</div>
<p>You can also include it in a requirements.yml file and install it with <code class="docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.yml</span></code>, using the format:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">collections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</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">redhat.satellite</span>
</pre></div>
</div>
<p>Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package.
To upgrade the collection to the latest available version, run the following command:</p>
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install redhat.satellite --upgrade</span>
</pre></div>
</div>
<p>You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 1.0.0:</p>
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install redhat.satellite:==1.0.0</span>
</pre></div>
</div>
<p>See <a class="reference external" href="https://docs.ansible.com/ansible/devel/user_guide/collections_using.html">using Ansible collections</a> for more details.</p>
</section>
<section id="installation-via-rpm">
<h3>Installation via RPM<a class="headerlink" href="#installation-via-rpm" title="Link to this heading"></a></h3>
<p>The collection is also available as <code class="docutils literal notranslate"><span class="pre">ansible-collection-redhat-satellite</span></code> in the Satellite repository.</p>
</section>
</section>
<section id="testing">
<h2>Testing<a class="headerlink" href="#testing" title="Link to this heading"></a></h2>
<p>This collection is tested against all currently maintained Ansible versions and with all currently supported (by Ansible on the target node) Python versions.
You can find the list of maintained Ansible versions and their respective Python versions on <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html">docs.ansible.com</a>.</p>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"></a></h2>
<p>This collection is based on the <a class="reference external" href="https://github.com/theforeman/foreman-ansible-modules"><code class="docutils literal notranslate"><span class="pre">theforeman.foreman</span></code></a> community collection for Foreman and Katello.
If possible, any contributions should go directly to <code class="docutils literal notranslate"><span class="pre">theforeman.foreman</span></code> from where they will flow back into this collection.</p>
</section>
<section id="support">
<h2>Support<a class="headerlink" href="#support" title="Link to this heading"></a></h2>
<p>For support questions around this collection, please open a ticket on the <a class="reference external" href="https://access.redhat.com">Red Hat Customer Portal</a>.</p>
</section>
<section id="release-notes-and-roadmap">
<h2>Release Notes and Roadmap<a class="headerlink" href="#release-notes-and-roadmap" title="Link to this heading"></a></h2>
<p>Please see the <a class="reference external" href="CHANGELOG.rst">changelog</a>.</p>
</section>
<section id="related-information">
<h2>Related Information<a class="headerlink" href="#related-information" title="Link to this heading"></a></h2>
<p>The official Satellite documentation can be found in the <a class="reference external" href="https://access.redhat.com/documentation/en-us/red_hat_satellite/">Product Documentation section of the Red Hat Customer Portal</a>.</p>
</section>
<section id="license-information">
<h2>License Information<a class="headerlink" href="#license-information" title="Link to this heading"></a></h2>
<p>This collection is licensed under the <a class="reference external" href="LICENSE">GNU GPL v3</a>.</p>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Red Hat Satellite Ansible Collection’ documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="plugins/index.html" class="btn btn-neutral float-right" title="Redhat.Satellite" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, Red Hat, Inc..</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 49158f5

Please sign in to comment.