-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update README with correct source reference
- Loading branch information
Showing
5 changed files
with
41 additions
and
31 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 |
---|---|---|
|
@@ -6,6 +6,19 @@ The release will be installed into the cluster to which your kubectl config is c | |
|
||
## Usage | ||
|
||
### Reference In Another Project: | ||
|
||
```terraform | ||
module "datahub" { | ||
# To reference as a private repo use "[email protected]:/contiamo...: | ||
# source = "[email protected]:contiamo/terraform.git//datahub" | ||
source = "github.com/contiamo/terraform//datahub" | ||
datahub_namespace = "[your namespace]" | ||
ui_ingress_host = "[UI domain]" | ||
api_ingress_host = "[API domain]" | ||
} | ||
``` | ||
|
||
### Use Independently: | ||
- Set values for the required variables and save it in `vars.tfvars`: | ||
```bash | ||
|
@@ -28,12 +41,3 @@ The release will be installed into the cluster to which your kubectl config is c | |
```bash | ||
terraform apply "datahubplan.tfplan" | ||
``` | ||
### Reference In Another Project: | ||
|
||
```terraform | ||
module "datahub" { | ||
datahub_namespace = "[your namespace]" | ||
ui_ingress_host = "[UI domain]" | ||
api_ingress_host = "[API domain]" | ||
} | ||
``` |
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 |
---|---|---|
|
@@ -4,6 +4,18 @@ This module can be used to create Github repos with Contiamo's standard repo set | |
|
||
## Instructions: | ||
|
||
### Reference In Another TF Project: | ||
```terraform | ||
module "github" { | ||
# To reference as a private repo use "[email protected]:/contiamo...: | ||
# source = "[email protected]:contiamo/terraform.git//github" | ||
source = "github.com/contiamo/terraform//github" | ||
repo_name = var.project_name | ||
repo_description = var.project_description | ||
repo_collaborators = local.users_to_add_as_github_collaborators | ||
} | ||
``` | ||
|
||
### Use Independently: | ||
- Create a new `vars.tfvars` file containing the repo name, description and collaborators with their permissions. Permission value must be one of "`pull`", "`push`", "`maintain`", "`triage`" or "`admin`": | ||
|
||
|
@@ -20,12 +32,3 @@ This module can be used to create Github repos with Contiamo's standard repo set | |
terraform plan -var-file=vars.tfvars -out=myPlan.tfplan | ||
terraform apply "myPlan.tfplan" | ||
``` | ||
### Reference In Another TF Project: | ||
```terraform | ||
module "github" { | ||
source = "[email protected]:contiamo/terraform.git//github" | ||
repo_name = var.project_name | ||
repo_description = var.project_description | ||
repo_collaborators = local.users_to_add_as_github_collaborators | ||
} | ||
``` |
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 |
---|---|---|
|
@@ -4,6 +4,18 @@ This module creates a Slack channel and adds provided users (references by their | |
|
||
## Instructions: | ||
|
||
### Reference In another TF Project: | ||
```terraform | ||
module "slack" { | ||
# To reference as a private repo use "[email protected]:/contiamo...: | ||
# source = "[email protected]:contiamo/terraform.git//slack" | ||
source = "github.com/contiamo/terraform//slack" | ||
channel_name = "[new channel name]" | ||
channel_topic = "[new channel description]" | ||
channel_members = [list of user emails] | ||
} | ||
``` | ||
|
||
### Use Independently: | ||
- Create a new `vars.tfvars` file containing the following values: | ||
|
||
|
@@ -21,12 +33,3 @@ This module creates a Slack channel and adds provided users (references by their | |
terraform apply "myPlan.tfplan" | ||
``` | ||
|
||
### Reference In another TF Project: | ||
```terraform | ||
module "slack" { | ||
source = "[email protected]:contiamo/terraform.git//slack" | ||
channel_name = "[new channel name]" | ||
channel_topic = "[new channel description]" | ||
channel_members = [list of user emails] | ||
} | ||
``` |
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 |
---|---|---|
|
@@ -8,12 +8,13 @@ This module installs a Tailscale Subnet Router for a K8S cluster | |
|
||
```terraform | ||
module "tailscale" { | ||
source = "[email protected]:contiamo/terraform.git//tailscale" | ||
# To reference as a private repo use "[email protected]:/contiamo...: | ||
# source = "[email protected]:contiamo/terraform.git//tailscale" | ||
source = "github.com/contiamo/terraform//tailscale" | ||
tailscale_auth_key = var.tailscale_auth_key | ||
create_tailscale_auth_key_secret = var.create_tailscale_auth_key_secret | ||
image_tag = "v1.34.1" | ||
image_tag = "v1.54.1" | ||
k8s_cluster_pod_cidr = "<YOUR cluster pod CIDR>" | ||
k8s_cluster_service_cidr = "<YOUR cluster service CIDR>" | ||
} | ||
``` | ||
|
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