Skip to content

Commit

Permalink
Merge pull request #13292 from ru-fu/image-server-doc
Browse files Browse the repository at this point in the history
Doc: add back information about the `images:` remote
  • Loading branch information
tomponline authored Apr 9, 2024
2 parents 329746c + 2b42503 commit 8899582
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 8 deletions.
9 changes: 7 additions & 2 deletions doc/cloud-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,15 @@ The `cloud-init` actions are run only once on the first start of the instance.
Rebooting the instance does not re-trigger the actions.
```

(cloud-init-support)=
## `cloud-init` support in images

To use `cloud-init`, you must base your instance on an image that has `cloud-init` installed, which is the case for all images from the `ubuntu` and `ubuntu-daily` {ref}`image servers <remote-image-servers>`.
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 {ref}`vm-cloud-init-config`.
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).
* 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`.

## Configuration options

Expand Down
1 change: 1 addition & 0 deletions doc/external_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@
:maxdepth: 1
Project repository <https://github.com/canonical/lxd>
Image server <https://images.lxd.canonical.com>
```
1 change: 1 addition & 0 deletions doc/howto/images_remote.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ For example:

ubuntu:22.04
ubuntu-minimal:22.04
images:alpine/edge
local:ed7509d7e83f

(images-remote-default)=
Expand Down
6 changes: 1 addition & 5 deletions doc/howto/instances_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,11 +237,7 @@ To create a container with this instance type, enter the following command:
```
````

The list of supported clouds and instance types can be found here:

- [Amazon Web Services](https://raw.githubusercontent.com/canonical/lxd/main/meta/instance-types/aws.yaml)
- [Google Compute Engine](https://raw.githubusercontent.com/canonical/lxd/main/meta/instance-types/gce.yaml)
- [Microsoft Azure](https://raw.githubusercontent.com/canonical/lxd/main/meta/instance-types/azure.yaml)
The list of supported clouds and instance types can be found at [`images.lxd.canonical.com/meta/instance-types/`](https://images.lxd.canonical.com/meta/instance-types/).

### Create a VM that boots from an ISO

Expand Down
1 change: 1 addition & 0 deletions doc/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,5 @@ However, advanced users might be interested in knowing what happens internally.
:hidden:
Project repository <https://github.com/canonical/lxd>
Image server <https://images.lxd.canonical.com>
```
13 changes: 12 additions & 1 deletion doc/reference/remote_image_servers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: 16647
discourse: ubuntu:43824,16647
relatedlinks: https://www.youtube.com/watch?v=pM0EgUqj2a0
---

Expand All @@ -8,6 +8,17 @@ relatedlinks: https://www.youtube.com/watch?v=pM0EgUqj2a0

The [`lxc`](lxc.md) CLI command comes pre-configured with the following default remote image servers:

`images:`
: This server provides unofficial images for a variety of Linux distributions.
The images are built to be compact and minimal, and therefore the default image variants do not include `cloud-init`.
Where possible, `/cloud` variants that include `cloud-init` are provided.
See [`cloud-init` support in images](cloud-init-support).

This server does not provide official Ubuntu images (for those, use the `ubuntu:` server).
It does, however, provide desktop variants of current Ubuntu releases.

See [`images.lxd.canonical.com`](https://images.lxd.canonical.com) for an overview of available images.

`ubuntu:`
: This server provides official stable Ubuntu images.
All images are cloud images, which means that they include both `cloud-init` and the `lxd-agent`.
Expand Down

0 comments on commit 8899582

Please sign in to comment.