Skip to content
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.

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

doc: small fixes #13669

Merged
merged 4 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ update-metadata: build
.PHONY: doc
doc: doc-clean doc-install doc-html doc-objects

.PHONY: doc-incremental
doc-incremental: doc-html

doc-%:
cd doc && $(MAKE) -f Makefile $*

Expand Down
4 changes: 2 additions & 2 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ objects:
lint:
.sphinx/.markdownlint/doc-lint.sh

.PHONY: html incremental
html incremental:
.PHONY: html
html:
$(MAKE) -f Makefile.sp sp-html LOCAL_SPHINX_BUILD=True ADDPREREQS='gitpython pyyaml'

%:
Expand Down
2 changes: 1 addition & 1 deletion doc/cloud-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,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:

* All images from the `ubuntu` and `ubuntu-daily` {ref}`image servers <remote-image-servers>` have `cloud-init` support.
However, images for Ubuntu releases prior to `20.04` require special handling to integrate properly with `cloud-init`, so that `lxc exec` works correctly with virtual machines that use those images. Refer to [VM `cloud-init`](vm-cloud-init-config).
However, images for Ubuntu releases prior to 20.04 LTS require special handling to integrate properly with `cloud-init`, so that `lxc exec` works correctly with virtual machines that use those images. Refer to [VM `cloud-init`](vm-cloud-init-config).
* Images from the [`images` remote](https://images.lxd.canonical.com/) 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:alpine/edge/cloud`.

Expand Down
1 change: 0 additions & 1 deletion doc/custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@
'http://localhost:8000',
r'/lxd/en/latest/api/.*',
r'/api/.*',
r'https://maas\.io/docs/.*'
]

# Pages on which to ignore anchors
Expand Down
6 changes: 3 additions & 3 deletions doc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ The easiest fix for this problem is to stop the VPN client and unmount the `net_
If you need to keep the VPN client running, mount the `net_cls` cgroup1 in another location and reconfigure your VPN client accordingly.
See [this Discourse post](https://discuss.linuxcontainers.org/t/help-help-help-cgroup2-related-issue-on-ubuntu-jammy-with-mullvad-and-privateinternetaccess-vpn/14705/18) for instructions for Mullvad VPN.

## Why does LXD not start on Ubuntu 20.04 or earlier?
## Why does LXD not start on Ubuntu 20.04 LTS or earlier?

If you are running LXD on Ubuntu 20.04 or earlier, you might be missing support for ZFS 2.1 in the kernel (see the {ref}`requirements <requirements-zfs>`).
If you are running LXD on Ubuntu 20.04 LTS or earlier, you might be missing support for ZFS 2.1 in the kernel (see the {ref}`requirements <requirements-zfs>`).

If LXD fails to start, check the `/var/snap/lxd/common/lxd/logs/lxd.log` log file for the following error to see if the reason is missing ZFS support:

Error: Required tool ‘zpool’ is missing

If you are on Ubuntu 20.04, you can resolve the issue by installing the HWE kernel and rebooting the nodes to provide the required kernel drivers for ZFS 2.1:
If you are on Ubuntu 20.04 LTS, you can resolve the issue by installing the HWE kernel and rebooting the nodes to provide the required kernel drivers for ZFS 2.1:

sudo apt-get update
sudo apt-get install linux-generic-hwe-20.04
Expand Down
2 changes: 1 addition & 1 deletion doc/howto/benchmark_performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ For example:
* - `lxd-benchmark init --count 10 --privileged`
- Create ten privileged containers that use the latest Ubuntu image.
* - `lxd-benchmark init --count 20 --parallel 4 ubuntu-minimal:24.04`
- Create 20 containers that use the Ubuntu Minimal 24.04 image, using four parallel threads.
- Create 20 containers that use the Ubuntu Minimal 24.04 LTS image, using four parallel threads.
* - `lxd-benchmark init 2d21da400963`
- Create one container that uses the local image with the fingerprint `2d21da400963`.
* - `lxd-benchmark init --count 10 ubuntu`
Expand Down
8 changes: 4 additions & 4 deletions doc/howto/images_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ Go to {guilabel}`Images` to view all images on the local server.
````{tabs}
```{group-tab} CLI
To filter the results that are displayed, specify a part of the alias or fingerprint after the command.
For example, to show all Ubuntu 24.04 images, enter the following command:
For example, to show all Ubuntu 24.04 LTS images, enter the following command:

lxc image list ubuntu: 24.04

You can specify several filters as well.
For example, to show all Arm 64-bit Ubuntu 24.04 images, enter the following command:
For example, to show all Arm 64-bit Ubuntu 24.04 LTS images, enter the following command:

lxc image list ubuntu: 24.04 arm64

