Skip to content

Commit

Permalink
Merge pull request #9 from maveonair/improve-documentation
Browse files Browse the repository at this point in the history
Documentation: Refer to instance rather than container
  • Loading branch information
stgraber authored Dec 18, 2023
2 parents 77286a0 + a288d54 commit fd72135
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions docs/resources/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ An instance can take a number of configuration and device options. A full refere
## Basic Example

```hcl
resource "incus_instance" "container1" {
name = "container1"
resource "incus_instance" "instance1" {
name = "instance1"
image = "images:ubuntu/22.04"
config = {
Expand All @@ -34,7 +34,7 @@ resource "incus_volume" "volume1" {
pool = incus_storage_pool.pool1.name
}
resource "incus_instance" "container1" {
resource "incus_instance" "instance1" {
name = "%s"
image = "ubuntu"
Expand All @@ -53,8 +53,8 @@ resource "incus_instance" "container1" {
## Example to proxy/forward ports

```hcl
resource "incus_instance" "container2" {
name = "container2"
resource "incus_instance" "instance2" {
name = "instance2"
image = "ubuntu"
profiles = ["default"]
ephemeral = false
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ for more details on how to create a network in clustered mode.
## Argument Reference

* `name` - **Required** - Name of the network. This is usually the device the
network will appear as to containers.
network will appear as to instances.

* `description` - *Optional* - Description of the network.

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ resource "incus_instance" "test1" {

## Argument Reference

* `name` - **Required** - Name of the container.
* `name` - **Required** - Name of the profile.

* `device` - *Optional* - Device definition. See reference below.

* `config` - *Optional* - Map of key/value pairs of
[container config settings](https://linuxcontainers.org/incus/docs/main/reference/instance_options/).
[instance config settings](https://linuxcontainers.org/incus/docs/main/reference/instance_options/).

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

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ resource "incus_project" "project" {
}
}
resource "incus_instance" "container" {
name = "container1"
resource "incus_instance" "instance" {
name = "instance1"
image = "images:alpine/3.18/amd64"
project = incus_project.project.name
}
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/publish_image.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# incus_publish_image

Create an Incus image from a container
Create an Incus image from an instance

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/snapshot.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# incus_snapshot

Manages a snapshot of an Incus container.
Manages a snapshot of an Incus instance.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ resource "incus_volume" "volume1" {
* `description` - *Optional* - Description of the volume.

* `type` - *Optional* - The "type" of volume. The default value is `custom`,
which is the type to use for storage volumes attached to containers.
which is the type to use for storage volumes attached to instances.

* `content_type` - *Optional* - Volume content type (`filesystem` or `block`)

Expand Down Expand Up @@ -84,7 +84,7 @@ import {

## Notes

* Technically, an Incus volume is simply a container or profile device of
* Technically, an Incus volume is simply an instance or profile device of
type `disk`.

* The volume resource `config` includes some keys that can be automatically generated by the Incus.
Expand Down

0 comments on commit fd72135

Please sign in to comment.