Skip to content

Commit

Permalink
doc: examples to makdown so they're easier to read in the TF registry…
Browse files Browse the repository at this point in the history
… website
  • Loading branch information
AlexisVLRT committed Aug 29, 2023
1 parent d462d2e commit 6a7c850
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 130 deletions.
36 changes: 15 additions & 21 deletions examples/basic/README.md
Original file line number Diff line number Diff line change
@@ -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=<PROJECT_ID> 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 |
|------|--------|---------|
| <a name="module_airbyte"></a> [airbyte](#module\_airbyte) | artefactory/airbyte-flows/google | ~> 0 |

## Resources

No resources.

## Inputs

No inputs.

## Outputs

No outputs.
project_id = "<PROJECT_ID>"
region = "<REGION>" # List available regions with `gcloud compute regions list`
zone = "<ZONE>" # List available zones with `gcloud compute zones list`
}
```
14 changes: 0 additions & 14 deletions examples/basic/main.tf

This file was deleted.

42 changes: 17 additions & 25 deletions examples/bigger_vm/README.md
Original file line number Diff line number Diff line change
@@ -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 |
|------|--------|---------|
| <a name="module_airbyte"></a> [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 = "<PROJECT_ID>"
region = "<REGION>" # List available regions with `gcloud compute regions list`
zone = "<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"
}
}
```
20 changes: 0 additions & 20 deletions examples/bigger_vm/main.tf

This file was deleted.

48 changes: 23 additions & 25 deletions examples/naming_overrides/README.md
Original file line number Diff line number Diff line change
@@ -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 |
|------|--------|---------|
| <a name="module_airbyte"></a> [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 = "<PROJECT_ID>"
region = "<REGION>" # List available regions with `gcloud compute regions list`
zone = "<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"
}
}
```
25 changes: 0 additions & 25 deletions examples/naming_overrides/main.tf

This file was deleted.

0 comments on commit 6a7c850

Please sign in to comment.