Skip to content

Commit ee3cbcf

Browse files
committed
docs: split image info out of system admin
move info on release streams, nvidia images and rebasing to it's own page
1 parent 7552fe3 commit ee3cbcf

2 files changed

Lines changed: 52 additions & 31 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Apollo Images"
3+
weight: 3
4+
---
5+
6+
# Apollo Images {anchor=false}
7+
8+
## Apollo release channels
9+
10+
> [!INFO]
11+
> The stable channel will be changed to a *weekly* cadence at a later date yet to be determined.
12+
13+
Apollo builds images with three different channels. These have different release cadences and target different users.
14+
15+
- `stable`: This channel currently updates *daily* and is the default for Apollo. Recommended for most users.
16+
- `stable-lts`: same as the above, but using the *LTS* version of the kernel. Some users may have a more stable experience with this channel.
17+
- `latest`: This channel updates whenever a change is made to the Apollo git repo, alongside daily builds. Recommended for advanced users and testers.
18+
19+
## Nvidia images
20+
21+
> [!INFO]
22+
> Users with older Nvidia cards can use the `apollo` image, however these images only ship the open source drivers, which may have worse performance and stability.
23+
24+
Apollo builds a dedicated `apollo-nvidia` image, which includes the proprietary Nvidia GPU drivers for Turing (GTX 16xx/RTX 20xx) or newer cards. For most users on AMD or Intel cards, simply using the `apollo` image will suffice.
25+
26+
If you switch graphics cards, e.g., from Nvidia to AMD, or vice versa, it's recommended to switch to the appropriate image using [the instructions below](#rebasing-between-apollo-images)
27+
28+
29+
## Rebasing between Apollo images
30+
31+
Run `sudo bootc status` first to get the current status of your system, and then you can use `bootc switch` command as below:
32+
33+
```bash
34+
# Replace $image and $channel with your desired image and/or channel.
35+
sudo bootc switch ghcr.io/apollo-linux/$image:$channel
36+
```
37+
38+
### Pinning to a specific date
39+
40+
In addition to regular builds, Apollo also tags each build with a date to make it easier for users to switch. If you need to pause system updates, e.g., due to a regression, you can also pin your system image to a specific date within the last 90 days like such:
41+
42+
```bash
43+
# Replace $image and $channel with your current image and channel (e.g. apollo:latest)
44+
# If you're not sure what image and channel you're running, run sudo bootc status first
45+
# Replace $date with the format YYYYMMDD (e.g. 20260519)
46+
sudo bootc switch ghcr.io/apollo-linux/$image:$channel.$date
47+
```
48+
49+
### Reference
50+
51+
- [Upstream `bootc switch` documentation](https://bootc.dev/bootc/man/bootc-switch.8.html)

content/docs/using-apollo/system-administration.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,11 @@ weight: 2
55

66
# System Administration {anchor=false}
77

8-
## Apollo release channels
9-
10-
> [!INFO]
11-
> The `stable` channel will be changed to a *weekly* cadence at a later date yet to be determined.
12-
13-
Apollo builds images with three different channels. These have different release cadences and target different users.
14-
15-
- **stable**: This channel currently updates *daily* and is the default for Apollo. Recommended for most users.
16-
- **stable-lts**: same as the above, but using the *LTS* version of the kernel. Some users may have a more stable experience with this channel.
17-
- **latest**: This channel updates whenever a change is made to the Apollo git repo, alongside daily builds. Recommended for advanced users and testers **only**.
18-
19-
### Changing release channels:
20-
21-
For users with AMD/Intel graphics:
22-
```bash
23-
sudo bootc switch ghcr.io/apollo-linux/apollo:$channel # replace $channel with the desired channel above
24-
```
25-
26-
For users with Nvidia GTX 16xx/RTX 20xx or newer graphics:
27-
```bash
28-
sudo bootc switch ghcr.io/apollo-linux/apollo-nvidia:$channel # replace $channel with the desired channel above
29-
```
30-
318
## Managing Automatic Updates
329

3310
Automatic updates are the intended way to use Apollo. We use automatic updates by default so users always get the latest bug and security fixes as well as new features.
3411

35-
If you need to pause system updates, e.g., due to a regression, you can also pin your system image to a specific date within the last 90 days like such:
36-
37-
```bash
38-
# replace $image and $channel with your current image and channel (e.g. apollo:latest)
39-
# if you're not sure what image and channel you're running, run sudo bootc status first
40-
# replace $date with the format YYYYMMDD (e.g. 20260519)
41-
sudo bootc switch ghcr.io/apollo-linux/$image:$channel.$date
42-
```
12+
If you're dealing with a regression in a recent build, you may first want to try [pinning to a specific release date](/docs/using-apollo/apollo-images/#pinning-to-a-specific-date). This will allow the rest of your system to remain up to date.
4313

4414
Nontheless, if you still want to disable them you can run the following:
4515
```bash

0 commit comments

Comments
 (0)