Skip to content

Commit 5e93f28

Browse files
committed
docs: Implement incus_image_alias resource
Signed-off-by: Ruihua Wen <[email protected]>
1 parent 0052616 commit 5e93f28

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/resources/image_alias.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# incus_image_alias
2+
3+
Manages a locally-stored Incus image alias.
4+
5+
## Example Usage
6+
7+
```hcl
8+
resource "incus_image" "alpine" {
9+
source_image = {
10+
remote = "images"
11+
name = "alpine/edge"
12+
}
13+
}
14+
15+
resource "incus_image_alias" "alpine" {
16+
alias = "alpine"
17+
description = "Alpine Edge"
18+
fingerprint = incus_image.alpine.fingerprint
19+
}
20+
```
21+
22+
## Argument Reference
23+
24+
* `alias` - *Required* - An alias to assign to the image after pulling.
25+
26+
* `description` - *Optional* - Description of the image alias.
27+
28+
* `fingerprint` - *Required* - The unique hash fingperint of the image.
29+
30+
* `project` - *Optional* - Name of the project where the image will be stored.
31+
32+
* `remote` - *Optional* - The remote in which the resource will be created. If
33+
not provided, the provider's default remote will be used.

0 commit comments

Comments
 (0)