Skip to content

Commit 776bfe4

Browse files
github-actions[bot]github-actions[bot]
committed
Update documentation
0 parents  commit 776bfe4

File tree

297 files changed

+34038
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

297 files changed

+34038
-0
lines changed

‎.nojekyll‎

Whitespace-only changes.

‎README.html‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
5+
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>&lt;no title&gt; &mdash; Red Hat PSAP topsail toolbox git-main/ef3d279e documentation</title>
8+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10+
<!--[if lt IE 9]>
11+
<script src="_static/js/html5shiv.min.js"></script>
12+
<![endif]-->
13+
14+
<script src="_static/jquery.js?v=5d32c60e"></script>
15+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16+
<script src="_static/documentation_options.js?v=150e030c"></script>
17+
<script src="_static/doctools.js?v=9a2dae69"></script>
18+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
19+
<script src="_static/js/theme.js"></script>
20+
<link rel="index" title="Index" href="genindex.html" />
21+
<link rel="search" title="Search" href="search.html" />
22+
</head>
23+
24+
<body class="wy-body-for-nav">
25+
<div class="wy-grid-for-nav">
26+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
27+
<div class="wy-side-scroll">
28+
<div class="wy-side-nav-search" >
29+
30+
31+
32+
<a href="index.html" class="icon icon-home">
33+
Red Hat PSAP topsail toolbox
34+
</a>
35+
<div class="version">
36+
28, Sep 2025
37+
</div>
38+
<div role="search">
39+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
40+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
41+
<input type="hidden" name="check_keywords" value="yes" />
42+
<input type="hidden" name="area" value="default" />
43+
</form>
44+
</div>
45+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
46+
<p class="caption" role="heading"><span class="caption-text">General</span></p>
47+
<ul>
48+
<li class="toctree-l1"><a class="reference internal" href="intro.html">TOPSAIL</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
50+
</ul>
51+
<p class="caption" role="heading"><span class="caption-text">Understanding The Architecture</span></p>
52+
<ul>
53+
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html">The Test Orchestrations Layer</a></li>
54+
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html#the-ci-job-launchers">The CI job launchers</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html#topsail-configuration-system">TOPSAIL Configuration System</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="understanding/orchestration.html#calling-the-toolbox-commands">Calling the toolbox commands</a></li>
57+
<li class="toctree-l1"><a class="reference internal" href="understanding/toolbox.html">The Reusable Toolbox Layer</a></li>
58+
<li class="toctree-l1"><a class="reference internal" href="understanding/visualization.html">The Post-mortem Processing &amp; Visualization Layer</a></li>
59+
</ul>
60+
<p class="caption" role="heading"><span class="caption-text">Extending The Architecture</span></p>
61+
<ul>
62+
<li class="toctree-l1"><a class="reference internal" href="extending/orchestration.html">Creating a New Orchestration</a></li>
63+
<li class="toctree-l1"><a class="reference internal" href="extending/toolbox.html">How roles are organized</a></li>
64+
<li class="toctree-l1"><a class="reference internal" href="extending/toolbox.html#how-default-parameters-are-generated">How default parameters are generated</a></li>
65+
<li class="toctree-l1"><a class="reference internal" href="extending/visualization.html">Creating a new visualization module</a></li>
66+
</ul>
67+
<p class="caption" role="heading"><span class="caption-text">TOPSAIL's Toolbox</span></p>
68+
<ul>
69+
<li class="toctree-l1"><a class="reference internal" href="toolbox.generated/index.html">Toolbox Documentation</a></li>
70+
</ul>
71+
72+
</div>
73+
</div>
74+
</nav>
75+
76+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
77+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
78+
<a href="index.html">Red Hat PSAP topsail toolbox</a>
79+
</nav>
80+
81+
<div class="wy-nav-content">
82+
<div class="rst-content">
83+
<div role="navigation" aria-label="Page navigation">
84+
<ul class="wy-breadcrumbs">
85+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
86+
<li class="breadcrumb-item active">&lt;no title&gt;</li>
87+
<li class="wy-breadcrumbs-aside">
88+
<a href="_sources/README.rst.txt" rel="nofollow"> View page source</a>
89+
</li>
90+
</ul>
91+
<hr/>
92+
</div>
93+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
94+
<div itemprop="articleBody">
95+
96+
<p>See the rendered version of TOPSAIL’s documentation at this address:</p>
97+
<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>
98+
99+
100+
</div>
101+
</div>
102+
<footer>
103+
104+
<hr/>
105+
106+
<div role="contentinfo">
107+
<p>&#169; Copyright 2021, Red Hat PSAP team.</p>
108+
</div>
109+
110+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
111+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
112+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
113+
114+
115+
</footer>
116+
</div>
117+
</div>
118+
</section>
119+
</div>
120+
<script>
121+
jQuery(function () {
122+
SphinxRtdTheme.Navigation.enable(true);
123+
});
124+
</script>
125+
126+
</body>
127+
</html>

