github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-02-04 11:25:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

Install fixes (#2228)

Browse Source 
* Remove install instructions for unsuported RHEL 8.8 and 9.2

Current ROCm release does not support these versions of RHEL

* Centralize disclaimers and perquisites for installation

- Move the single-version to multi-version diclaimer to the install
  overview page where single vs multi installs are discussed.
- Move the installation of kernel-headers and development packages
  to the install preparation page. Unify it mainly from the quick start
  content.

* s/Name/name/ in repository config files for RHEL

The repository name can be set as `name=><name>` instead of `Name`,
otherwise yum complains about the repo not having a name, e.g:
```output
Repository 'ROCm-5.3.3' is missing name in configuration, using id.
```

This is fixed with this commit.

* Clean up render/video group section on prerequisites

* Installation and Upgrade restructuring & fixes

- Fix the rocm package urls for RHEL in the install & upgrade guides
  - RHEL8 and 9 have different URLs, add a tab-set similar to ubuntu
    for them.
- Fix the package URL in the upgrade guide for SLES (previously pointed
  to the amdgpu url)
- Change the apt-signing key download and conversion to the method used
  in the quick start guide, which is the recommended by ubuntu maintainers
- Change the install steps from list items to rubrics with numbered entries
  which is more readable and matches the style in the quick start guide
- Do not pass `--append` to `tee` in the upgrade guide, because it is
  meant to overwrite.
- Split the one long tab-set to multiple tab-sets in the upgrade guide
  to improve readability
This commit is contained in:
Mészáros Gergely
2023-06-08 17:17:51 +02:00
committed by GitHub
parent bcb3dd3b4a
commit a42fae5140
6 changed files with 498 additions and 542 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/deploy/linux/install_overview.md
View File

@@ -50,6 +50,12 @@ The multi-version installation refers to the following:
ability to support multiple versions of packages simultaneously.
- Use of versioned ROCm meta-packages.
```{attention}
ROCm packages that were previously installed from a single-version installation
must be removed before proceeding with the multi-version installation to avoid
conflicts.
```
```{note}
Multiversion install is not available for the kernel driver module, also referred to as AMDGPU.
```

56
docs/deploy/linux/installer/install.md
View File

@@ -41,6 +41,7 @@ sudo apt install ./amdgpu-install_5.5.50501-1_all.deb
::::{tab-set}
:::{tab-item} RHEL 8.6
:sync: RHEL-8.6
:sync: RHEL-8
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/5.5.1/rhel/8.6/amdgpu-install-5.5.50501-1.el8.noarch.rpm
@@ -49,35 +50,21 @@ sudo yum install https://repo.radeon.com/amdgpu-install/5.5.1/rhel/8.6/amdgpu-in
:::
:::{tab-item} RHEL 8.7
:sync: RHEL-8.7
:sync: RHEL-8
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/5.5.1/rhel/8.7/amdgpu-install-5.5.50501-1.el8.noarch.rpm
```
:::
:::{tab-item} RHEL 8.8
:sync: RHEL-8.8
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/5.5.1/rhel/8.8/amdgpu-install-5.5.50501-1.el8.noarch.rpm
```
:::
:::{tab-item} RHEL 9.1
:sync: RHEL-9.1
:sync: RHEL-9
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/5.5.1/rhel/9.1/amdgpu-install-5.5.50501-1.el8.noarch.rpm
```
:::
:::{tab-item} RHEL 9.2
:sync: RHEL-9.2
```shell
sudo yum install https://repo.radeon.com/amdgpu-install/5.5.1/rhel/9.2/amdgpu-install-5.5.50501-1.el8.noarch.rpm
```
:::
::::
:::::
@@ -172,12 +159,6 @@ the latest release of ROCm that you wish to install.
simultaneously, you are required to download the installer from the latest ROCm
release v5.5.1.
```{attention}
ROCm packages that were previously installed from a single-version installation
must be removed before proceeding with the multi-version installation to avoid
conflicts.
```
### Add Required Repositories
You must add the ROCm repositories manually for all ROCm releases
@@ -220,12 +201,16 @@ sudo apt update
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{tab-set}
:::{tab-item} RHEL 8
:sync: RHEL-8
```shell
for ver in 5.3.3 5.4.3; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
Name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/$ver/main
name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/rhel8/$ver/main
enabled=1
priority=50
gpgcheck=1
@@ -235,6 +220,27 @@ done
sudo yum clean all
```
:::
:::{tab-item} RHEL 9
:sync: RHEL-9
```shell
for ver in 5.3.3 5.4.3; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/rhel9/$ver/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
:::
::::
:::::
:::::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
@@ -243,7 +249,7 @@ sudo yum clean all
for ver in 5.3.3 5.4.3; do
sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
name=rocm
baseurl=https://repo.radeon.com/amdgpu/$ver/sle/15.4/main/x86_64
baseurl=https://repo.radeon.com/rocm/$ver/sle/15.4/main/x86_64
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key

577
docs/deploy/linux/os-native/install.md
View File

@@ -12,161 +12,120 @@ installed version by using the multi-version ROCm packages.
## Step by Step Instructions
```{note}
Users installing multiple versions of the ROCm stack must use the
release-specific repository URL.
```
::::::{tab-set}
:::::{tab-item} Ubuntu
:sync: ubuntu
::::{rubric} Installation of Kernel Headers and Development Packages
::::{rubric} 1. Download and convert the package signing key
::::
The following instructions to install kernel headers and development packages
apply to all versions and kernels of Ubuntu. The ROCm installation requires you
to install the Linux-headers and Linux-modules-extra package with the correct
version corresponding to the kernel's version.
```shell
# Make the directory if it doesn't exist yet.
# This location is recommended by the distribution maintainers.
sudo mkdir --parents --mode=0755 /etc/apt/keyrings
# Download the key, convert the signing-key to a full
# keyring required by apt and store in the keyring directory
wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | \
gpg --dearmor | sudo tee /etc/apt/keyrings/rocm.gpg > /dev/null
```
**Example:** If the system is running the Linux kernel version
`5.15.0-41-generic`, you must install the identical versions of Linux-headers
and development packages. Refer to {ref}`check-kernel-info` on to how to check
the system's kernel version.
```{note}
The GPG key may change; ensure it is updated when installing a new release. If
the key signature verification fails while updating, re-add the key from the
ROCm to the apt repository as mentioned above. The current `rocm.gpg.key` is not
available in a standard key ring distribution but has the following SHA1 sum
hash: `73f5d8100de6048aa38a8b84cd9a87f05177d208 rocm.gpg.key`
```
To check the `kernel-headers` and `linux-modules-extra` package versions,
follow these steps:
1. For the Ubuntu/Debian environment, execute the following command to verify
the kernel headers and development packages are installed with the
respective versions:
```shell
sudo dpkg -l | grep linux-headers
```
The command indicates if there are Linux headers installed as shown below:
```none
ii linux-headers-5.15.0-41-generic 5.15.0-41.44~20.04.1 amd64 Linux kernel headers for version 5.15.0 on 64 bit x86 SMP
```
2. Execute the following command to check whether the development packages are
installed:
```shell
sudo dpkg -l | grep linux-modules-extra
```
The command mentioned above lists the installed `linux-modules-extra`
packages like the output below:
```none
ii linux-modules-extra-5.15.0-41-generic 5.15.0-41.44~20.04.1 amd64 Linux kernel extra modules for version 5.15.0 on 64 bit x86 SMP
```
3. If the supported version installation of Linux headers and development
packages are not installed on the system, execute the following command
to install the packages:
```shell
sudo apt install linux-headers-`uname -r` linux-modules-extra-`uname -r`
```
::::{rubric} Adding the AMDGPU and ROCm Stack Repositories
::::{rubric} 2. Add the AMDGPU Repository and Install the Kernel-mode Driver
::::
1. Add GPG Key for AMDGPU and ROCm Stack
```{tip}
If you have a version of the kernel-mode driver installed, you may skip this
section.
```
Add the GPG key for AMDGPU and ROCm repositories. For Debian-based systems
like Ubuntu, configure the Debian ROCm repository as follows:
To add the AMDGPU repository, follow these steps:
```shell
curl -fsSL https://repo.radeon.com/rocm/rocm.gpg.key | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/rocm-keyring.gpg
```
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
```{note}
The GPG key may change; ensure it is updated when installing a new release. If
the key signature verification fails while updating, re-add the key from the
ROCm to the apt repository as mentioned above. The current `rocm.gpg.key` is not
available in a standard key ring distribution but has the following SHA1 sum
hash: `73f5d8100de6048aa38a8b84cd9a87f05177d208 rocm.gpg.key`
```
```shell
# amdgpu repository for focal
echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu focal main' \
| sudo tee /etc/apt/sources.list.d/amdgpu.list
sudo apt update
```
2. Add the AMDGPU Repository and Install the Kernel-mode Driver
:::
:::{tab-item} Ubuntu 22.04
:sync: ubuntu-22.04
```{attention}
If you have a version of the kernel-mode driver installed, you may skip this
section.
```
```shell
# amdgpu repository for jammy
echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu jammy main' \
| sudo tee /etc/apt/sources.list.d/amdgpu.list
sudo apt update
```
To add the AMDGPU repository, follow these steps:
:::
::::
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
Install the kernel mode driver and reboot the system using the following
commands:
```shell
echo 'deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu focal main' | sudo tee /etc/apt/sources.list.d/amdgpu.list
sudo apt update
```
```shell
sudo apt install amdgpu-dkms
sudo reboot
```
:::
:::{tab-item} Ubuntu 22.04
:sync: ubuntu-22.04
::::{rubric} 3. Add the ROCm Repository
::::
```shell
echo 'deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu jammy main' | sudo tee /etc/apt/sources.list.d/amdgpu.list
sudo apt update
```
To add the ROCm repository, use the following steps:
:::
::::
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
Install the kernel mode driver and reboot the system using the following
commands:
```shell
# ROCm repositories for focal
for ver in 5.3.3 5.4.3 5.5.1; do
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$ver focal main" \
| sudo tee --append /etc/apt/sources.list.d/rocm.list
done
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
| sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
```shell
sudo apt install amdgpu-dkms
sudo reboot
```
:::
:::{tab-item} Ubuntu 22.04
:sync: ubuntu-22.04
3. Add the ROCm Repository and Install Meta-packages
```shell
# ROCm repositories for jammy
for ver in 5.3.3 5.4.3 5.5.1; do
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/$ver jammy main" \
| sudo tee --append /etc/apt/sources.list.d/rocm.list
done
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
| sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
To add the ROCm repository, use the following steps:
:::
::::
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
::::{rubric} 4. Install packages
::::
```shell
for ver in 5.3.3 5.5.1; do
echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver focal main" | sudo tee /etc/apt/sources.list.d/rocm.list
done
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
:::{tab-item} Ubuntu 22.04
:sync: ubuntu-22.04
```shell
for ver in 5.3.3 5.5.1; do
echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/$ver jammy main" | sudo tee --append /etc/apt/sources.list.d/rocm.list
done
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
::::
Install packages of your choice in a single-version ROCm install or
in a multi-version ROCm install fashion. For more information on what
single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
Install packages of your choice in a single-version ROCm install or
in a multi-version ROCm install fashion. For more information on what
single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
- Sample Single-version installation
@@ -176,12 +135,6 @@ follow these steps:
- Sample Multi-version installation
```{important}
If the existing ROCm release contains non-versioned ROCm packages, you must
uninstall those packages before proceeding to the multi-version installation
to avoid conflicts.
```
```shell
sudo apt install rocm-hip-sdk5.5.1 rocm-hip-sdk5.3.3
```
@@ -190,145 +143,135 @@ follow these steps:
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{rubric} Installation of Kernel Headers and Development Packages
::::{rubric} 1. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
::::
The ROCm installation requires that you install the kernel headers and
`linux-modules-extra` package with the correct version corresponding to the
kernel's version.
```{tip}
If you have a version of the kernel-mode driver installed, you may skip this
section.
```
**Example:** If the system is running Linux kernel version
`3.10.0-1160.el7.x86_64`, you must install the identical versions of kernel
headers and development packages. Refer to {ref}`check-kernel-info` on to how to
check the system's kernel version.
::::{tab-set}
:::{tab-item} RHEL 8.6
:sync: RHEL-8.6
:sync: RHEL-8
To check the kernel headers and `linux-modules-extra` package versions,
follow these steps:
```shell
sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/8.6/main/x86_64/
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
1. To verify you have the supported version of the installed kernel headers,
type the following on the command line:
:::
```shell
sudo yum list installed kernel-headers
```
:::{tab-item} RHEL 8.7
:sync: RHEL-8.7
:sync: RHEL-8
The command mentioned above displays the list of kernel headers versions
currently present on your system. Verify if the listed kernel headers have
the same versions as the kernel.
```shell
sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/8.7/main/x86_64/
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
2. The following command lists the development packages on your system. Verify
if the listed development package's version number matches the kernel
version number:
:::
```shell
sudo yum list installed kernel-devel
```
:::{tab-item} RHEL 9.1
:sync: RHEL-9.1
:sync: RHEL-9
3. If the supported version installation of kernel headers and development
packages does not exist on the system, execute the command below to install:
```shell
sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/9.1/main/x86_64/
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
```shell
sudo yum install kernel-headers-`uname -r` kernel-devel-`uname -r`
```
::::{rubric} Adding the AMDGPU and ROCm Stack Repositories
:::
::::
1. Add the AMDGPU Stack Repository and Install the Kernel-mode Driver
Install the kernel mode driver and reboot the system using the following
commands:
```{attention}
If you have a version of the kernel-mode driver installed, you may skip this
section.
```
```shell
sudo yum install amdgpu-dkms
sudo reboot
```
::::{tab-set}
:::{tab-item} RHEL 8.6
:sync: RHEL-8.6
::::{rubric} 2. Add the ROCm Stack Repository
::::
```shell
sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
Name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/8.6/main/x86_64/
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
To add the ROCm repository, use the following steps, based on your distribution:
:::
::::{tab-set}
:::{tab-item} RHEL 8
:sync: RHEL-8
:::{tab-item} RHEL 8.7
:sync: RHEL-8.7
```shell
for ver in 5.3.3 5.4.3 5.5.1; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/rhel8/$ver/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
```shell
sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
Name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/8.7/main/x86_64/
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
:::
:::{tab-item} RHEL 9
:sync: RHEL-9
:::
```shell
for ver in 5.3.3 5.4.3 5.5.1; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/rhel9/$ver/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
:::{tab-item} RHEL 9.1
:sync: RHEL-9.1
:::
::::
```shell
sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
Name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/9.1/main/x86_64/
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
::::{rubric} 3. Install packages
::::
:::
::::
Install the kernel mode driver and reboot the system using the following
commands:
```shell
sudo yum install amdgpu-dkms
sudo reboot
```
2. Add the ROCm Stack Repository and Install Meta-packages
To add the ROCm repository, use the following steps:
```shell
for ver in 5.3.3 5.5.1; do
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-$ver]
Name=ROCm$ver
baseurl=https://repo.radeon.com/rocm/$ver/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
Install packages of your choice in a single-version ROCm install or
in a multi-version ROCm install fashion. For more information on what
single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
Install packages of your choice in a single-version ROCm install or
in a multi-version ROCm install fashion. For more information on what
single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
- Sample Single-version installation
@@ -338,12 +281,6 @@ follow these steps:
- Sample Multi-version installation
```{important}
If the existing ROCm release contains non-versioned ROCm packages, you must
uninstall those packages before proceeding to the multi-version installation
to avoid conflicts.
```
```shell
sudo yum install rocm-hip-sdk5.5.1 rocm-hip-sdk5.3.3
```
@@ -352,94 +289,62 @@ follow these steps:
:::::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
::::{rubric} Installation of Kernel Headers and Development Packages
::::{rubric} 1. Add the AMDGPU Repository and Install the Kernel-mode Driver
::::
ROCm installation requires you to install `linux-headers` and
`linux-modules-extra` package with the correct version corresponding to the
kernel's version.
```{tip}
If you have a version of the kernel-mode driver installed, you may skip this
section.
```
**Example:** If the system is running the Linux kernel version
`5.3.18-57_11.0.18`, you must install the same versions of Linux headers and
development packages. Refer to {ref}`check-kernel-info` on to how to check
the system's kernel version.
```shell
sudo tee /etc/zypp/repos.d/amdgpu.repo <<EOF
[amdgpu]
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/sle/15.4/main/x86_64
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo zypper ref
```
To check the `kernel-headers` and `linux-modules-extra` package versions, follow
these steps:
Install the kernel mode driver and reboot the system using the following
commands:
1. Ensure that the correct version of the latest `kernel-default-devel` and
`kernel-default` packages are installed. The following command lists the
installed `kernel-default-devel` and `kernel-default` package:
```shell
sudo zypper --gpg-auto-import-keys install amdgpu-dkms
sudo reboot
```
```shell
sudo zypper info kernel-default-devel or kernel-default
```
```{note}
This next step is only required if you find from the above command that the
`kernel-default-devel` and `kernel-default` versions of the package,
corresponding to the kernel release version, do not exist on your system.
```
2. If the required version of packages does not exist on the system, install
with the command below:
```shell
sudo zypper install kernel-default-devel or kernel-default
```
::::{rubric} Adding the AMDGPU and ROCm Repositories
::::{rubric} 2. Add the ROCm Stack Repository
::::
1. Add the AMDGPU Repository and Install the Kernel-mode Driver
To add the ROCm repository, use the following steps:
```{attention}
If you have a version of the kernel-mode driver installed, you may skip this
section.
```
```shell
for ver in 5.3.3 5.4.3 5.5.1; do
sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
[ROCm-$ver]
name=ROCm$ver
name=rocm
baseurl=https://repo.radeon.com/rocm/zyp/$ver/main
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo zypper ref
```
```shell
sudo tee --append /etc/zypp/repos.d/amdgpu.repo <<EOF
[amdgpu]
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/sle/15.4/main/x86_64
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo zypper ref
```
::::{rubric} 3. Install packages
::::
Install the kernel mode driver and reboot the system using the following
commands:
```shell
sudo zypper --gpg-auto-import-keys install amdgpu-dkms
sudo reboot
```
2. Add the ROCm Repository and Install Meta-packages
To add the ROCm repository, use the following steps:
```shell
for ver in 5.3.3 5.5.1; do
sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
name=rocm
baseurl=https://repo.radeon.com/amdgpu/$ver/sle/15.4/main/x86_64
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo zypper ref
```
Install packages of your choice in a single-version ROCm install or
in a multi-version ROCm install fashion. For more information on what
single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
Install packages of your choice in a single-version ROCm install or
in a multi-version ROCm install fashion. For more information on what
single/multi-version installations are, refer to {ref}`installation-types`.
For a comprehensive list of meta-packages, refer to
{ref}`meta-package-desc`.
- Sample Single-version installation
@@ -449,12 +354,6 @@ these steps:
- Sample Multi-version installation
```{important}
If the existing ROCm release contains non-versioned ROCm packages, you must
uninstall those packages before proceeding to the multi-version installation
to avoid conflicts.
```
```shell
sudo zypper --gpg-auto-import-keys install rocm-hip-sdk5.5.1 rocm-hip-sdk5.3.3
```

283
docs/deploy/linux/os-native/upgrade.md
View File

@@ -11,19 +11,23 @@ installed version, refer to the [](install) page.
## Upgrade Steps
### Update the AMDGPU repository
Execute the commands below based on your distribution to point the `amdgpu`
repository to the new release.
::::::{tab-set}
:::::{tab-item} Ubuntu
:sync: ubuntu
::::{rubric} Update the AMDGPU Repository
::::
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
```shell
echo 'deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu focal main' | sudo tee /etc/apt/sources.list.d/amdgpu.list
# amdgpu repository for focal
echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu focal main' \
| sudo tee /etc/apt/sources.list.d/amdgpu.list
sudo apt update
```
@@ -32,71 +36,27 @@ sudo apt update
:sync: ubuntu-22.04
```shell
echo 'deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu jammy main' | sudo tee /etc/apt/sources.list.d/amdgpu.list
# amdgpu repository for jammy
echo 'deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/5.5.1/ubuntu jammy main' \
| sudo tee /etc/apt/sources.list.d/amdgpu.list
sudo apt update
```
:::
::::
Upgrade the kernel mode driver and reboot the system using the following
commands:
```shell
sudo apt install amdgpu-dkms
sudo reboot
```
::::{rubric} Update the ROCm Repository
::::
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
```shell
echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/5.5.1 focal main" | sudo tee /etc/apt/sources.list.d/rocm.list
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
:::{tab-item} Ubuntu 22.04
:sync: ubuntu-22.04
```shell
echo "deb [arch=amd64 signed-by=/etc/apt/trusted.gpg.d/rocm-keyring.gpg] https://repo.radeon.com/rocm/apt/5.5.1 jammy main" | sudo tee /etc/apt/sources.list.d/rocm.list
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' | sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
::::
::::{rubric} Upgrade the ROCm meta-packages
::::
Your packages can be upgraded now through their meta-packages, for example:
```shell
sudo apt install --only-upgrade rocm-hip-sdk
```
:::::
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{rubric} Update the AMDGPU repository
::::
::::{tab-set}
:::{tab-item} RHEL 8.6
:sync: RHEL-8.6
:sync: RHEL-8
```shell
sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
Name=amdgpu
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/8.6/main/x86_64/
enabled=1
priority=50
@@ -107,14 +67,14 @@ sudo yum clean all
```
:::
:::{tab-item} RHEL 8.7
:sync: RHEL-8.7
:sync: RHEL-8
```shell
sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
Name=amdgpu
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/8.7/main/x86_64/
enabled=1
priority=50
@@ -125,15 +85,15 @@ sudo yum clean all
```
:::
:::{tab-item} RHEL 9.1
:sync: RHEL-9.1
:sync: RHEL-9
```shell
sudo tee --append /etc/yum.repos.d/amdgpu.repo <<EOF
sudo tee /etc/yum.repos.d/amdgpu.repo <<EOF
[amdgpu]
Name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/9.2/main/x86_64/
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/rhel/9.1/main/x86_64/
enabled=1
priority=50
gpgcheck=1
@@ -144,53 +104,12 @@ sudo yum clean all
:::
::::
::::{rubric} Upgrade the Kernel-mode driver and reboot the System
::::
Upgrade the kernel mode driver and reboot the system using the following
commands:
```shell
sudo yum install amdgpu-dkms
sudo reboot
```
::::{rubric} Update the ROCm Repository
::::
```shell
sudo tee --append /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-5.4.3]
Name=ROCm5.4.3
baseurl=https://repo.radeon.com/rocm/5.5.1/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
done
sudo yum clean all
```
::::{rubric} Upgrade the ROCm Meta-packages
::::
Your packages can be upgraded now through their meta-packages, for example:
```shell
sudo apt install --only-upgrade rocm-hip-sdk
```
:::::
:::::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
::::{rubric} Update the AMDGPU repository
::::
```shell
sudo tee --append /etc/zypp/repos.d/amdgpu.repo <<EOF
sudo tee /etc/zypp/repos.d/amdgpu.repo <<EOF
[amdgpu]
name=amdgpu
baseurl=https://repo.radeon.com/amdgpu/5.5.1/sle/15.4/main/x86_64
@@ -201,24 +120,129 @@ EOF
sudo zypper ref
```
::::{rubric} Upgrade the Kernel-mode driver and reboot the System
::::
:::::
::::::
### Upgrade the kernel-mode driver & reboot
Upgrade the kernel mode driver and reboot the system using the following
commands:
commands based on your distribution:
::::{tab-set}
:::{tab-item} Ubuntu
:sync: ubuntu
```shell
sudo apt install amdgpu-dkms
sudo reboot
```
:::
:::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
```shell
sudo yum install amdgpu-dkms
sudo reboot
```
:::
:::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
```shell
sudo zypper --gpg-auto-import-keys install amdgpu-dkms
sudo reboot
```
::::{rubric} Update the ROCm repository
:::
::::
### Update the ROCm repository
Execute the commands below based on your distribution to point the `rocm`
repository to the new release.
::::::{tab-set}
:::::{tab-item} Ubuntu
:sync: ubuntu
::::{tab-set}
:::{tab-item} Ubuntu 20.04
:sync: ubuntu-20.04
```shell
sudo tee --append /etc/zypp/repos.d/rocm.repo <<EOF
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.5.1 focal main" \
| sudo tee /etc/apt/sources.list.d/rocm.list
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
| sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
:::{tab-item} Ubuntu 22.04
:sync: ubuntu-22.04
```shell
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/rocm/apt/5.5.1 jammy main" \
| sudo tee /etc/apt/sources.list.d/rocm.list
echo -e 'Package: *\nPin: release o=repo.radeon.com\nPin-Priority: 600' \
| sudo tee /etc/apt/preferences.d/rocm-pin-600
sudo apt update
```
:::
::::
:::::
:::::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
::::{tab-set}
:::{tab-item} RHEL 8
:sync: RHEL-8
```shell
sudo tee /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-5.5.1]
name=ROCm5.5.1
baseurl=https://repo.radeon.com/rocm/rhel8/5.5.1/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
:::
:::{tab-item} RHEL 9
:sync: RHEL-9
```shell
sudo tee /etc/yum.repos.d/rocm.repo <<EOF
[ROCm-5.5.1]
name=ROCm5.5.1
baseurl=https://repo.radeon.com/rocm/rhel9/5.5.1/main
enabled=1
priority=50
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
EOF
sudo yum clean all
```
:::
::::
:::::
:::::{tab-item} SUSE Linux Enterprise Server 15
:sync: SLES15
```shell
sudo tee /etc/zypp/repos.d/rocm.repo <<EOF
[ROCm-5.5.1]
name=ROCm5.5.1
name=rocm
baseurl=https://repo.radeon.com/amdgpu/5.5.1/sle/15.4/main/x86_64
baseurl=https://repo.radeon.com/rocm/zyp/5.5.1/main
enabled=1
gpgcheck=1
gpgkey=https://repo.radeon.com/rocm/rocm.gpg.key
@@ -226,18 +250,41 @@ EOF
sudo zypper ref
```
::::{rubric} Upgrade the ROCm Meta-packages
::::
Your packages can be upgraded now through their meta-packages, for example:
```shell
sudo zypper --gpg-auto-import-keys update -y rocm-hip-sdk
```
:::::
::::::
### Upgrade the ROCm packages
Your packages can be upgraded now through their meta-packages, see the following
example based on your distribution:
::::{tab-set}
:::{tab-item} Ubuntu
:sync: ubuntu
```shell
sudo apt install --only-upgrade rocm-hip-sdk
```
:::
:::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
```shell
sudo yum update rocm-hip-sdk
```
:::
:::{tab-item} Suse Linux Enterprise Server 15
:sync: SLES15
```shell
sudo zypper --gpg-auto-import-keys update rocm-hip-sdk
```
:::
::::
## Verification Process
To verify if the upgrade is successful, refer to the

