Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rearrange banners in documentation for consistency #211

Merged
merged 2 commits into from
Oct 21, 2021
Merged

Rearrange banners in documentation for consistency #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc1560e
Rearrange banners for consistency
efgold Oct 21, 2021
4aeda11
Run rendering website for provider "terraform-provider-hcp"
efgold Oct 21, 2021
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
4 changes: 2 additions & 2 deletions docs/resources/aws_transit_gateway_attachment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: |-

# hcp_aws_transit_gateway_attachment (Resource)

~> **Security Notice:** This resource contains sensitive input. Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform.

The AWS transit gateway attachment resource allows you to manage a transit gateway attachment. The transit gateway attachment attaches an HVN to a user-owned transit gateway in AWS. Note that the HVN and transit gateway must be located in the same AWS region.

## Example Usage
Expand Down Expand Up @@ -72,8 +74,6 @@ resource "aws_ec2_transit_gateway_vpc_attachment_accepter" "example" {
}
```

~> **Security Notice:** This resource contains sensitive input. Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform.

<!-- schema generated by tfplugindocs -->
## Schema

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/vault_cluster_admin_token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ description: |-

~> **Security Notice:** Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform.

~> **Known Issue:** An admin token may be generated during a `terraform plan` if the current token is expiring.
Since the Plan phase does not save any state, the Apply phase saves a different generated token, and the token generated during Plan ends up orphaned.
It will expire in six hours.

The Vault cluster admin token resource generates an admin-level token for the HCP Vault cluster.

This resource saves a single admin token per Vault cluster and auto-refreshes the token when it is about to expire.
Destroying this resource *does not* invalidate the admin token.

~> **Known Issue:** An admin token may be generated during a `terraform plan` if the current token is expiring.
Since the Plan phase does not save any state, the Apply phase saves a different generated token, and the token generated during Plan ends up orphaned.
It will expire in six hours.

## Example Usage

```terraform
Expand Down
4 changes: 2 additions & 2 deletions templates/resources/aws_transit_gateway_attachment.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ description: |-

# {{.Type}} ({{.Name}})

~> **Security Notice:** This resource contains sensitive input. Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform.

{{ .Description | trimspace }}

## Example Usage

{{ tffile "examples/resources/hcp_aws_transit_gateway_attachment/resource.tf" }}

~> **Security Notice:** This resource contains sensitive input. Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform.

{{ .SchemaMarkdown | trimspace }}

## Import
Expand Down
8 changes: 4 additions & 4 deletions templates/resources/vault_cluster_admin_token.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ description: |-

~> **Security Notice:** Please see this [list of recommendations](https://www.terraform.io/docs/language/state/sensitive-data.html) for storing sensitive information in Terraform.

~> **Known Issue:** An admin token may be generated during a `terraform plan` if the current token is expiring.
Since the Plan phase does not save any state, the Apply phase saves a different generated token, and the token generated during Plan ends up orphaned.
It will expire in six hours.

{{ .Description | trimspace }}

This resource saves a single admin token per Vault cluster and auto-refreshes the token when it is about to expire.
Destroying this resource *does not* invalidate the admin token.

~> **Known Issue:** An admin token may be generated during a `terraform plan` if the current token is expiring.
Since the Plan phase does not save any state, the Apply phase saves a different generated token, and the token generated during Plan ends up orphaned.
It will expire in six hours.

## Example Usage

{{ tffile "examples/resources/hcp_vault_cluster_admin_token/resource.tf" }}
Expand Down