Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Dec 1, 2024
0 parents commit 17fc6d8
Show file tree
Hide file tree
Showing 293 changed files with 34,431 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
127 changes: 127 additions & 0 deletions README.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>&lt;no title&gt; &mdash; Red Hat PSAP topsail toolbox git-main/c8e4b1e9 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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 PSAP topsail toolbox
</a>
<div class="version">
01, Dec 2024
</div>
<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">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">TOPSAIL</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Understanding The Architecture</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html">The Test Orchestrations Layer</a></li>
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html#the-ci-job-launchers">The CI job launchers</a></li>
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html#topsail-configuration-system">TOPSAIL Configuration System</a></li>
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html#calling-the-toolbox-commands">Calling the toolbox commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="understanding/toolbox.html">The Reusable Toolbox Layer</a></li>
<li class="toctree-l1"><a class="reference internal" href="understanding/visualization.html">The Post-mortem Processing &amp; Visualization Layer</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Extending The Architecture</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="extending/orchestration.html">Creating a New Orchestration</a></li>
<li class="toctree-l1"><a class="reference internal" href="extending/toolbox.html">How roles are organized</a></li>
<li class="toctree-l1"><a class="reference internal" href="extending/toolbox.html#how-default-parameters-are-generated">How default parameters are generated</a></li>
<li class="toctree-l1"><a class="reference internal" href="extending/visualization.html">Creating a new visualization module</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">TOPSAIL's Toolbox</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="toolbox.generated/index.html">Toolbox Documentation</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 PSAP topsail toolbox</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">&lt;no title&gt;</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.rst.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">

<p>See the rendered version of TOPSAIL’s documentation at this address:</p>
<p>&gt; <a class="reference external" href="https://openshift-psap.github.io/topsail/index.html">https://openshift-psap.github.io/topsail/index.html</a></p>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2021, Red Hat PSAP team.</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>
5 changes: 5 additions & 0 deletions _sources/README.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:orphan:

See the rendered version of TOPSAIL's documentation at this address:

> https://openshift-psap.github.io/topsail/index.html
135 changes: 135 additions & 0 deletions _sources/contributing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
Contributing
============

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to ``TOPSAIL``.
These are mostly guidelines, feel free to propose changes to this
document in a pull request.

---

The primary goal of the repository is to serve as a central repository
of the PSAP team's performance and scale test automation.

The secondary goal of the repository is to offer a toolbox for setting
up and configuring clusters, in preparation of performance and scale test execution.


Pull Request Guidelines
-----------------------

- Pull Requests (PRs) need to be ``/approve`` and reviewed ``/lgtm`` by
PSAP team members before being merged.

- PRs should have a proper description explaining the problem being
solved, or the new feature being introduced.


Review Guidelines
-----------------

- Reviews can be performed by anyone interested in the good health of
the repository; but approval and/or ``/lgtm`` is reserved to PSAP
team members at the moment.

- The main merging criteria is to have a successful test run that
executes the modified code. Because of the nature of the repository,
we can't test all the code paths for all PRs.

- In order to save unnecessary AWS cloud time, the testing is not
automatically executed by Prow; it must be manually triggered.


Style Guidelines
----------------

YAML style
^^^^^^^^^^

* Align nested lists with their parent's label

.. code-block:: yaml
- block:
- name: ...
block:
- name: ...
* YAML files use the `.yml` extension

Ansible style
^^^^^^^^^^^^^

We strive to follow Ansible best practices in the different playbooks.

This command is executed as a GitHub-Action hook on all the new PRs,
to help keeping a consistent code style:

.. code-block:: shell
ansible-lint -v --force-color -c config/ansible-lint.yml playbooks roles
* Try to avoid using ``shell`` tasks as much as possible

- Make sure that ``set -o pipefail;`` is part of the shell command
whenever a ``|`` is involved (``ansible-lint`` forgets some of
them)

- Redirection into a ``{{ artifact_extra_logs_dir }}`` file is a
common exception

* Use inline stanza for ``debug`` and ``fail`` tasks, eg:

.. code-block:: yaml
- name: The GFD did not label the nodes
fail: msg="The GFD did not label the nodes"
Coding guidelines
-----------------

* Keep the main log file clean when everything goes right, and store
all the relevant information in the ``{{ artifact_extra_logs_dir
}}`` directory, eg:

.. code-block:: yaml
- name: Inspect the Subscriptions status (debug)
shell:
oc describe subscriptions.operators.coreos.com/gpu-operator-certified
-n openshift-operators
> {{ artifact_extra_logs_dir }}/gpu_operator_Subscription.log
failed_when: false
* Include troubleshooting inspection commands whenever
possible/relevant (see above for an example)

- mark them as ``failed_when: false`` to ensure that their execution
doesn't affect the testing
- add ``(debug)`` in the task name to make it clear that the command
is not part of the proper testing.

* Use ``ignore_errors: true`` **only** for tracking **known
failures**.

- use ``failed_when: false`` to ignore the task return code
- but whenever possible, write tasks that do not fail, eg:

.. code-block:: yaml
oc delete --ignore-not-found=true $MY_RESOURCE
* Try to group related modifications in a dedicated commit, and stack
commits in logical order (eg, 1/ add role, 2/ add toolbox script 3/
integrate the toolbox scrip in the nightly CI)

- Commits are not squashed, so please avoid commits "fixing" another
commit of the PR.
- Hints: `git revise <https://github.com/mystor/git-revise>`_

* use ``git revise <commit>`` to modify an older commit (not
older that ``master`` ;-)
* use ``git revise --cut <commit>`` to split a commit in two
logical commits
* or simply use ``git commit --amend`` to modify the most recent commit
Loading

0 comments on commit 17fc6d8

Please sign in to comment.