Skip to content

Commit

Permalink
Update docs/6.2.4 with fixes in docs/6.2.2 (#472)
Browse files Browse the repository at this point in the history
* Docs housekeeping post-6.2.0 (#394)

* remove leftover css

Signed-off-by: Peter Jun Park <peter.park@amd.com>

* fix link to panel_config_template.yaml

Signed-off-by: Peter Jun Park <peter.park@amd.com>

* add note in archived docs pointing to latest

Signed-off-by: Peter Jun Park <peter.park@amd.com>

rm repetition

---------

Signed-off-by: Peter Jun Park <peter.park@amd.com>
Signed-off-by: Peter Park <peter.park@amd.com>

* Documented Docker container OpenSSL abilities being affected by Host network proxy services (#440)

* Documented Docker container OpenSSL abilities being affected by host
network proxy services, causing network certificates verification
problem during Docker container build stage of Grafana server setup.

Signed-off-by: Vladimir Stempen <vladimir.stempen@amd.com>

* Update docs/install/grafana-setup.rst

Co-authored-by: Peter Park <peter.park@amd.com>
Signed-off-by: vstempen <147086176+vstempen@users.noreply.github.com>

---------

Signed-off-by: Vladimir Stempen <vladimir.stempen@amd.com>
Signed-off-by: vstempen <147086176+vstempen@users.noreply.github.com>
Co-authored-by: Peter Park <peter.park@amd.com>
Signed-off-by: Peter Park <peter.park@amd.com>

* update package manager install docs to include omniperf in PATH (#420)

Signed-off-by: Peter Jun Park <peter.park@amd.com>
Signed-off-by: Peter Park <peter.park@amd.com>

* Add omniperf suffix to MOD_INSTALL_PATH in docs (#414)

If we don't add the suffix omniperf to the install path then the subsequent instruction of module load omniperf will not work

Signed-off-by: coleramos425 <colramos@amd.com>
Signed-off-by: Peter Park <peter.park@amd.com>

---------

Signed-off-by: Peter Jun Park <peter.park@amd.com>
Signed-off-by: Peter Park <peter.park@amd.com>
Signed-off-by: Vladimir Stempen <vladimir.stempen@amd.com>
Signed-off-by: vstempen <147086176+vstempen@users.noreply.github.com>
Signed-off-by: coleramos425 <colramos@amd.com>
Co-authored-by: vstempen <147086176+vstempen@users.noreply.github.com>
Co-authored-by: Cole Ramos <colramos@amd.com>
3 people authored Nov 6, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent afcf6ef commit 7f54719
Showing 6 changed files with 28 additions and 24 deletions.
5 changes: 5 additions & 0 deletions docs/archive/docs-1.x/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Welcome to the [Omniperf](https://github.com/ROCm/omniperf) Documentation!

```{warning}
This version of the documentation is archived and contains out-of-date information.
See [Omniperf documentation](https://rocm.docs.amd.com/projects/omniperf/en/latest/index.html) for the latest version.
```

```eval_rst
.. toctree::
:glob:
5 changes: 5 additions & 0 deletions docs/archive/docs-2.x/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Welcome to the [Omniperf](https://github.com/ROCm/omniperf) Documentation!

```{warning}
This version of the documentation is archived and contains out-of-date information.
See [Omniperf documentation](https://rocm.docs.amd.com/projects/omniperf/en/latest/index.html) for the latest version.
```

```eval_rst
.. toctree::
:glob:
2 changes: 1 addition & 1 deletion docs/how-to/analyze/cli.rst
Original file line number Diff line number Diff line change
@@ -186,7 +186,7 @@ Walkthrough
3. Choose your own customized subset of metrics with the ``-b`` (or ``--block``)
option. Or, build your own configuration following
`config_template <https://github.com/ROCm/omniperf/blob/amd-mainline/src/omniperf_soc/analysis_configs/panel_config_template.yaml>`_.
`config_template <https://github.com/ROCm/omniperf/blob/main/src/omniperf_soc/analysis_configs/panel_config_template.yaml>`_.
The following snippet shows how to generate a report containing only metric 2
(:doc:`System Speed-of-Light </conceptual/system-speed-of-light>`).

11 changes: 10 additions & 1 deletion docs/install/core-install.rst
Original file line number Diff line number Diff line change
@@ -142,7 +142,7 @@ Install from source
cd build
cmake -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR}/{{ config.version }} \
-DPYTHON_DEPS=${INSTALL_DIR}/python-libs \
-DMOD_INSTALL_PATH=${INSTALL_DIR}/modulefiles ..
-DMOD_INSTALL_PATH=${INSTALL_DIR}/modulefiles/omniperf ..
# install
make install
@@ -224,20 +224,29 @@ software stack.
.. code-block:: shell
$ sudo apt install omniperf
# Include omniperf in your system PATH
$ sudo update-alternatives --install /usr/bin/omniperf omniperf /opt/rocm/bin/omniperf 0
# Install Python dependencies
$ python3 -m pip install -r /opt/rocm/libexec/omniperf/requirements.txt
.. tab-item:: Red Hat Enterprise Linux

.. code-block:: shell
$ sudo dnf install omniperf
# Include omniperf in your system PATH
$ sudo update-alternatives --install /usr/bin/omniperf omniperf /opt/rocm/bin/omniperf 0
# Install Python dependencies
$ python3 -m pip install -r /opt/rocm/libexec/omniperf/requirements.txt
.. tab-item:: SUSE Linux Enterprise Server

.. code-block:: shell
$ sudo zypper install omniperf
# Include omniperf in your system PATH
$ sudo update-alternatives --install /usr/bin/omniperf omniperf /opt/rocm/bin/omniperf 0
# Install Python dependencies
$ python3 -m pip install -r /opt/rocm/libexec/omniperf/requirements.txt
.. _core-install-rocprof-var:
7 changes: 7 additions & 0 deletions docs/install/grafana-setup.rst
Original file line number Diff line number Diff line change
@@ -79,6 +79,13 @@ directory to begin.
$ sudo docker-compose build
$ sudo docker-compose up -d
.. note::

To troubleshoot Docker container build failures related to certificate verification, try
disabling any network proxy services on the host system. These proxy services can interfere
with OpenSSL's ability to retrieve a correct certificate chain when the container accesses
external websites.

The TCP ports for Grafana (``4000``) and MongoDB (``27017``) in the Docker
container are mapped to ``14000`` and ``27018``, respectively, on the host side.

22 changes: 0 additions & 22 deletions docs/sphinx/static/css/o_custom.css
Original file line number Diff line number Diff line change
@@ -1,30 +1,8 @@
:root {
--amd-teal-500: #00C2DE;
--amd-teal-750: #00788E;
}

/* Override PyData Sphinx Theme default colors */
html[data-theme='light'] {
--pst-color-primary: var(--amd-teal-750);
--pst-color-primary-bg: var(--amd-teal-500);
--pst-color-table-row-hover-bg: #E2E8F0;
}

html[data-theme='dark'] {
--pst-color-primary: var(--amd-teal-500);
--pst-color-primary-bg: var(--amd-teal-750);
--pst-color-table-row-hover-bg: #1E293B;
}

html[data-theme='light'],
html[data-theme='dark'] {
--pst-color-link: var(--pst-color-primary);
}

a svg {
color: var(--pst-color-text-base);
}

a svg:hover {
color: var(--pst-color-link-hover);
}

0 comments on commit 7f54719

Please sign in to comment.