Skip to content

Commit

Permalink
docs: Add source_file to incus_image
Browse files Browse the repository at this point in the history
Signed-off-by: Lucas Bremgartner <[email protected]>
  • Loading branch information
breml committed Nov 20, 2024
1 parent 9ff42c4 commit cf5c5a2
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/resources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,27 @@ resource "incus_instance" "test1" {

## Argument Reference

* `source_file` - *Optional* - The image file from the local file system from which the image will be created. See reference below.

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

* `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.
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
not provided, the provider's default remote will be used.
not provided, the provider's default remote will be used.

The `source_file` block supports:

* `data_path` - **Required** - Either the path of an [unified image](https://linuxcontainers.org/incus/docs/main/reference/image_format/#image-format-unified)
or the rootfs tarball of a [split image](https://linuxcontainers.org/incus/docs/main/reference/image_format/#image-format-split), depending on
`metadata_path` being provided or not.

* `metadata_path` - *Optional* - Path to the metadata tarball of a [split image](https://linuxcontainers.org/incus/docs/main/reference/image_format/#image-format-split).

The `source_image` block supports:

Expand Down

0 comments on commit cf5c5a2

Please sign in to comment.