75
docs/deploy/linux/prerequisites.md
View File

@@ -49,20 +49,66 @@ Verify the kernel version using the following steps:
uname -srmv
```
2. Confirm that the obtained kernel version information matches with System
Requirements.
**Example:** The output of the command above lists the kernel version in the
following format:
```shell
```output
Linux 5.15.0-46-generic #44~20.04.5-Ubuntu SMP Fri Jun 24 13:27:29 UTC 2022 x86_64
```
### Setting Permissions for Groups
2. Confirm that the obtained kernel version information matches with system
requirements as listed in {ref}`supported_distributions`.
## Kernel headers and development packages
The driver package uses
[{abbr}`DKMS (Dynamic Kernel Module Support)`][DKMS-wiki] to build
the `amdgpu-dkms` module (driver) for the installed kernels. This requires the
Linux kernel headers and modules to be installed for each. Usually these are
automatically installed with the kernel, but if you have multiple kernel
versions or you have downloaded the kernel images and not the kernel
meta-packages then they must be manually installed.
[DKMS-wiki]: https://en.wikipedia.org/wiki/Dynamic_Kernel_Module_Support
To install for the currently active kernel run the command corresponding
to your distribution.
::::{tab-set}
:::{tab-item} Ubuntu
:sync: ubuntu
```shell
sudo apt install "linux-headers-$(uname -r)" "linux-modules-extra-$(uname -r)"
```
:::
:::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
```shell
sudo yum install kernel-headers kernel-devel
```
:::
:::{tab-item} SUSE Linux Enterprise Server
:sync: SLES
```shell
sudo zypper install kernel-default-devel
```
:::
::::
## Setting Permissions for Groups
This section provides steps to add any current user to a video group to access
GPU resources.
Use of the video group is recommended for all ROCm-supported operating
systems.
1. To check the groups in your system, issue the following command:
@@ -70,22 +116,17 @@ GPU resources.
groups
```
2. Add yourself to the `render` or `video` group using the following instruction:
2. Add yourself to the `render` and `video` group using the command:
```shell
sudo usermod -a -G render $LOGNAME
# OR
sudo usermod -a -G video $LOGNAME
sudo usermod -a -G render,video $LOGNAME
```
3. Use of the video group is recommended for all ROCm-supported operating
systems.
To add all future users to the `video` and `render` groups by default, run
the following commands:
```shell
echo 'ADD_EXTRA_GROUPS=1' | sudo tee -a /etc/adduser.conf
echo 'EXTRA_GROUPS=video' | sudo tee -a /etc/adduser.conf
echo 'EXTRA_GROUPS=render' | sudo tee -a /etc/adduser.conf
```
```shell
echo 'ADD_EXTRA_GROUPS=1' | sudo tee -a /etc/adduser.conf
echo 'EXTRA_GROUPS=video' | sudo tee -a /etc/adduser.conf
echo 'EXTRA_GROUPS=render' | sudo tee -a /etc/adduser.conf
```

43
docs/deploy/linux/quick_start.md
View File

@@ -1,48 +1,5 @@
# Quick Start (Linux)
## Install Prerequisites
The driver package uses
[{abbr}`DKMS (Dynamic Kernel Module Support)`][DKMS-wiki] to build
the `amdgpu-dkms` module (driver) for the installed kernels. This requires the Linux
kernel headers and modules to be installed for each. Usually these are
automatically installed with the kernel, but if you have multiple kernel
versions or you have downloaded the kernel images and not the kernel
meta-packages then they must be manually installed.
[DKMS-wiki]: https://en.wikipedia.org/wiki/Dynamic_Kernel_Module_Support
To install for the currently active kernel run the command corresponding
to your distribution.
::::{tab-set}
:::{tab-item} Ubuntu
:sync: ubuntu
```shell
sudo apt install "linux-headers-$(uname -r)" "linux-modules-extra-$(uname -r)"
```
:::
:::{tab-item} Red Hat Enterprise Linux
:sync: RHEL
```shell
sudo yum install kernel-headers kernel-devel
```
:::
:::{tab-item} SUSE Linux Enterprise Server
:sync: SLES
```shell
sudo zypper install kernel-default-devel
```
:::
::::
## Add Repositories
::::::{tab-set}