generated from hashicorp/terraform-provider-scaffolding
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for packer_bucket_channel resource
- Loading branch information
Showing
5 changed files
with
107 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
page_title: "Resource hcp_packer_bucket_channel - terraform-provider-hcp" | ||
subcategory: "" | ||
description: |- | ||
The Packer Bucket Channel resource allow you to manage a channel within an active HCP Packer Registry bucket. | ||
--- | ||
|
||
# hcp_packer_bucket_channel (Resource) | ||
|
||
The Packer Bucket Channel resource allow you to manage a channel within an active HCP Packer Registry bucket. | ||
|
||
## Example Usage | ||
|
||
To create a channel with no assigned iteration. | ||
```terraform | ||
resource "hcp_packer_bucket_channel" "staging" { | ||
name = "staging" | ||
bucket_name = "alpine" | ||
} | ||
``` | ||
|
||
To create, or update an existing, managed channel with an assigned iteration. | ||
```terraform | ||
resource "hcp_packer_bucket_channel" "staging" { | ||
name = "staging" | ||
bucket_name = "alpine" | ||
assigned_iteration_id = "iteration-id" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `bucket_name` (String) The slug of the HCP Packer Registry image bucket where the channel should be managed in. | ||
- `name` (String) The name of the channel being managed. | ||
|
||
### Optional | ||
|
||
- `assigned_iteration_id` (String) The iteration id to assign to the channel. | ||
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) | ||
|
||
### Read-Only | ||
|
||
- `assigned_iteration_version` (Number) The incremental version of the iteration assigned to the channel. | ||
- `author_id` (String) The author of the channel. | ||
- `created_at` (String) Creation time of this build. | ||
- `id` (String) The ID of this resource. | ||
- `organization_id` (String) The ID of the organization this HCP Packer registry is located in. | ||
- `project_id` (String) The ID of the project this HCP Packer registry is located in. | ||
|
||
<a id="nestedblock--timeouts"></a> | ||
### Nested Schema for `timeouts` | ||
|
||
Optional: | ||
|
||
- `create` (String) | ||
- `default` (String) | ||
- `delete` (String) | ||
- `update` (String) | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
# The import ID requires the bucket and channel name in the following format {bucket_name}:{name} | ||
terraform import hcp_packer_bucket_channel.staging alping:staging | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# The import ID requires the bucket and channel name in the following format {bucket_name}:{name} | ||
terraform import hcp_packer_bucket_channel.staging alping:staging |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
resource "hcp_packer_bucket_channel" "staging" { | ||
name = "staging" | ||
bucket_name = "alpine" | ||
} |
5 changes: 5 additions & 0 deletions
5
examples/resources/hcp_packer_bucket_channel/resource_assignment.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
resource "hcp_packer_bucket_channel" "staging" { | ||
name = "staging" | ||
bucket_name = "alpine" | ||
assigned_iteration_id = "iteration-id" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}" | ||
subcategory: "" | ||
description: |- | ||
{{ .Description | plainmarkdown | trimspace | prefixlines " " }} | ||
--- | ||
|
||
# {{.Name}} ({{.Type}}) | ||
|
||
{{ .Description | trimspace }} | ||
|
||
## Example Usage | ||
|
||
To create a channel with no assigned iteration. | ||
{{ tffile "examples/resources/hcp_packer_bucket_channel/resource.tf" }} | ||
|
||
To create, or update an existing, managed channel with an assigned iteration. | ||
{{ tffile "examples/resources/hcp_packer_bucket_channel/resource_assignment.tf" }} | ||
|
||
{{ .SchemaMarkdown | trimspace }} | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
{{ codefile "shell" "examples/resources/hcp_packer_bucket_channel/import.sh" }} |