-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: examples to makdown so they're easier to read in the TF registry…
… website
- Loading branch information
1 parent
d462d2e
commit 6a7c850
Showing
6 changed files
with
55 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` | ||
} | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} | ||
} | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} | ||
} | ||
``` |
This file was deleted.
Oops, something went wrong.