Skip to content

Commit

Permalink
Update documentation for v0.9
Browse files Browse the repository at this point in the history
Auto-generated from baad21a by 'update-gh-pages.sh'
  • Loading branch information
Github committed Sep 6, 2024
1 parent 4049df6 commit 817901a
Show file tree
Hide file tree
Showing 41 changed files with 83 additions and 85 deletions.
2 changes: 1 addition & 1 deletion v0.9/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: 3d6215ea26c70d0cc7eee3b9f24afdf4
config: 7509bc5b879771c2dadf3ddb1fa678e8
tags: 645f666f9bcd5a90fca523b33c5a78b7
3 changes: 1 addition & 2 deletions v0.9/_sources/docs/installation.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ make cross-$type.$distro-$version
Similarly to `make packages`, this will build packages using a `Docker\*`
container. However, instead of building for your host, it will build them
for the specified distro. For instance `make cross-deb.ubuntu-18.04` will
build `deb` packages for `Ubuntu\* 18.04` and `make cross-rpm.centos-8` will
build `rpm` packages for `CentOS\* 8`
build `deb` packages for `Ubuntu\* 18.04`.

## Post-install configuration

Expand Down
4 changes: 2 additions & 2 deletions v0.9/_sources/docs/quick-start.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ First, install and setup cri-resource-manager.

### Install package

#### CentOS\*, Fedora\*, and SUSE\*
#### Fedora\*, and SUSE\*

```
CRIRM_VERSION=`curl -s "https://api.github.com/repos/intel/cri-resource-manager/releases/latest" | \
Expand Down Expand Up @@ -57,7 +57,7 @@ When integrating into an existing cluster you need to change kubelet to use
cri-resmgr instead of the existing container runtime (expecting containerd
here).

#### CentOS, Fedora, and SUSE
#### Fedora, and SUSE
```
sudo sed '/KUBELET_EXTRA_ARGS/ s!$! --container-runtime-endpoint=/var/run/cri-resmgr/cri-resmgr.sock!' -i /etc/sysconfig/kubelet
sudo systemctl restart kubelet
Expand Down
2 changes: 1 addition & 1 deletion v0.9/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.9.1',
VERSION: '0.0.0-1-gbaad21a',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Contributing &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/demos/blockio.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Block I/O Demo &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Block I/O Demo &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/demos/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Demos &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Demos &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/architecture.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Architecture &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Architecture &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/cri-test.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CRI Validation &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>CRI Validation &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/e2e-test.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>End-to-End tests &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>End-to-End tests &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Developer’s Guide &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Developer’s Guide &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/policy-writers-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Policy Writer’s Guide &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Policy Writer’s Guide &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/testing.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Testing &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Testing &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/developers-guide/unit-test.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Unit tests &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Unit tests &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to CRI Resource Manager’s documentation! &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Welcome to CRI Resource Manager’s documentation! &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

Expand Down Expand Up @@ -37,7 +37,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
9 changes: 4 additions & 5 deletions v0.9/docs/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Installation &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -121,7 +121,7 @@ <h2>Installing from sources<a class="headerlink" href="#installing-from-sources"
<li><p>get the sources: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/intel/cri-resource-manager</span></code></p></li>
<li><p>build and install: <code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">cri-resource-manager;</span> <span class="pre">make</span> <span class="pre">build</span> <span class="pre">&amp;&amp;</span> <span class="pre">sudo</span> <span class="pre">make</span> <span class="pre">install</span></code></p></li>
</ul>
<p>You will need at least <code class="docutils literal notranslate"><span class="pre">git</span></code>, <code class="docutils literal notranslate"><span class="pre">golang</span> <span class="pre">1.21</span></code> or newer,
<p>You will need at least <code class="docutils literal notranslate"><span class="pre">git</span></code>, <code class="docutils literal notranslate"><span class="pre">golang</span> <span class="pre">1.22.0</span></code> or newer,
<code class="docutils literal notranslate"><span class="pre">GNU</span> <span class="pre">make</span></code>, <code class="docutils literal notranslate"><span class="pre">bash</span></code>, <code class="docutils literal notranslate"><span class="pre">find</span></code>, <code class="docutils literal notranslate"><span class="pre">sed</span></code>, <code class="docutils literal notranslate"><span class="pre">head</span></code>, <code class="docutils literal notranslate"><span class="pre">date</span></code>, and <code class="docutils literal notranslate"><span class="pre">install</span></code> to be able to build and install
from sources.</p>
</section>
Expand Down Expand Up @@ -157,8 +157,7 @@ <h2>Building packages for another distro<a class="headerlink" href="#building-pa
<p>Similarly to <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">packages</span></code>, this will build packages using a <code class="docutils literal notranslate"><span class="pre">Docker\*</span></code>
container. However, instead of building for your host, it will build them
for the specified distro. For instance <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">cross-deb.ubuntu-18.04</span></code> will
build <code class="docutils literal notranslate"><span class="pre">deb</span></code> packages for <code class="docutils literal notranslate"><span class="pre">Ubuntu\*</span> <span class="pre">18.04</span></code> and <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">cross-rpm.centos-8</span></code> will
build <code class="docutils literal notranslate"><span class="pre">rpm</span></code> packages for <code class="docutils literal notranslate"><span class="pre">CentOS\*</span> <span class="pre">8</span></code></p>
build <code class="docutils literal notranslate"><span class="pre">deb</span></code> packages for <code class="docutils literal notranslate"><span class="pre">Ubuntu\*</span> <span class="pre">18.04</span></code>.</p>
</section>
<section id="post-install-configuration">
<h2>Post-install configuration<a class="headerlink" href="#post-install-configuration" title="Permalink to this heading"></a></h2>
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Introduction &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Introduction &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/migration-to-NRI.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Migrating from CRI-RM to NRI &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Migrating from CRI-RM to NRI &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/node-agent.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Node Agent &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Node Agent &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/policy/balloons.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Balloons Policy &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Balloons Policy &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/policy/blockio.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Block IO &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Block IO &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions v0.9/docs/policy/container-affinity.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Container Affinity and Anti-Affinity &mdash; CRI Resource Manager 0.9.1 documentation</title>
<title>Container Affinity and Anti-Affinity &mdash; CRI Resource Manager 0.0.0-1-gbaad21a documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

Expand Down Expand Up @@ -38,7 +38,7 @@
CRI Resource Manager
</a>
<div class="version">
v0.9.1
0.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
Loading

0 comments on commit 817901a

Please sign in to comment.