Skip to content

Commit

Permalink
Auto-deployed update of 'docs/' for 'refs/tags/v0.7.2'
Browse files Browse the repository at this point in the history
  • Loading branch information
ghs-safl committed Nov 13, 2023
1 parent 16227ff commit 39e30c0
Show file tree
Hide file tree
Showing 431 changed files with 72,365 additions and 991 deletions.
2 changes: 1 addition & 1 deletion docs/latest/.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: 816478dc43b72e366c21064ee198395e
config: 6baf39fab14941c278f4f827466e4d9d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/latest/.doctrees/backends/xnvme_be_windows.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/capis/xnvme.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/capis/xnvme_cli.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/capis/xnvme_cmd.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/capis/xnvme_lba.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/capis/xnvme_opts.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/capis/xnvme_spec.doctree
Binary file not shown.
Binary file added docs/latest/.doctrees/ci/bench/index.doctree
Binary file not shown.
Binary file added docs/latest/.doctrees/ci/build/index.doctree
Binary file not shown.
Binary file added docs/latest/.doctrees/ci/index.doctree
Binary file not shown.
Binary file added docs/latest/.doctrees/ci/verify/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/contributing/index.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/latest/.doctrees/getting_started/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/getting_started/toolchain.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/file/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/lblk/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xdd/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/enum/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/feature-get/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/feature-set/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/format/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/idfy-ctrlr/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/idfy-ns/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/idfy/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/info/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/library-info/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/log-erri/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/log-health/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/log/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/padc/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/pioc/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/xnvme/sanitize/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tools/zoned/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tutorial/devs/index.doctree
Binary file not shown.
Binary file added docs/latest/.doctrees/tutorial/fdp/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tutorial/index.doctree
Binary file not shown.
Binary file modified docs/latest/.doctrees/tutorial/nvme/nvme_cmdsets.doctree
Binary file not shown.
Binary file added docs/latest/_images/xnvme-ci-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/_images/xnvme-ci-overview1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/_images/xnvme-ci-overview2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/latest/_sources/backends/xnvme_be_windows.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Toolchain Support:

Run the below mention batch file to install listed packages:

.. literalinclude:: ../../toolbox/pkgs/windows-2019.bat
.. literalinclude:: ../../toolbox/pkgs/windows-2022.bat
:language: bash

**xNVMe** can be build by using given build.bat,
Expand Down
54 changes: 54 additions & 0 deletions docs/latest/_sources/capis/xnvme.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,36 @@ xnvme_be_attr_list
:undoc-members:


.. _sec-c-api-xnvme-struct-xnvme_controller:

xnvme_controller
----------------

.. doxygenstruct:: xnvme_controller
:members:
:undoc-members:


.. _sec-c-api-xnvme-struct-xnvme_namespace:

xnvme_namespace
---------------

.. doxygenstruct:: xnvme_namespace
:members:
:undoc-members:


.. _sec-c-api-xnvme-struct-xnvme_subsystem:

xnvme_subsystem
---------------

.. doxygenstruct:: xnvme_subsystem
:members:
:undoc-members:


.. _sec-c-api-xnvme-struct-xnvme_timer:

xnvme_timer
Expand Down Expand Up @@ -178,6 +208,14 @@ xnvme_be_attr_pr
.. doxygenfunction:: xnvme_be_attr_pr


.. _sec-c-api-xnvme-func-xnvme_controller_reset:

xnvme_controller_reset
----------------------

.. doxygenfunction:: xnvme_controller_reset


.. _sec-c-api-xnvme-func-xnvme_enumerate:

xnvme_enumerate
Expand All @@ -194,6 +232,14 @@ xnvme_is_pow2
.. doxygenfunction:: xnvme_is_pow2


.. _sec-c-api-xnvme-func-xnvme_namespace_rescan:

xnvme_namespace_rescan
----------------------

.. doxygenfunction:: xnvme_namespace_rescan


.. _sec-c-api-xnvme-func-xnvme_prep_adm_gfeat:

xnvme_prep_adm_gfeat
Expand Down Expand Up @@ -226,6 +272,14 @@ xnvme_prep_nvm
.. doxygenfunction:: xnvme_prep_nvm


.. _sec-c-api-xnvme-func-xnvme_subsystem_reset:

xnvme_subsystem_reset
---------------------

.. doxygenfunction:: xnvme_subsystem_reset


.. _sec-c-api-xnvme-func-xnvme_timer_bw_pr:

