Skip to content

Commit

Permalink
docs: Update README with correct source reference
Browse files Browse the repository at this point in the history
  • Loading branch information
grifonas committed Dec 13, 2023
1 parent 1add8fc commit c9c0f17
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 31 deletions.
22 changes: 13 additions & 9 deletions datahub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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]"
}
```
21 changes: 12 additions & 9 deletions github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`":

Expand All @@ -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
}
```
21 changes: 12 additions & 9 deletions slack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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]
}
```
7 changes: 4 additions & 3 deletions tailscale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>"
}
```

1 change: 0 additions & 1 deletion whitesky/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@

mv terraform-provider-portal-whitesky-cloud_v2.0.3 ~/.terraform.d/plugins/registry.terraform.io/portal-whitesky-cloud/portal-whitesky-cloud/2.0.3/
```

0 comments on commit c9c0f17

Please sign in to comment.