Skip to content

Commit

Permalink
Remove suffix ( - HCP Provider) from page name of guides (#710)
Browse files Browse the repository at this point in the history
* Remove suffix ( - HCP Provider) from page name of guides

* Azure Peering Guide (#712)

* Stub azure peering guide

* Move AWS peering guide files into separate organization

* Stub Azure terraform config files for peering guide

* Remove data source note from peering resource

* Base Azure Peering guide

* Add Azure gateway example to Azure peering guide

* Add Azure NVA example to Azure peering guide

* Additional revisions from review feedback

* Backticks to single
  • Loading branch information
jasonpilz authored Jan 18, 2024
1 parent 35ff276 commit 4f9cc28
Show file tree
Hide file tree
Showing 42 changed files with 1,171 additions and 63 deletions.
2 changes: 1 addition & 1 deletion docs/guides/auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Authenticate with HCP - HCP Provider"
page_title: "Authenticate with HCP"
description: |-
A guide to obtaining HCP credentials and adding them to provider configuration.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consul-federation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Consul Federation with Auto HVN Peering - HCP Provider"
page_title: "Consul Federation with Auto HVN Peering"
description: |-
An example of federating a new HCP Consul cluster with an existing one via auto peering.
---
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/consul-root-token.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Create a new ACL root token - HCP Provider"
page_title: "Create a new ACL root token"
description: |-
An example of creating a new ACL root token.
---
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/consul-snapshots.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Create Consul cluster snapshots in HCP - HCP Provider"
page_title: "Create Consul cluster snapshots in HCP"
description: |-
An example of creating an HCP Consul cluster snapshot.
---
Expand Down Expand Up @@ -29,4 +29,4 @@ resource "hcp_consul_snapshot" "example" {
cluster_id = hcp_consul_cluster.example.cluster_id
snapshot_name = var.snapshot_name
}
```
```
8 changes: 4 additions & 4 deletions docs/guides/hvn-route-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
subcategory: ""
page_title: "HVN Route Migration Guide - HCP Provider"
page_title: "HVN Route Migration Guide"
description: |-
An guide to migrating HCP networking resources to use HVN routes.
---

# Introducing HVN routes

The HVN route is a new resource that belongs to an HVN. It contains a CIDR block and targets a networking connection:
The HVN route is a new resource that belongs to an HVN. It contains a CIDR block and targets a networking connection:
either a peering or transit gateway attachment.

HVN routes provide a general view on how an HVN's traffic is routed across all networking connections and create a flexible way of managing these routing rules.
Expand All @@ -20,7 +20,7 @@ There are two ways to migrate existing peerings and transit gateway attachments
* This option is quicker but will result in downtime and possible data loss. Best for test environments. Will allow you to specify human-readable ids for the resources.
* Comment out all `hcp_aws_network_peering` and `hcp_aws_transit_gateway_attachment` resources.
* Run `terraform apply` to destroy currently existing connections.
* Uncomment and update all `hcp_aws_network_peering` and `hcp_aws_transit_gateway_attachment` resource definitions to match the new schema.
* Uncomment and update all `hcp_aws_network_peering` and `hcp_aws_transit_gateway_attachment` resource definitions to match the new schema.
* Add corresponding `hcp_hvn_route` resources for each CIDR targeting corresponding peering connections or transit gateway attachment.
* Run `terraform apply` to recreate connections.

Expand Down Expand Up @@ -159,4 +159,4 @@ Run `terraform plan` to make sure there are no changes detected by the Terraform
```shell
$ terraform plan
No changes. Infrastructure is up-to-date.
```
```
6 changes: 3 additions & 3 deletions docs/guides/multi-project-migration-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Multi-Project Migration Guide - HCP Provider"
page_title: "Multi-Project Migration Guide"
description: |-
A guide to migrating HCP resources to multiple projects.
---
Expand Down Expand Up @@ -43,7 +43,7 @@ resource "hcp_hvn" "test" {

## 3. Configure projects on resource

The HVN will be created in its configured project, while the HCP Consul cluster will be created in its different configured project.
The HVN will be created in its configured project, while the HCP Consul cluster will be created in its different configured project.
Since no project is configured on the provider, the default project will be the oldest project.

```terraform
Expand Down Expand Up @@ -90,4 +90,4 @@ If no project is configured at the provider level, imported resources must inclu
# terraform import {resource_type}.{resource_name} {project_id}:{hvn_id}

$ terraform import hcp_hvn.test f709ec73-55d4-46d8-897d-816ebba28778:test-hvn
```
```
6 changes: 3 additions & 3 deletions docs/guides/packer-channel-management.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Advanced Packer Channel Management - HCP Provider"
page_title: "Advanced Packer Channel Management"
description: |-
A guide to integreting HCP Packer resources and data sources for more advanced channel management.
---
Expand Down Expand Up @@ -66,7 +66,7 @@ Optionally, you can use Terraform functions/expressions to filter the list of bu

### Managing channel assignment for automatically created channels

Channel assignment for automatically created channels can be managed in many ways. A nonexhaustive example configuration is provided below.
Channel assignment for automatically created channels can be managed in many ways. A nonexhaustive example configuration is provided below.

The `iteration_id` attribute is used for example purposes, but any of the three iteration identifier attributes can be used.

Expand Down Expand Up @@ -116,4 +116,4 @@ The default value used in the example is `"none"`, which causes Terraform to set

If an invalid bucket name is provided in the `for_each` map, an error will be thrown. This helps to ensure that the configuration doesn't contain orphaned values, but can cause plan failures when buckets are deleted. If this behavior is undesirable, filter out invalid buckets from the result of the `merge` function.

An [example module](https://github.com/hashicorp/terraform-provider-hcp/tree/main/examples/guides/packer_channel_management/bucket_names/example_module) is available that includes options to leave select channels unmanaged, require explicit configurations for select channels, ignore invalid bucket names in the configuration, and automatically assign an iteration fetched from another channel.
An [example module](https://github.com/hashicorp/terraform-provider-hcp/tree/main/examples/guides/packer_channel_management/bucket_names/example_module) is available that includes options to leave select channels unmanaged, require explicit configurations for select channels, ignore invalid bucket names in the configuration, and automatically assign an iteration fetched from another channel.
6 changes: 3 additions & 3 deletions docs/guides/packer-run-tasks-with-terraform.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
subcategory: ""
page_title: "Packer Run Tasks with Terraform - HCP Provider"
page_title: "Packer Run Tasks with Terraform"
description: |-
A guide to integrating HCP Packer with Terraform using Run Tasks.
A guide to integrating HCP Packer with Terraform using Run Tasks.
---

# Adding an HCP Packer Run Task to Terraform Cloud or Terraform Enterprise

You can add an HCP Packer Run Task to Terraform Cloud or Terraform Enterprise
by combining the HCP Terraform Provider and the
by combining the HCP Terraform Provider and the
[Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe).

## Using the `hcp_packer_run_task` Data Source
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/peering.md → docs/guides/peering-aws.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
subcategory: ""
page_title: "Peer an AWS VPC to a HashiCorp Virtual Network (HVN) - HCP Provider"
page_title: "Peer an AWS VPC to a HashiCorp Virtual Network (HVN)"
description: |-
An example of peering an AWS VPC to a HashiCorp Virtual Network (HVN).
---
Expand Down Expand Up @@ -76,4 +76,4 @@ resource "hcp_hvn_route" "example" {
Refer to the following tutorials for additional usage examples:

- [Deploy HCP Consul with Terraform](https://developer.hashicorp.com/consul/tutorials/cloud-production/terraform-hcp-consul-provider)
- [Deploy HCP Vault with Terraform](https://developer.hashicorp.com/vault/tutorials/cloud-ops/terraform-hcp-provider-vault)
- [Deploy HCP Vault with Terraform](https://developer.hashicorp.com/vault/tutorials/cloud-ops/terraform-hcp-provider-vault)
Loading

0 comments on commit 4f9cc28

Please sign in to comment.