lxc/incus
1
0
Fork 0
mirror of https://github.com/lxc/incus.git synced 2026-02-05 09:46:19 +01:00
Code Issues Releases Activity

doc: Replace Ubuntu in documentation examples

Browse Source 
Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
This commit is contained in:
Stéphane Graber
2025-04-24 01:53:36 -04:00
parent 8b6c8072ae
commit d6dd1d7300
17 changed files with 63 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/cloud-init.md
View File

@@ -29,7 +29,7 @@ Rebooting the instance does not re-trigger the actions.
To use `cloud-init`, you must base your instance on an image that has `cloud-init` installed.
Images from the [`images` remote](https://images.linuxcontainers.org/) have `cloud-init`-enabled variants, which are usually bigger in size than the default variant.
The cloud variants use the `/cloud` suffix, for example, `images:ubuntu/22.04/cloud`.
The cloud variants use the `/cloud` suffix, for example, `images:debian/12/cloud`.
## `cloud-init` and virtual machines
@@ -204,7 +204,7 @@ config:
By default, `cloud-init` configures a DHCP client on an instance's `eth0` interface.
You can define your own network configuration using the `network-config` option to override the default configuration (this is due to how the template is structured).
`cloud-init` then renders the relevant network configuration on the system using either `ifupdown` or `netplan`, depending on the Ubuntu release.
`cloud-init` then renders the relevant network configuration on the system using either `ifupdown` or `netplan`, depending on the distribution.
The configuration data is stored in the following files in the instance's root file system:

16
doc/howto/benchmark_performance.md
View File

@@ -37,15 +37,15 @@ Local image
To do so, run a command similar to the following and specify the fingerprint (for example, `2d21da400963`) of the image when you run `incus-benchmark`:
incus image copy images:ubuntu/22.04 local:
incus image copy images:debian/12 local:
You can also assign an alias to the image and specify that alias (for example, `ubuntu`) when you run `incus-benchmark`:
You can also assign an alias to the image and specify that alias (for example, `debian`) when you run `incus-benchmark`:
incus image copy images:ubuntu/22.04 local: --alias ubuntu
incus image copy images:debian/12 local: --alias debian
Remote image
: If you want to include the download time in the overall result, specify a remote image (for example, `images:ubuntu/22.04`).
The default image that `incus-benchmark` uses is the latest Ubuntu image (`images:ubuntu`), so if you want to use this image, you can leave out the image name when running the tool.
: If you want to include the download time in the overall result, specify a remote image (for example, `images:debian/12`).
The default image that `incus-benchmark` uses is the latest Debian image (`images:debian/12`), so if you want to use this image, you can leave out the image name when running the tool.
### Create and launch containers
@@ -63,13 +63,13 @@ For example:
* - Command
- Description
* - `incus-benchmark init --count 10 --privileged`
- Create ten privileged containers that use the latest Ubuntu image.
- Create ten privileged containers that use the latest Debian image.
* - `incus-benchmark init --count 20 --parallel 4 images:alpine/edge`
- Create 20 containers that use the Alpine Edge image, using four parallel threads.
* - `incus-benchmark init 2d21da400963`
- Create one container that uses the local image with the fingerprint `2d21da400963`.
* - `incus-benchmark init --count 10 ubuntu`
- Create ten containers that use the image with the alias `ubuntu`.
* - `incus-benchmark init --count 10 debian`
- Create ten containers that use the image with the alias `debian`.
```

2
doc/howto/cluster_groups.md
View File

@@ -49,7 +49,7 @@ See {ref}`clustering-instance-placement` for more information.
To launch an instance on a member of a cluster group, follow the instructions in {ref}`cluster-target-instance`, but use the group name prefixed with `@` for the `--target` flag.
For example:
incus launch images:ubuntu/22.04 c1 --target=@gpu
incus launch images:debian/12 c1 --target=@gpu
## Use with restricted projects

2
doc/howto/cluster_manage_instance.md
View File

@@ -12,7 +12,7 @@ You can do this from any cluster member.
For example, to launch an instance named `c1` on the cluster member `server2`, use the following command:
incus launch images:ubuntu/22.04 c1 --target server2
incus launch images:debian/12 c1 --target server2
You can launch instances on specific cluster members or on specific {ref}`cluster groups <howto-cluster-groups>`.

16
doc/howto/images_manage.md
View File

@@ -16,19 +16,19 @@ If you do not specify a remote, the {ref}`default remote <images-remote-default>
### Filter available images
To filter the results that are displayed, specify a part of the alias or fingerprint after the command.
For example, to show all Ubuntu 22.04 images, enter the following command:
For example, to show all Debian images, enter the following command:
incus image list images: 22.04
incus image list images: debian
You can specify several filters as well.
For example, to show all Arm 64-bit Ubuntu 22.04 images, enter the following command:
For example, to show all Arm 64-bit Debian images, enter the following command:
incus image list images: 22.04 arm64
incus image list images: debian arm64
To filter for properties other than alias or fingerprint, specify the filter in `<key>=<value>` format.
For example:
incus image list images: 22.04 architecture=x86_64
incus image list images: debian architecture=x86_64
## View image information
@@ -37,7 +37,7 @@ To view information about an image, enter the following command:
incus image info <image_ID>
As the image ID, you can specify either the image's alias or its fingerprint.
For a remote image, remember to include the remote server (for example, `images:ubuntu/22.04`).
For a remote image, remember to include the remote server (for example, `images:debian/12`).
To display only the image properties, enter the following command:
@@ -47,9 +47,9 @@ You can also display a specific image property (located under the `properties` k
incus image get-property <image_ID> <key>
For example, to show the release name of the official Ubuntu 22.04 image, enter the following command:
For example, to show the release name of the latest Debian 12 image, enter the following command:
incus image get-property images:ubuntu/22.04 release
incus image get-property images:debian/12 release
(images-manage-edit)=
## Edit image properties

4
doc/howto/images_remote.md
View File

@@ -59,8 +59,8 @@ You are prompted to confirm the remote server fingerprint and then asked for the
To reference an image, specify its remote and its alias or fingerprint, separated with a colon.
For example:
images:ubuntu/22.04
images:ubuntu/22.04
images:debian/12
images:debian/12
local:ed7509d7e83f
(images-remote-default)=

2
doc/howto/incus_alias.md
View File

@@ -104,7 +104,7 @@ Several Incus images have been configured to create a non-root username as shown
| :----------- | :--------------: | :----------- |
| Alpine | `alpine` | `images:alpine/edge/cloud` |
| Debian | `debian` | `images:debian/12/cloud` |
| Fedora | `fedora` | `images:fedora/40/cloud` |
| Fedora | `fedora` | `images:fedora/42/cloud` |
| Ubuntu | `ubuntu` | `images:ubuntu/24.04/cloud` |
You can get a shell into the instance for this non-root username with the following command.

20
doc/howto/instances_create.md
View File

@@ -15,7 +15,7 @@ Image
Images for various operating systems are available on the built-in remote image servers.
See {ref}`images` for more information.
Unless the image is available locally, you must specify the name of the image server and the name of the image (for example, `images:ubuntu/22.04` for the official 22.04 Ubuntu image).
Unless the image is available locally, you must specify the name of the image server and the name of the image (for example, `images:debian/12` for a Debian 12 image).
Instance name
: Instance names must be unique within an Incus deployment (also within a cluster).
@@ -38,7 +38,7 @@ Instead of specifying the instance configuration as flags, you can pass it to th
For example, to launch a container with the configuration from `config.yaml`, enter the following command:
incus launch images:ubuntu/22.04 ubuntu-config < config.yaml
incus launch images:debian/12 debian-config < config.yaml
```{tip}
Check the contents of an existing instance configuration ([`incus config show <instance_name> --expanded`](incus_config_show.md)) to see the required syntax of the YAML file.
@@ -50,9 +50,9 @@ The following examples use [`incus launch`](incus_launch.md), but you can use [`
### Launch a system container
To launch a system container with an Ubuntu 22.04 image from the `images` server using the instance name `ubuntu-container`, enter the following command:
To launch a system container with a Debian 12 image from the `images` server using the instance name `debian-container`, enter the following command:
incus launch images:ubuntu/22.04 ubuntu-container
incus launch images:debian/12 debian-container
### Launch an application container
@@ -66,25 +66,25 @@ And then can launch a container from one of its images:
### Launch a virtual machine
To launch a virtual machine with an Ubuntu 22.04 image from the `images` server using the instance name `ubuntu-vm`, enter the following command:
To launch a virtual machine with a Debian 12 image from the `images` server using the instance name `debian-vm`, enter the following command:
incus launch images:ubuntu/22.04 ubuntu-vm --vm
incus launch images:debian/12 debian-vm --vm
Or with a bigger disk:
incus launch images:ubuntu/22.04 ubuntu-vm-big --vm --device root,size=30GiB
incus launch images:debian/12 debian-vm-big --vm --device root,size=30GiB
### Launch a container with specific configuration options
To launch a container and limit its resources to one vCPU and 192 MiB of RAM, enter the following command:
incus launch images:ubuntu/22.04 ubuntu-limited --config limits.cpu=1 --config limits.memory=192MiB
incus launch images:debian/12 debian-limited --config limits.cpu=1 --config limits.memory=192MiB
### Launch a VM on a specific cluster member
To launch a virtual machine on the cluster member `server2`, enter the following command:
incus launch images:ubuntu/22.04 ubuntu-container --vm --target server2
incus launch images:debian/12 debian-container --vm --target server2
### Launch a container with a specific instance type
@@ -105,7 +105,7 @@ For example, the following three instance types are equivalent:
To launch a container with this instance type, enter the following command:
incus launch images:ubuntu/22.04 my-instance --type t2.micro
incus launch images:debian/12 my-instance --type t2.micro
The list of supported clouds and instance types can be found at [`https://github.com/dustinkirkland/instance-type`](https://github.com/dustinkirkland/instance-type).

6
doc/howto/instances_manage.md
View File

@@ -20,7 +20,7 @@ You can also filter by name.
To list several instances, use a regular expression for the name.
For example:
incus list ubuntu.*
incus list debian.*
Enter [`incus list --help`](incus_list.md) to see all filter options.
```
@@ -33,7 +33,7 @@ You can use {ref}`rest-api-recursion` to display more information about the inst
You can {ref}`filter <rest-api-filtering>` the instances that are displayed, by name, type, status or the cluster member where the instance is located:
incus query /1.0/instances?filter=name+eq+ubuntu
incus query /1.0/instances?filter=name+eq+debian
incus query /1.0/instances?filter=type+eq+container
incus query /1.0/instances?filter=status+eq+running
incus query /1.0/instances?filter=location+eq+server1
@@ -41,7 +41,7 @@ You can {ref}`filter <rest-api-filtering>` the instances that are displayed, by
To list several instances, use a regular expression for the name.
For example:
incus query /1.0/instances?filter=name+eq+ubuntu.*
incus query /1.0/instances?filter=name+eq+debian.*
See [`GET /1.0/instances`](swagger:/instances/instances_get) for more information.
```

2
doc/howto/instances_routed_nic_vm.md
View File

@@ -7,7 +7,7 @@ For virtual machines, the gateways must be configured manually or via a mechanis
To configure the gateways with `cloud-init`, firstly initialize an instance:
incus init images:ubuntu/22.04 jammy --vm
incus init images:debian/12 jammy --vm
Then add the routed NIC device:

10
doc/howto/network_ovn_setup.md
View File

@@ -25,7 +25,7 @@ Complete the following steps to create a standalone OVN network that is connecte
1. Create an instance that uses the `ovntest` network:
incus init images:ubuntu/22.04 c1
incus init images:debian/12 c1
incus config device override c1 eth0 network=ovntest
incus start c1
@@ -164,10 +164,10 @@ In addition, you can add any number of servers to the Incus cluster that run onl
1. To test the OVN network, create some instances and check the network connectivity:
incus launch images:ubuntu/22.04 c1 --network my-ovn
incus launch images:ubuntu/22.04 c2 --network my-ovn
incus launch images:ubuntu/22.04 c3 --network my-ovn
incus launch images:ubuntu/22.04 c4 --network my-ovn
incus launch images:debian/12 c1 --network my-ovn
incus launch images:debian/12 c2 --network my-ovn
incus launch images:debian/12 c3 --network my-ovn
incus launch images:debian/12 c4 --network my-ovn
incus list
incus exec c4 -- bash
ping <IP of c1>

2
doc/howto/projects_work.md
View File

@@ -78,7 +78,7 @@ If you create a project with the default settings, profiles are isolated in the
Therefore, the project does not have access to the default profile (which is part of the `default` project), and you will see an error similar to the following when trying to create an instance:
```{terminal}
:input: incus launch images:ubuntu/22.04 my-instance
:input: incus launch images:debian/12 my-instance
Creating my-instance
Error: Failed instance creation: Failed creating instance record: Failed initializing instance: Failed getting root disk: No root device could be found

4
doc/howto/server_migrate_lxd.md
View File

@@ -56,8 +56,8 @@ Uninstall the LXD package? [default=no]: yes
```{terminal}
:input: incus list
:user: root
To start your first container, try: incus launch images:ubuntu/22.04
Or for a virtual machine: incus launch images:ubuntu/22.04 --vm
To start your first container, try: incus launch images:debian/12
Or for a virtual machine: incus launch images:debian/12 --vm
+------+---------+-----------------------+------------------------------------------------+-----------+-----------+
| NAME | STATE | IPV4 | IPV6 | TYPE | SNAPSHOTS |

4
doc/howto/storage_linstor_setup.md
View File

@@ -128,11 +128,11 @@ It's also worth noting that we'll be using LVM Thin as the LINSTOR storage backe
1. To test the storage, create some volumes and instances:
incus launch images:ubuntu/24.04 c1 --storage remote
incus launch images:debian/12 c1 --storage remote
incus storage volume create remote fsvol
incus storage volume attach remote fsvol c1 /mnt
incus launch images:ubuntu/24.04 v1 --storage remote --vm -c migration.stateful=true
incus launch images:debian/12 v1 --storage remote --vm -c migration.stateful=true
incus storage volume create remote vol --type block size=42GiB
incus storage volume attach remote vol v1

2
doc/instance-exec.md
View File

@@ -17,7 +17,7 @@ To run a single command from the terminal of the host machine, use the [`incus e
For example, enter the following command to update the package list on your container:
incus exec ubuntu-container -- apt-get update
incus exec debian-container -- apt-get update
### Execution mode

6
doc/reference/image_format.md
View File

@@ -35,9 +35,9 @@ It includes the following information:
architecture: x86_64
creation_date: 1424284563
properties:
description: Ubuntu 22.04 LTS Intel 64bit
os: Ubuntu
release: jammy 22.04
description: Debian 12 Intel 64bit
os: Debian
release: bookworm 12
templates:
...
```

24
doc/tutorial/first_steps.md
View File

@@ -61,9 +61,9 @@ See {ref}`containers-and-vms` for information about the difference between the t
For managing instances, we use the Incus command line client `incus`.
1. Launch a container called `first` using the Ubuntu 22.04 image:
1. Launch a container called `first` using the Debian 12 image:
incus launch images:ubuntu/22.04 first
incus launch images:debian/12 first
```{note}
Launching this container takes a few seconds, because the image must be downloaded and unpacked first.
@@ -71,7 +71,7 @@ For managing instances, we use the Incus command line client `incus`.
1. Launch a container called `second` using the same image:
incus launch images:ubuntu/22.04 second
incus launch images:debian/12 second
```{note}
Launching this container is quicker than launching the first, because the image is already available.
@@ -81,9 +81,9 @@ For managing instances, we use the Incus command line client `incus`.
incus copy first third
1. Launch a VM called `ubuntu-vm` using the Ubuntu 22.04 image:
1. Launch a VM called `debian-vm` using the Debian 12 image:
incus launch images:ubuntu/22.04 ubuntu-vm --vm
incus launch images:debian/12 debian-vm --vm
```{note}
Even though you are using the same image name to launch the instance, Incus downloads a slightly different image that is compatible with VMs.
@@ -105,7 +105,7 @@ For managing instances, we use the Incus command line client `incus`.
incus info first
incus info second
incus info third
incus info ubuntu-vm
incus info debian-vm
1. We don't need all of these instances for the remainder of the tutorial, so let's clean some of them up:
@@ -137,7 +137,7 @@ Let's create another container with some resource limits:
1. Launch a container and limit it to one vCPU and 192 MiB of RAM:
incus launch images:ubuntu/22.04 limited --config limits.cpu=1 --config limits.memory=192MiB
incus launch images:debian/12 limited --config limits.cpu=1 --config limits.memory=192MiB
1. Check the current configuration and compare it to the configuration of the first (unlimited) container:
@@ -184,10 +184,10 @@ Let's create another container with some resource limits:
1. Depending on the instance type and the storage drivers that you use, there are more configuration options that you can specify.
For example, you can configure the size of the root disk device for a VM:
1. Check the current size of the root disk device of the Ubuntu VM:
1. Check the current size of the root disk device of the Debian VM:
```{terminal}
:input: incus exec ubuntu-vm -- df -h
:input: incus exec debian-vm -- df -h
Filesystem Size Used Avail Use% Mounted on
/dev/root 9.6G 1.4G 8.2G 15% /
@@ -200,16 +200,16 @@ Let's create another container with some resource limits:
1. Override the size of the root disk device:
incus config device override ubuntu-vm root size=30GiB
incus config device override debian-vm root size=30GiB
1. Restart the VM:
incus restart ubuntu-vm
incus restart debian-vm
1. Check the size of the root disk device again:
```{terminal}
:input: incus exec ubuntu-vm -- df -h
:input: incus exec debian-vm -- df -h
Filesystem Size Used Avail Use% Mounted on
/dev/root 29G 1.4G 28G 5% /