‎_sources/README.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:orphan:
2+
3+
See the rendered version of TOPSAIL's documentation at this address:
4+
5+
> https://openshift-psap.github.io/topsail/index.html

‎_sources/contributing.rst.txt‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
Contributing
2+
============
3+
4+
Thanks for taking the time to contribute!
5+
6+
The following is a set of guidelines for contributing to ``TOPSAIL``.
7+
These are mostly guidelines, feel free to propose changes to this
8+
document in a pull request.
9+
10+
---
11+
12+
The primary goal of the repository is to serve as a central repository
13+
of the PSAP team's performance and scale test automation.
14+
15+
The secondary goal of the repository is to offer a toolbox for setting
16+
up and configuring clusters, in preparation of performance and scale test execution.
17+
18+
19+
Pull Request Guidelines
20+
-----------------------
21+
22+
- Pull Requests (PRs) need to be ``/approve`` and reviewed ``/lgtm`` by
23+
PSAP team members before being merged.
24+
25+
- PRs should have a proper description explaining the problem being
26+
solved, or the new feature being introduced.
27+
28+
29+
Review Guidelines
30+
-----------------
31+
32+
- Reviews can be performed by anyone interested in the good health of
33+
the repository; but approval and/or ``/lgtm`` is reserved to PSAP
34+
team members at the moment.
35+
36+
- The main merging criteria is to have a successful test run that
37+
executes the modified code. Because of the nature of the repository,
38+
we can't test all the code paths for all PRs.
39+
40+
- In order to save unnecessary AWS cloud time, the testing is not
41+
automatically executed by Prow; it must be manually triggered.
42+
43+
44+
Style Guidelines
45+
----------------
46+
47+
YAML style
48+
^^^^^^^^^^
49+
50+
* Align nested lists with their parent's label
51+
52+
.. code-block:: yaml
53+
54+
- block:
55+
- name: ...
56+
block:
57+
- name: ...
58+
59+
* YAML files use the `.yml` extension
60+
61+
Ansible style
62+
^^^^^^^^^^^^^
63+
64+
We strive to follow Ansible best practices in the different playbooks.
65+
66+
This command is executed as a GitHub-Action hook on all the new PRs,
67+
to help keeping a consistent code style:
68+
69+
.. code-block:: shell
70+
71+
ansible-lint -v --force-color -c config/ansible-lint.yml playbooks roles
72+
73+
* Try to avoid using ``shell`` tasks as much as possible
74+
75+
- Make sure that ``set -o pipefail;`` is part of the shell command
76+
whenever a ``|`` is involved (``ansible-lint`` forgets some of
77+
them)
78+
79+
- Redirection into a ``{{ artifact_extra_logs_dir }}`` file is a
80+
common exception
81+
82+
* Use inline stanza for ``debug`` and ``fail`` tasks, eg:
83+
84+
.. code-block:: yaml
85+
86+
- name: The GFD did not label the nodes
87+
fail: msg="The GFD did not label the nodes"
88+
89+
Coding guidelines
90+
-----------------
91+
92+
* Keep the main log file clean when everything goes right, and store
93+
all the relevant information in the ``{{ artifact_extra_logs_dir
94+
}}`` directory, eg:
95+
96+
.. code-block:: yaml
97+
98+
- name: Inspect the Subscriptions status (debug)
99+
shell:
100+
oc describe subscriptions.operators.coreos.com/gpu-operator-certified
101+
-n openshift-operators
102+
> {{ artifact_extra_logs_dir }}/gpu_operator_Subscription.log
103+
failed_when: false
104+
105+
* Include troubleshooting inspection commands whenever
106+
possible/relevant (see above for an example)
107+
108+
- mark them as ``failed_when: false`` to ensure that their execution
109+
doesn't affect the testing
110+
- add ``(debug)`` in the task name to make it clear that the command
111+
is not part of the proper testing.
112+
113+
* Use ``ignore_errors: true`` **only** for tracking **known
114+
failures**.
115+
116+
- use ``failed_when: false`` to ignore the task return code
117+
- but whenever possible, write tasks that do not fail, eg:
118+
119+
.. code-block:: yaml
120+
121+
oc delete --ignore-not-found=true $MY_RESOURCE
122+
123+
* Try to group related modifications in a dedicated commit, and stack
124+
commits in logical order (eg, 1/ add role, 2/ add toolbox script 3/
125+
integrate the toolbox scrip in the nightly CI)
126+
127+
- Commits are not squashed, so please avoid commits "fixing" another
128+
commit of the PR.
129+
- Hints: `git revise <https://github.com/mystor/git-revise>`_
130+
131+
* use ``git revise <commit>`` to modify an older commit (not
132+
older that ``master`` ;-)
133+
* use ``git revise --cut <commit>`` to split a commit in two
134+
logical commits
135+
* or simply use ``git commit --amend`` to modify the most recent commit

0 commit comments

Comments
 (0)