Expand All @@ -64,7 +64,7 @@ For example:
```{group-tab} API
You can {ref}`filter <rest-api-filtering>` the images that are displayed by any of their fields.

For example, to show all Ubuntu images, or all images for version 24.04:
For example, to show all Ubuntu images, or all images for Ubuntu 24.04 LTS:

lxc query --request GET /1.0/images?filter=properties.os+eq+ubuntu
lxc query --request GET /1.0/images?filter=properties.version+eq+24.04
Expand Down Expand Up @@ -107,7 +107,7 @@ You can also display a specific image property (located under the `properties` k

lxc image get-property <image_ID> <key>

For example, to show the release name of the official Ubuntu 24.04 image, enter the following command:
For example, to show the release name of the official Ubuntu 24.04 LTS image, enter the following command:

lxc image get-property ubuntu:24.04 release
```
Expand Down
10 changes: 5 additions & 5 deletions doc/howto/instances_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Enter the following command to create a container:

lxc launch|init <image_server>:<image_name> <instance_name> [flags]

Unless the image is available locally, you must specify the name of the image server and the name of the image (for example, `ubuntu:24.04` for the official 24.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, `ubuntu:24.04` for the official Ubuntu 24.04 LTS image).

See [`lxc launch --help`](lxc_launch.md) or [`lxc init --help`](lxc_init.md) for a full list of flags.
The most common flags are:
Expand Down Expand Up @@ -102,7 +102,7 @@ In the UI, you can choose between {guilabel}`Create` and {guilabel}`Create and s

### Create a container

To create a container with an Ubuntu 24.04 image from the `ubuntu` server using the instance name `ubuntu-container`:
To create a container with an Ubuntu 24.04 LTS image from the `ubuntu` server using the instance name `ubuntu-container`:

`````{tabs}
```{group-tab} CLI
Expand All @@ -122,14 +122,14 @@ To create a container with an Ubuntu 24.04 image from the `ubuntu` server using
````{group-tab} UI
```{figure} /images/UI/create_instance_ex1.png
:width: 80%
:alt: Create an Ubuntu 24.04 container
:alt: Create an Ubuntu 24.04 LTS container
```
````
`````

### Create a virtual machine

To create a virtual machine with an Ubuntu 24.04 image from the `ubuntu` server using the instance name `ubuntu-vm`:
To create a virtual machine with an Ubuntu 24.04 LTS image from the `ubuntu` server using the instance name `ubuntu-vm`:

`````{tabs}
```{group-tab} CLI
Expand All @@ -150,7 +150,7 @@ To create a virtual machine with an Ubuntu 24.04 image from the `ubuntu` server
````{group-tab} UI
```{figure} /images/UI/create_instance_ex2.png
:width: 80%
:alt: Create an Ubuntu 24.04 VM
:alt: Create an Ubuntu 24.04 LTS VM
```
````
`````
Expand Down
2 changes: 1 addition & 1 deletion doc/howto/instances_routed_nic_vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To configure the gateways with `cloud-init`, firstly initialize an instance:
````{group-tab} UI
```{figure} /images/UI/routed_nic_create_instance.png
:width: 80%
:alt: Create an Ubuntu 24.04 VM
:alt: Create an Ubuntu 24.04 LTS VM
```
````
`````
Expand Down
4 changes: 2 additions & 2 deletions doc/installing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: ubuntu:37214, ubuntu:37327
discourse: ubuntu:37327
---

(installing)=
Expand Down Expand Up @@ -66,7 +66,7 @@ Complete the following steps to install the snap:
For more information about LXD snap packages (regarding more versions, update management etc.), see [Managing the LXD snap](https://discuss.linuxcontainers.org/t/managing-the-lxd-snap/8178).

```{note}
On Ubuntu 18.04, if you previously had the LXD deb package installed, you can migrate all your existing data over by installing the 5.0 snap and running the following commands:
On Ubuntu 18.04 LTS, if you previously had the LXD deb package installed, you can migrate all your existing data over by installing the 5.0 snap and running the following commands:

sudo install lxd --channel=5.0/stable
sudo lxd.migrate
Expand Down
4 changes: 2 additions & 2 deletions doc/tutorial/first_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ See {ref}`containers-and-vms` for information about the difference between the t
For managing instances, we use the LXD command line client `lxc`.
See [About `lxd` and `lxc`](lxd-lxc) if you are confused about when to use the `lxc` command and when to use the `lxd` command.

1. Launch a container called `first` using the Ubuntu 24.04 image:
1. Launch a container called `first` using the Ubuntu 24.04 LTS image:

lxc launch ubuntu:24.04 first

Expand All @@ -107,7 +107,7 @@ See [About `lxd` and `lxc`](lxd-lxc) if you are confused about when to use the `

lxc copy first third

1. Launch a VM called `ubuntu-vm` using the Ubuntu 24.04 image:
1. Launch a VM called `ubuntu-vm` using the Ubuntu 24.04 LTS image:

lxc launch ubuntu:24.04 ubuntu-vm --vm

Expand Down
Loading