Skip to content

Commit ebfa6de

Browse files
authored
Merge pull request #29 from ROCm/dev/bhatturu/update-readme-release-1.0.x
Update readme with instructions for instaling from repository
2 parents 994ffa7 + 820f924 commit ebfa6de

1 file changed

Lines changed: 26 additions & 6 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,23 @@ AMD Container Toolkit offers tools to streamline the use of AMD GPUs with contai
1010
# Quick Start
1111
Install the Container toolkit.
1212

13-
```text
14-
> sudo apt install amd-container-toolkit
15-
```
13+
## Installing from the official repository
14+
To install the AMD Container Toolkit from the official repository, follow these steps:
15+
16+
1. Add the GPG key for the repository:
17+
```bash
18+
wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | gpg --dearmor | tee /etc/apt/keyrings/rocm.gpg > /dev/null
19+
```
20+
21+
2. Add the repository to your system. Replace `noble` with `jammy` if you are using Ubuntu 22.04:
22+
```bash
23+
echo "deb [signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amd-container-toolkit/apt/ noble main" > /etc/apt/sources.list.d/rocm.list
24+
```
25+
26+
3. Update the package list and install the toolkit:
27+
```bash
28+
apt update && apt install amd-container-toolkit
29+
```
1630

1731
# Configuring Docker
1832

@@ -120,8 +134,10 @@ amd.com/gpu=0
120134
```
121135

122136
# Release notes
123-
1. Partitioned GPUs are not supported.
124-
137+
| Release | Known Issues |
138+
|----------|------------------------------------------------------------------------------|
139+
| v1.0.0 | 1. Partitioned GPUs are not supported.<br> 2. RPM builds are experimental. |
140+
125141
## Building from Source
126142
To build debian package, use the following command.
127143

@@ -135,10 +151,14 @@ To build rpm package, use the following command.
135151
make pkg-rpm
136152
```
137153

154+
> [!WARNING]
155+
> The RPM package is still experimental in nature and may not be fully stable.
156+
138157
The packages will be generated in the ```bin``` folder.
139158

140159
# Documentation
141-
For detailed documentation including installation guides and configuration options, see the documentation.
160+
For detailed documentation including installation guides and configuration options, see the [documentation](https://instinct.docs.amd.com/projects/container-toolkit/en/latest).
142161

143162
# License
144163
This project is licensed under the Apache 2.0 License - see the [LICENSE](https://github.com/ROCm/container-toolkit/blob/main/LICENSE) file for details.
164+

0 commit comments

Comments
 (0)