Skip to content

Add instructions to upgrade the Sprite OS #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbellerb merged 2 commits into from
Mar 18, 2026
Merged

Add instructions to upgrade the Sprite OS #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e012e6e
Add instructions to upgrade the Sprite OS
jbellerb Mar 16, 2026
26de009
Update src/content/docs/sprite-maintenance.mdx
kcmartin Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions src/content/docs/sprite-maintenance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Sprite Maintenance
description: Keeping your Sprites happy and healthy
---

import { Callout, StatusIcon } from '@/components/react';

Sprites are persistent. Everything you leave is there when you come back, including the software. Long-living Sprites still need regular updates. This guide walks through some of the common tasks for maintaining the software environment in your Sprite.

---

## OS Upgrades

New Sprites run on a fresh install of Ubuntu 25.10. Older Sprites created with Ubuntu 25.04 must upgrade to continue receiving security and feature updates.

<Callout type="info">
If you don't know what version of Ubuntu your Sprite currently runs, check with:

```bash
lsb_release -d
```
</Callout>

Fortunately, Sprites are disposable. If your workload doesn't require the Sprite to live long-term, upgrading is easy: destroy the Sprite and create a new one! If you need to copy files over, try [mounting the filesystem locally](/working-with-sprites/#mounting-filesystem-locally).

If creating a new Sprite is impractical, you can also upgrade Ubuntu in-place. Keep in mind that bundled software (such as agents and language toolchains) must be upgraded separately. Install the Ubuntu upgrader with:

Check warning on line 26 in src/content/docs/sprite-maintenance.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Spelling] Is 'upgrader' a typo?

Raw Output:
{"message": "[Fly.Spelling] Is 'upgrader' a typo?", "location": {"path": "src/content/docs/sprite-maintenance.mdx", "range": {"start": {"line": 26, "column": 204}}}, "severity": "INFO"}

Check warning on line 26 in src/content/docs/sprite-maintenance.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Spelling] Is 'toolchains' a typo?

Raw Output:
{"message": "[Fly.Spelling] Is 'toolchains' a typo?", "location": {"path": "src/content/docs/sprite-maintenance.mdx", "range": {"start": {"line": 26, "column": 144}}}, "severity": "INFO"}

@kcmartin kcmartin Mar 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we assume our users know how to upgrade their bundled software/agents and language toolchains, or give some kind of hint how they would do that?

@jbellerb jbellerb Mar 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a plan yet and mostly mentioned it as a nudge that creating a new Sprite is the better way. Every toolchain has different instructions and some toolchains are pretty hard to update. I've been installing my own to override those. I wanted to get this minimal page out for the Ubuntu deprecation. Should I remove the reference for now?

@kcmartin kcmartin Mar 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine to leave it in, it helps users a head's up/avoid a surprise, even if we don't have a guide to offer them for updating toolchains.


```bash
sudo apt update
sudo apt install ubuntu-release-upgrader-core
```

With the upgrader installed, follow the [official instructions](https://ubuntu.com/server/docs/how-to/software/upgrade-your-release/) from Ubuntu. In short:

Check warning on line 33 in src/content/docs/sprite-maintenance.mdx

View workflow job for this annotation

GitHub Actions / Vale linter 

[vale] reported by reviewdog 🐶
[Fly.Spelling] Is 'upgrader' a typo?

Raw Output:
{"message": "[Fly.Spelling] Is 'upgrader' a typo?", "location": {"path": "src/content/docs/sprite-maintenance.mdx", "range": {"start": {"line": 33, "column": 10}}}, "severity": "INFO"}

```bash
# upgrade to the latest packages for the current release
sudo apt upgrade

# switch to the new release
sudo do-release-upgrade

# upgrade installed packages to the new release
sudo apt upgrade
```
1 change: 1 addition & 0 deletions src/lib/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export const sidebarConfig: SidebarGroup[] = [
{ label: 'Overview', slug: 'index' },
{ label: 'Quickstart', slug: 'quickstart' },
{ label: 'Working with Sprites', slug: 'working-with-sprites' },
{ label: 'Sprite Maintenance', slug: 'sprite-maintenance' },
],
},
{
Expand Down
Loading