xnvme_timer_bw_pr
Expand Down
10 changes: 10 additions & 0 deletions docs/latest/_sources/capis/xnvme_cmd.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ xnvme_cmd_ctx
:undoc-members:


.. _sec-c-api-xnvme_cmd-struct-xnvme_cmd_ctx_async:

xnvme_cmd_ctx_async
-------------------

.. doxygenstruct:: xnvme_cmd_ctx_async
:members:
:undoc-members:



.. _sec-c-api-xnvme_cmd-func:

Expand Down
10 changes: 10 additions & 0 deletions docs/latest/_sources/capis/xnvme_lba.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ xnvme_lba_range
:undoc-members:


.. _sec-c-api-xnvme_lba-struct-xnvme_lba_range_attr:

xnvme_lba_range_attr
--------------------

.. doxygenstruct:: xnvme_lba_range_attr
:members:
:undoc-members:



.. _sec-c-api-xnvme_lba-func:

Expand Down
10 changes: 10 additions & 0 deletions docs/latest/_sources/capis/xnvme_opts.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ xnvme_opts
:undoc-members:


.. _sec-c-api-xnvme_opts-struct-xnvme_opts_css:

xnvme_opts_css
--------------

.. doxygenstruct:: xnvme_opts_css
:members:
:undoc-members:



.. _sec-c-api-xnvme_opts-func:

Expand Down
235 changes: 235 additions & 0 deletions docs/latest/_sources/ci/bench/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
.. _sec-ci-bench:

Bench
#####

.. figure:: ../../_static/xnvme-ci-overview.png
:alt: xNVMe CI Resource Overview
:align: center

xNVMe **CI** environments and resources

This describes the setup / notes

.. _sec-ci-bench-notes:

System Notes
============

Since the system utilized is a custom physical setup, then notes are provided
here describing the hardware utilized and the configuration performed to get the
hardware resources into their state of function.

bifrost
-------

The physical hardware resources utilized for benchmarking reside in an isolated
network, only traffic allowed in is via a WireGuard VPN. Taking care of these
firewall and VPN tasks is a `Netgate 1100`_ running **pfSense+**.

The following is setup:

* Firewall rules: default to deny
* DHCP Server with mac-address based IP assignment
* WireGuard Enabled

See the `Netgate 1100 Manual`_ for details on how to configures this.

bench-intel
-----------

.. list-table:: Hardware Specs. for ``bench-intel``
:widths: 30 15 15 40
:header-rows: 1

* - CPU
- Memory
- Motherboard
- NVMe Devices
* - Intel 12th Gen. Core i5-12600
- 32 GB (2x Kingston 548C38-16)
- MSI Z690-A
- * 4x 980 PRO 2TB
* 3x 980 PRO 1TB
* 1x 980 PRO with Heatsink 1TB

bench-intel-pikvm
-----------------

This running PiKVM_ on a `Raspberry Pi 4b`_ with the `PiKVM V3 HAT`_, for setup
notes see `PiKVM V3 HAT Config Notes`_.

bench-amd
---------

.. list-table:: Hardware Specs. for ``bench-amd``
:widths: 30 15 15 40
:header-rows: 1

* - CPU
- Memory
- Motherboard
- NVMe Devices
* - AMD Ryzen Threadripper 1900X 8-Core
- 32 GB (4x CMK32GX4M4B3200C16)
- ASRock X399 Phantom Gaming 6
- - 8x MEMPEK1W016GA
- 2x MEMPEK1J016GAL

bench-amd-pikvm
---------------

...


runner-rockpi-01
----------------

This is a `Rock PI 4b`_ with a 512GB NVMe SSD attached.
It is running `Armbian`_ / Bookworm.

Add a user for the github action runner, named ``ghr``:

.. code-block:: bash
adduser ghr
usermod -aG sudo ghr
Install some tools:

.. code-block:: bash
apt-get -qy install \
git \
vim \
time \
tree
Configure the NVMe storage, by doing the following:

* Partition and ext4-format

- fdisk /dev/nvme0n1
- mkfs.ext4 /dev/nvme0n1p1

* Get the **UUID**

- Run: ``blkid``

* Edit ``/etc/fstab`` using the **UUID** with mount-point at ``/gha``

Then reload:

.. code-block:: bash
systemctl daemon-reload
mount /ghr
chown -R ghr:ghr /ghr
Install docker
~~~~~~~~~~~~~~

Do this:

