Skip to content
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
30 changes: 27 additions & 3 deletions docs/resources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,28 @@ resource "incus_instance" "test1" {
}
```

## Image alias Example

```hcl
resource "incus_image" "alpine" {
source_image = {
remote = "images"
name = "alpine/edge"
}

alias {
name = "alpine"
description = "Alpine Linux"
}

alias {
name = "alpine-edge"
description = "Alpine Linux Edge"
}
}

```

## Argument Reference

* `source_file` - *Optional* - The image file from the local file system from which the image will be created. See reference below.
Expand All @@ -27,9 +49,6 @@ resource "incus_instance" "test1" {

* `source_instance` - *Optional* - The source instance from which the image will be created. See reference below.

* `aliases` - *Optional* - A list of aliases to assign to the image after
pulling.

* `project` - *Optional* - Name of the project where the image will be stored.

* `remote` - *Optional* - The remote in which the resource will be created. If
Expand Down Expand Up @@ -63,6 +82,11 @@ The `source_instance` block supports:

* `snapshot`- *Optional* - Name of the snapshot of the source instance

The `alias` block supports:

* `name` - **Required** - The name of the alias.
* `description` - *Optional* - A description for the alias.

## Attribute Reference

The following attributes are exported:
Expand Down
Loading