Skip to content

Commit 7d7f518

Browse files
b-perb-per
committed
Add docs
1 parent 97b4643 commit 7d7f518

4 files changed

Lines changed: 209 additions & 0 deletions

File tree

‎modules/dbtcloud/dbtcloud_common/README.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
7+
| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.2.10 |
8+
9+
## Providers
10+
11+
| Name | Version |
12+
|------|---------|
13+
| <a name="provider_dbtcloud"></a> [dbtcloud](#provider\_dbtcloud) | >= 0.2.10 |
14+
15+
## Modules
16+
17+
No modules.
18+
19+
## Resources
20+
21+
| Name | Type |
22+
|------|------|
23+
| [dbtcloud_environment.envs](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/environment) | resource |
24+
| [dbtcloud_environment.envs_ci](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/environment) | resource |
25+
| [dbtcloud_environment_variable.my_env_var](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/environment_variable) | resource |
26+
| [dbtcloud_job.ci](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job) | resource |
27+
| [dbtcloud_job.daily_prod](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job) | resource |
28+
| [dbtcloud_project.dbt_project](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/project) | resource |
29+
| [dbtcloud_project_connection.dbt_project_connection](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/project_connection) | resource |
30+
| [dbtcloud_project_repository.dbt_project_repository](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/project_repository) | resource |
31+
| [dbtcloud_repository.dbt_repository](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/repository) | resource |
32+
33+
## Inputs
34+
35+
| Name | Description | Type | Default | Required |
36+
|------|-------------|------|---------|:--------:|
37+
| <a name="input_database_envs"></a> [database\_envs](#input\_database\_envs) | n/a | <pre>map(object({<br> wh_size = string<br> defer_to_env_name = string<br> git_branch = string<br> }))</pre> | n/a | yes |
38+
| <a name="input_dbt_connection"></a> [dbt\_connection](#input\_dbt\_connection) | The connection to the DW | `map(any)` | n/a | yes |
39+
| <a name="input_dbt_creds"></a> [dbt\_creds](#input\_dbt\_creds) | n/a | `map(any)` | n/a | yes |
40+
| <a name="input_dbt_creds_ci"></a> [dbt\_creds\_ci](#input\_dbt\_creds\_ci) | n/a | `map(any)` | n/a | yes |
41+
| <a name="input_dbt_project_name"></a> [dbt\_project\_name](#input\_dbt\_project\_name) | The project name in dbt Cloud | `string` | n/a | yes |
42+
| <a name="input_dbt_version"></a> [dbt\_version](#input\_dbt\_version) | The dbt version | `string` | n/a | yes |
43+
| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | n/a | `map(any)` | n/a | yes |
44+
| <a name="input_github_installation_id"></a> [github\_installation\_id](#input\_github\_installation\_id) | The project name in dbt Cloud | `string` | n/a | yes |
45+
| <a name="input_github_repo_remote_url"></a> [github\_repo\_remote\_url](#input\_github\_repo\_remote\_url) | The remote URL for the GitHub repository | `string` | `null` | no |
46+
47+
## Outputs
48+
49+
| Name | Description |
50+
|------|-------------|
51+
| <a name="output_dbt_project_id"></a> [dbt\_project\_id](#output\_dbt\_project\_id) | n/a |
52+
<!-- END_TF_DOCS -->

‎modules/dbtcloud/dbtcloud_snowflake/README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
7+
| <a name="requirement_dbtcloud"></a> [dbtcloud](#requirement\_dbtcloud) | >= 0.2.10 |
8+
9+
## Providers
10+
11+
| Name | Version |
12+
|------|---------|
13+
| <a name="provider_dbtcloud"></a> [dbtcloud](#provider\_dbtcloud) | >= 0.2.10 |
14+
15+
## Modules
16+
17+
No modules.
18+
19+
## Resources
20+
21+
| Name | Type |
22+
|------|------|
23+
| [dbtcloud_connection.dbt_connection](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/connection) | resource |
24+
| [dbtcloud_snowflake_credential.creds](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/snowflake_credential) | resource |
25+
| [dbtcloud_snowflake_credential.creds_ci](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/snowflake_credential) | resource |
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_dbt_project_id"></a> [dbt\_project\_id](#input\_dbt\_project\_id) | The Project ID for the dbt Cloud Project | `number` | n/a | yes |
32+
| <a name="input_dbt_project_name"></a> [dbt\_project\_name](#input\_dbt\_project\_name) | The Project ID for the dbt Cloud Project | `string` | n/a | yes |
33+
| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | n/a | `map(any)` | n/a | yes |
34+
| <a name="input_envs_except_dev"></a> [envs\_except\_dev](#input\_envs\_except\_dev) | n/a | `map(any)` | n/a | yes |
35+
| <a name="input_snowflake_account"></a> [snowflake\_account](#input\_snowflake\_account) | The Snowflake Account ID | `string` | n/a | yes |
36+
| <a name="input_snowflake_databases"></a> [snowflake\_databases](#input\_snowflake\_databases) | The Snowflake Databases that were created | <pre>map(object({<br> name = string<br> }))</pre> | n/a | yes |
37+
| <a name="input_snowflake_roles"></a> [snowflake\_roles](#input\_snowflake\_roles) | The Snowflake Roles that were created | <pre>map(object({<br> name = string<br> }))</pre> | n/a | yes |
38+
| <a name="input_snowflake_service_users"></a> [snowflake\_service\_users](#input\_snowflake\_service\_users) | The Snowflake Service Users that were created | <pre>map(object({<br> name = string<br> password = string<br> }))</pre> | n/a | yes |
39+
| <a name="input_snowflake_warehouses"></a> [snowflake\_warehouses](#input\_snowflake\_warehouses) | The Snowflake Warehouses that were created | <pre>map(object({<br> name = string<br> }))</pre> | n/a | yes |
40+
41+
## Outputs
42+
43+
| Name | Description |
44+
|------|-------------|
45+
| <a name="output_dbt_connection"></a> [dbt\_connection](#output\_dbt\_connection) | n/a |
46+
| <a name="output_dbt_creds"></a> [dbt\_creds](#output\_dbt\_creds) | n/a |
47+
| <a name="output_dbt_creds_ci"></a> [dbt\_creds\_ci](#output\_dbt\_creds\_ci) | n/a |
48+
<!-- END_TF_DOCS -->

‎modules/github/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
7+
| <a name="requirement_github"></a> [github](#requirement\_github) | ~> 5.0 |
8+
| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.0 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_github"></a> [github](#provider\_github) | ~> 5.0 |
15+
| <a name="provider_null"></a> [null](#provider\_null) | >= 3.0 |
16+
17+
## Modules
18+
19+
No modules.
20+
21+
## Resources
22+
23+
| Name | Type |
24+
|------|------|
25+
| [github_branch_protection.dbt_repo](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch_protection) | resource |
26+
| [github_repository.dbt_repo](https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository) | resource |
27+
| [null_resource.post_repo_creation](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
28+
29+
## Inputs
30+
31+
| Name | Description | Type | Default | Required |
32+
|------|-------------|------|---------|:--------:|
33+
| <a name="input_cruft_template_url"></a> [cruft\_template\_url](#input\_cruft\_template\_url) | URL for the Cruft template | `string` | n/a | yes |
34+
| <a name="input_github_token"></a> [github\_token](#input\_github\_token) | GitHub token to crate repos | `string` | n/a | yes |
35+
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | Project Name | `string` | n/a | yes |
36+
| <a name="input_project_slug"></a> [project\_slug](#input\_project\_slug) | Slug for the project | `string` | n/a | yes |
37+
38+
## Outputs
39+
40+
| Name | Description |
41+
|------|-------------|
42+
| <a name="output_github_repo_remote_url"></a> [github\_repo\_remote\_url](#output\_github\_repo\_remote\_url) | n/a |
43+
<!-- END_TF_DOCS -->

‎modules/snowflake/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
7+
| <a name="requirement_snowflake"></a> [snowflake](#requirement\_snowflake) | ~> 0.71 |
8+
9+
## Providers
10+
11+
| Name | Version |
12+
|------|---------|
13+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
14+
| <a name="provider_snowflake"></a> [snowflake](#provider\_snowflake) | ~> 0.71 |
15+
16+
## Modules
17+
18+
No modules.
19+
20+
## Resources
21+
22+
| Name | Type |
23+
|------|------|
24+
| [random_password.password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |
25+
| [snowflake_database.dbt_databases](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database) | resource |
26+
| [snowflake_grant_privileges_to_role.database](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
27+
| [snowflake_grant_privileges_to_role.deferral_database](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
28+
| [snowflake_grant_privileges_to_role.deferral_database_future_schemas](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
29+
| [snowflake_grant_privileges_to_role.deferral_database_schemas](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
30+
| [snowflake_grant_privileges_to_role.deferral_existing_tables_views](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
31+
| [snowflake_grant_privileges_to_role.deferral_future_tables_views](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
32+
| [snowflake_grant_privileges_to_role.existing_tables_views](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
33+
| [snowflake_grant_privileges_to_role.future_schemas](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
34+
| [snowflake_grant_privileges_to_role.future_tables_views](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
35+
| [snowflake_grant_privileges_to_role.raw_current_tables_views](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
36+
| [snowflake_grant_privileges_to_role.raw_future_tables_views](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
37+
| [snowflake_grant_privileges_to_role.raw_usage_all_schemas](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
38+
| [snowflake_grant_privileges_to_role.raw_usage_future_schemas](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
39+
| [snowflake_grant_privileges_to_role.schemas](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
40+
| [snowflake_grant_privileges_to_role.warehouse](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_role) | resource |
41+
| [snowflake_role.dbt_roles](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/role) | resource |
42+
| [snowflake_role_grants.dbt_service_user_grants](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/role_grants) | resource |
43+
| [snowflake_role_grants.dev_grants](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/role_grants) | resource |
44+
| [snowflake_user.dbt_service_users](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/user) | resource |
45+
| [snowflake_warehouse.dbt_warehouses](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/warehouse) | resource |
46+
47+
## Inputs
48+
49+
| Name | Description | Type | Default | Required |
50+
|------|-------------|------|---------|:--------:|
51+
| <a name="input_database_envs"></a> [database\_envs](#input\_database\_envs) | n/a | <pre>map(object({<br> wh_size = string<br> defer_to_env_name = string<br> git_branch = string<br> }))</pre> | n/a | yes |
52+
| <a name="input_defer_from_to"></a> [defer\_from\_to](#input\_defer\_from\_to) | n/a | `map(any)` | n/a | yes |
53+
| <a name="input_developers"></a> [developers](#input\_developers) | n/a | `set(string)` | n/a | yes |
54+
| <a name="input_envs_except_dev"></a> [envs\_except\_dev](#input\_envs\_except\_dev) | n/a | `map(any)` | n/a | yes |
55+
| <a name="input_project_slug"></a> [project\_slug](#input\_project\_slug) | Slug for the project with no special characters | `string` | n/a | yes |
56+
| <a name="input_raw_database"></a> [raw\_database](#input\_raw\_database) | n/a | `string` | n/a | yes |
57+
58+
## Outputs
59+
60+
| Name | Description |
61+
|------|-------------|
62+
| <a name="output_snowflake_databases"></a> [snowflake\_databases](#output\_snowflake\_databases) | n/a |
63+
| <a name="output_snowflake_roles"></a> [snowflake\_roles](#output\_snowflake\_roles) | n/a |
64+
| <a name="output_snowflake_users"></a> [snowflake\_users](#output\_snowflake\_users) | n/a |
65+
| <a name="output_snowflake_warehouses"></a> [snowflake\_warehouses](#output\_snowflake\_warehouses) | n/a |
66+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)