From 6a7c850f7a783d326b5b7e1b2c34a9cf609fa392 Mon Sep 17 00:00:00 2001 From: Alexis VIALARET Date: Tue, 29 Aug 2023 14:34:43 +0200 Subject: [PATCH] doc: examples to makdown so they're easier to read in the TF registry website --- examples/basic/README.md | 36 +++++++++------------- examples/basic/main.tf | 14 --------- examples/bigger_vm/README.md | 42 ++++++++++--------------- examples/bigger_vm/main.tf | 20 ------------ examples/naming_overrides/README.md | 48 ++++++++++++++--------------- examples/naming_overrides/main.tf | 25 --------------- 6 files changed, 55 insertions(+), 130 deletions(-) delete mode 100644 examples/basic/main.tf delete mode 100644 examples/bigger_vm/main.tf delete mode 100644 examples/naming_overrides/main.tf diff --git a/examples/basic/README.md b/examples/basic/README.md index 1512019..80205d9 100644 --- a/examples/basic/README.md +++ b/examples/basic/README.md @@ -1,25 +1,19 @@ -## Requirements +This will deploy a VM with an Airbyte instance installed. +The instance will need a few minutes to be up and running after the apply succeeds -No requirements. +You can access the Airbyte UI through your browser at `localhost:8000` after SSH tunneling to the instance with the following command: -## Providers +```shell +gcloud --project= compute ssh airbyte -- -L 8000:localhost:8000 -N -f +``` -No providers. +```hcl +module "airbyte" { + source = "artefactory/airbyte-infra/google" + version = "~> 0" -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [airbyte](#module\_airbyte) | artefactory/airbyte-flows/google | ~> 0 | - -## Resources - -No resources. - -## Inputs - -No inputs. - -## Outputs - -No outputs. + project_id = "" + region = "" # List available regions with `gcloud compute regions list` + zone = "" # List available zones with `gcloud compute zones list` +} +``` \ No newline at end of file diff --git a/examples/basic/main.tf b/examples/basic/main.tf deleted file mode 100644 index 66be941..0000000 --- a/examples/basic/main.tf +++ /dev/null @@ -1,14 +0,0 @@ -# This will deploy a VM with an Airbyte instance installed. -# The instance will need a few minutes to be up and running after the apply succeeds -# You can access the Airbyte UI through your browser at `localhost:8000` after SSH tunneling to the instance with the following command: -# `gcloud --project= compute ssh airbyte -- -L 8000:localhost:8000 -N -f` - - -module "airbyte" { - source = "artefactory/airbyte-flows/google" - version = "~> 0" - - project_id = "" - region = "" # List available regions with `gcloud compute regions list` - zone = "" # List available zones with `gcloud compute zones list` -} diff --git a/examples/bigger_vm/README.md b/examples/bigger_vm/README.md index 9553422..82ad59f 100644 --- a/examples/bigger_vm/README.md +++ b/examples/bigger_vm/README.md @@ -1,28 +1,20 @@ You can alter which type of VM you deploy on, as well as he network config using the `config` variable Check out the config reference for more info. -## Requirements - -No requirements. - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [airbyte](#module\_airbyte) | artefactory/airbyte-flows/google | ~> 0 | - -## Resources - -No resources. - -## Inputs - -No inputs. - -## Outputs - -No outputs. +```hcl +module "airbyte" { + source = "artefactory/airbyte-infra/google" + version = "~> 0" + + project_id = "" + region = "" # List available regions with `gcloud compute regions list` + zone = "" # List available zones with `gcloud compute zones list` + + # The module comes with a default config that you can override. + # Check out the config reference for more info. + config = { + vm_machine_type = "e2-standard-8" + vm_disk_size = "50" + } +} +``` \ No newline at end of file diff --git a/examples/bigger_vm/main.tf b/examples/bigger_vm/main.tf deleted file mode 100644 index 1899ff3..0000000 --- a/examples/bigger_vm/main.tf +++ /dev/null @@ -1,20 +0,0 @@ -/* -* You can alter which type of VM you deploy on, as well as he network config using the `config` variable -* Check out the config reference for more info. -*/ - -module "airbyte" { - source = "artefactory/airbyte-flows/google" - version = "~> 0" - - project_id = "" - region = "" # List available regions with `gcloud compute regions list` - zone = "" # List available zones with `gcloud compute zones list` - - # The module comes with a default config that you can override. - # Check out the config reference for more info. - config = { - vm_machine_type = "e2-standard-8" - vm_disk_size = "50" - } -} diff --git a/examples/naming_overrides/README.md b/examples/naming_overrides/README.md index 19434df..dc39800 100644 --- a/examples/naming_overrides/README.md +++ b/examples/naming_overrides/README.md @@ -1,27 +1,25 @@ You can change the name of the resources that will be terraformed to be compliant with your naming convention. -## Requirements - -No requirements. - -## Providers - -No providers. - -## Modules - -| Name | Source | Version | -|------|--------|---------| -| [airbyte](#module\_airbyte) | artefactory/airbyte-flows/google | ~> 0 | - -## Resources - -No resources. - -## Inputs - -No inputs. - -## Outputs - -No outputs. +```hcl +module "airbyte" { + source = "artefactory/airbyte-infra/google" + version = "~> 0" + + project_id = "" + region = "" # List available regions with `gcloud compute regions list` + zone = "" # List available zones with `gcloud compute zones list` + + # The module comes with a default config that you can override. + # Check out the config reference for more info. + config = { + airbyte_vm_name = "airbyte" + airbyte_sa_name = "airbyte" + vpc_name = "airbyte-vpc" + subnet_name = "airbyte-subnet" + router_name = "airbyte-router" + external_ip_name = "airbyte-ip" + nat_name = "airbyte-nat" + internet_route_name = "airbyte-internet-route" + } +} +``` \ No newline at end of file diff --git a/examples/naming_overrides/main.tf b/examples/naming_overrides/main.tf deleted file mode 100644 index af8c12a..0000000 --- a/examples/naming_overrides/main.tf +++ /dev/null @@ -1,25 +0,0 @@ -/* -* You can change the name of the resources that will be terraformed to be compliant with your naming convention. -*/ - -module "airbyte" { - source = "artefactory/airbyte-flows/google" - version = "~> 0" - - project_id = "" - region = "" # List available regions with `gcloud compute regions list` - zone = "" # List available zones with `gcloud compute zones list` - - # The module comes with a default config that you can override. - # Check out the config reference for more info. - config = { - airbyte_vm_name = "airbyte" - airbyte_sa_name = "airbyte" - vpc_name = "airbyte-vpc" - subnet_name = "airbyte-subnet" - router_name = "airbyte-router" - external_ip_name = "airbyte-ip" - nat_name = "airbyte-nat" - internet_route_name = "airbyte-internet-route" - } -}