.. code-block:: bash
curl -fsSL https://get.docker.com -o get-docker.sh
sh ./get-docker.sh
Change docker to store container-images and temporary data onto the NVMe device, to avoid wear on the emmc:

.. code-block:: bash
# Setup a docker config
mkdir /etc/systemd/system/docker.service.d
echo "[Service]" >> /etc/systemd/system/docker.service.d/docker.conf
echo "ExecStart=" >> "/etc/systemd/system/docker.service.d/docker.conf"
echo "ExecStart=/usr/bin/dockerd --data-root /ghr/docker" >> "/etc/systemd/system/docker.service.d/docker.conf"
# Reload it
systemctl daemon-reload
systemctl restart docker
GitHUB Runner
~~~~~~~~~~~~~

Switch to the ``ghr`` user, go into the ``/ghr`` mountpoint, download and
extract the github-action-runner:

.. code-block:: bash
su ghr
cd /ghr
mkdir actions-runner && cd actions-runner
curl -o actions-runner-linux-arm64-2.309.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.309.0/actions-runner-linux-arm64-2.309.0.tar.gz
echo "b172da68eef96d552534294e4fb0a3ff524e945fc5d955666bab24eccc6ed149 actions-runner-linux-arm64-2.309.0.tar.gz" | shasum -a 256 -c
tar xzf ./actions-runner-linux-arm64-2.309.0.tar.gz
Then we create two runners, one for ``bench-amd``, and one for ``bench-intel``:

.. code-block:: bash
export RUNNERS="bench-amd bench-intel"
export RUNNER_USER=ghr
export URL=https://github.com/OpenMPDK/xNVMe
export TOKEN={SUPER_SECRET}
With the above defined, then you can execute these:

.. code-block:: bash
cd /ghr
# Setup runners
for RUNNER_NAME in $RUNNERS; do cp -r actions-runner "runner-for-${RUNNER_NAME}"; done;
# Register runners
cd /ghr/runner-for-bench-intel
./config.sh --unattended --url ${URL} --token ${TOKEN} --labels bench,intel --replace --name runner-for-bench-intel
cd ..
cd /ghr/runner-for-bench-amd
./config.sh --unattended --url ${URL} --token ${TOKEN} --labels bench,amd --replace --name runner-for-bench-amd
cd ..
Install and run them as a service:

.. code-block:: bash
cd /ghr
# Service(s): install
for RUNNER_NAME in $RUNNERS; do pushd "runner-for-${RUNNER_NAME}"; sudo ./svc.sh install ${RUNNER_USER}; popd; done
# Service(s): start
for RUNNER_NAME in $RUNNERS; do pushd "runner-for-${RUNNER_NAME}"; sudo ./svc.sh start; popd; done
# Service(s): status
for RUNNER_NAME in $RUNNERS; do pushd "runner-for-${RUNNER_NAME}"; sudo ./svc.sh status; popd; done
And when needing to update:

.. code-block:: bash
# Services: stop
for RUNNER_NAME in $RUNNERS; do pushd "runner-for-${RUNNER_NAME}"; sudo ./svc.sh stop; popd; done
# Services: uninstall
for RUNNER_NAME in $RUNNERS; do pushd "runner-for-${RUNNER_NAME}"; sudo ./svc.sh uninstall; popd; done
# Remove the runner
for RUNNER_NAME in $RUNNERS; do pushd "runner-for-${RUNNER_NAME}"; ./config.sh remove --token ${TOKEN}; popd; done;
.. _Armbian: https://www.armbian.com/
.. _Netgate 1100: https://shop.netgate.com/products/1100-pfsense
.. _Netgate 1100 Manual: https://docs.netgate.com/pfsense/en/latest/solutions/sg-1100/
.. _Rock Pi 4b: https://rockpi.org/rockpi4

.. _PiKVM: https://pikvm.org/
.. _PiKVM V3 HAT: https://docs.pikvm.org/v3/
.. _PiKVM V3 HAT Config Notes: https://safl.dk/notebook/pikvm/
.. _Raspberry Pi 4b: https://www.raspberrypi.com/products/raspberry-pi-4-model-b/
10 changes: 10 additions & 0 deletions docs/latest/_sources/ci/build/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _sec-ci-build:

Build
#####

.. figure:: ../../_static/xnvme-ci-overview.png
:alt: xNVMe CI Resource Overview
:align: center

xNVMe **CI** environments and resources
Loading

0 comments on commit 39e30c0

Please sign in to comment.