Skip to content

Commit

Permalink
TF Support for NCC Star Topology (#12540) (#873)
Browse files Browse the repository at this point in the history
[upstream:765f91ac4678f6684ce41cf5c296351be9f8ffbc]

Signed-off-by: Modular Magician <[email protected]>
  • Loading branch information
modular-magician authored Dec 17, 2024
1 parent 0a9fb3d commit b995946
Show file tree
Hide file tree
Showing 12 changed files with 354 additions and 0 deletions.
15 changes: 15 additions & 0 deletions network_connectivity_hub_mesh_topology/backing_file.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file has some scaffolding to make sure that names are unique and that
# a region and zone are selected when you try to create your Terraform resources.

locals {
name_suffix = "${random_pet.suffix.id}"
}

resource "random_pet" "suffix" {
length = 2
}

provider "google" {
region = "us-central1"
zone = "us-central1-c"
}
7 changes: 7 additions & 0 deletions network_connectivity_hub_mesh_topology/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
resource "google_network_connectivity_hub" "primary" {
name = "mesh-${local.name_suffix}"
description = "A sample mesh hub"
labels = {
label-one = "value-one"
}
}
7 changes: 7 additions & 0 deletions network_connectivity_hub_mesh_topology/motd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
===

These examples use real resources that will be billed to the
Google Cloud Platform project you use - so make sure that you
run "terraform destroy" before quitting!

===
79 changes: 79 additions & 0 deletions network_connectivity_hub_mesh_topology/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Network Connectivity Hub Mesh Topology - Terraform

## Setup

<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="network_connectivity_hub_mesh_topology" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>

Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.

<walkthrough-project-billing-setup></walkthrough-project-billing-setup>

Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.

## Terraforming!

Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
the project name from the environment variable.

```bash
export GOOGLE_CLOUD_PROJECT={{project-id}}
```

After that, let's get Terraform started. Run the following to pull in the providers.

```bash
terraform init
```

With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!

```bash
terraform apply
```

Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.

```bash
yes
```


## Post-Apply

### Editing your config

Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.

```bash
terraform plan
```

So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
run a 'plan' again.

```bash
terraform plan
```

Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
at the 'yes' prompt.

```bash
terraform apply
```

```bash
yes
```

## Cleanup

Run the following to remove the resources Terraform provisioned:

```bash
terraform destroy
```
```bash
yes
```
15 changes: 15 additions & 0 deletions network_connectivity_hub_star_topology/backing_file.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file has some scaffolding to make sure that names are unique and that
# a region and zone are selected when you try to create your Terraform resources.

locals {
name_suffix = "${random_pet.suffix.id}"
}

resource "random_pet" "suffix" {
length = 2
}

provider "google" {
region = "us-central1"
zone = "us-central1-c"
}
9 changes: 9 additions & 0 deletions network_connectivity_hub_star_topology/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
resource "google_network_connectivity_hub" "primary" {
name = "star-${local.name_suffix}"
description = "A sample star hub"
labels = {
label-one = "value-one"
}
preset_topology = "STAR"

}
7 changes: 7 additions & 0 deletions network_connectivity_hub_star_topology/motd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
===

These examples use real resources that will be billed to the
Google Cloud Platform project you use - so make sure that you
run "terraform destroy" before quitting!

===
79 changes: 79 additions & 0 deletions network_connectivity_hub_star_topology/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Network Connectivity Hub Star Topology - Terraform

## Setup

<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="network_connectivity_hub_star_topology" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>

Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.

<walkthrough-project-billing-setup></walkthrough-project-billing-setup>

Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.

## Terraforming!

Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
the project name from the environment variable.

```bash
export GOOGLE_CLOUD_PROJECT={{project-id}}
```

After that, let's get Terraform started. Run the following to pull in the providers.

```bash
terraform init
```

With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!

```bash
terraform apply
```

Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.

```bash
yes
```


## Post-Apply

### Editing your config

Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.

```bash
terraform plan
```

So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
run a 'plan' again.

```bash
terraform plan
```

Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
at the 'yes' prompt.

```bash
terraform apply
```

```bash
yes
```

## Cleanup

Run the following to remove the resources Terraform provisioned:

```bash
terraform destroy
```
```bash
yes
```
15 changes: 15 additions & 0 deletions network_connectivity_spoke_center_group/backing_file.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file has some scaffolding to make sure that names are unique and that
# a region and zone are selected when you try to create your Terraform resources.

locals {
name_suffix = "${random_pet.suffix.id}"
}

resource "random_pet" "suffix" {
length = 2
}

provider "google" {
region = "us-central1"
zone = "us-central1-c"
}
35 changes: 35 additions & 0 deletions network_connectivity_spoke_center_group/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
resource "google_compute_network" "network" {
name = "tf-net"
auto_create_subnetworks = false
}

resource "google_network_connectivity_hub" "star_hub" {
name = "hub-basic-${local.name_suffix}"
preset_topology = "STAR"
}

resource "google_network_connectivity_group" "center_group" {
name = "center" # (default , center , edge)
hub = google_network_connectivity_hub.star_hub.id
auto_accept {
auto_accept_projects = [
"foo%{random_suffix}",
"bar%{random_suffix}",
]
}
}

resource "google_network_connectivity_spoke" "primary" {
name = "vpc-spoke-${local.name_suffix}"
location = "global"
description = "A sample spoke"
labels = {
label-one = "value-one"
}
hub = google_network_connectivity_hub.star_hub.id
group = google_network_connectivity_group.center_group.id

linked_vpc_network {
uri = google_compute_network.network.self_link
}
}
7 changes: 7 additions & 0 deletions network_connectivity_spoke_center_group/motd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
===

These examples use real resources that will be billed to the
Google Cloud Platform project you use - so make sure that you
run "terraform destroy" before quitting!

===
79 changes: 79 additions & 0 deletions network_connectivity_spoke_center_group/tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Network Connectivity Spoke Center Group - Terraform

## Setup

<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="network_connectivity_spoke_center_group" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>

Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.

<walkthrough-project-billing-setup></walkthrough-project-billing-setup>

Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.

## Terraforming!

Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
the project name from the environment variable.

```bash
export GOOGLE_CLOUD_PROJECT={{project-id}}
```

After that, let's get Terraform started. Run the following to pull in the providers.

```bash
terraform init
```

With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!

```bash
terraform apply
```

Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.

```bash
yes
```


## Post-Apply

### Editing your config

Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.

```bash
terraform plan
```

So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
run a 'plan' again.

```bash
terraform plan
```

Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
at the 'yes' prompt.

```bash
terraform apply
```

```bash
yes
```

## Cleanup

Run the following to remove the resources Terraform provisioned:

```bash
terraform destroy
```
```bash
yes
```

0 comments on commit b995946

Please sign in to comment.