Skip to content

Commit dc2b2d6

Browse files
ivasm-koivasm-ko
committed
feat: added README.md
1 parent 561d5f5 commit dc2b2d6

File tree

1 file changed

+56
-3
lines changed

1 file changed

+56
-3
lines changed

‎README.md

Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,65 @@
1-
# Azure <> Terraform module
2-
Terraform module for creation Azure <>
1+
# Databricks Premium Workspace Terraform module
2+
Terraform module used for creation Databricks Premium Workspace using Databricks provider
33

44
## Usage
55

66
<!-- BEGIN_TF_DOCS -->
7+
## Requirements
78

9+
| Name | Version |
10+
| ---------------------------------------------------------------------------- | -------- |
11+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
12+
| <a name="requirement_databricks"></a> [databricks](#requirement\_databricks) | >= 1.4.0 |
13+
14+
## Providers
15+
16+
| Name | Version |
17+
| ---------------------------------------------------------------------- | ------- |
18+
| <a name="provider_databricks"></a> [databricks](#provider\_databricks) | 1.4.0 |
19+
20+
## Modules
21+
22+
No modules.
23+
24+
## Resources
25+
26+
| Name | Type |
27+
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
28+
| [databricks_group.admins](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group) | data |
29+
| [databricks_group.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group) | resource |
30+
| [databricks_user.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/user) | resource |
31+
| [databricks_service_principal.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/service_principal) | resource |
32+
| [databricks_group_member.admin_users](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_member) | resource |
33+
| [databricks_group_member.admin_service_principals](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_member) | resource |
34+
| [databricks_group_member.users](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_member) | resource |
35+
| [databricks_group_member.service_principals](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_member) | resource |
36+
| [databricks_permissions.sql_endpoint](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/permissions) | resource |
37+
| [databricks_permissions.token](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/permissions) | resource |
38+
| [databricks_workspace_conf.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/workspace_conf) | resource |
39+
| [databricks_ip_access_list.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/ip_access_list) | resource |
40+
| [databricks_sql_endpoint.this](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/sql_endpoint) | resource |
41+
42+
## Inputs
43+
44+
| Name | Description | Type | Default | Required |
45+
| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
46+
| <a name="input_env"></a> [env](#input\_env) | Environment name | `string` | n/a | yes |
47+
| <a name="input_project"></a> [project](#input\_project) | Project name | `string` | n/a | yes |
48+
| <a name="input_user_object_ids"></a> [user_object_ids](#input\_user\_object\_ids) | Map of AD usernames and corresponding object IDs | `map(string)` | {} | no |
49+
| <a name="input_iam"></a> [iam](#input\_iam) | Map of groups and members of users and service principals to be created. You can add you own groups and members. E.g., `'group' = { user = ['user1','user2'] service_principal = ['sp1']}` and etc | <pre> map(object({ <br> user = list(string) <br> service_principal = list(string) <br> }))</pre> | <pre> { <br> "admins" = { <br> "user" = [] <br> "service_principal" = [] <br> } <br> "default" = { <br> "user" = [] <br> "service_principal" = [] <br> } <br> } </pre> | no |
50+
| <a name="input_iam_permissions"></a> [iam\_permissions](#input\_iam\_permissions) | Map of permission for groups. You can provide certain permission on services to groups. E.g., 'sql_endpoint'={'CAN_USE'=['group1', 'group2'] CAN_MANAGE=['group3']} | <pre> map(object({ <br> CAN_USE = list(string) <br> CAN_MANAGE = list(string)<br> })) </pre> | <pre> { <br> "sql_endpoint" = { <br> "CAN_USE" = ["default"] <br> "CAN_MANAGE" = [] <br> } <br> "token" = { <br> "CAN_USE" = ["default"] <br> "CAN_MANAGE" = [] <br> } <br> } </pre> | no |
51+
| <a name="input_ip_rules"></a> [ip\_rules](#input\_ip\_rules) | Map of IP addresses permitted for access to DB | `map(string)` | {} | no |
52+
| <a name="input_sql_endpoint"></a> [sql\_endpoint](#input\_sql\_endpoint) | Map of SQL Endoints to be deployed in Databricks Workspace | `map(map(string))` | {} | no |
53+
| <a name="input_default_values_sql_endpoint"></a> [default\_values\_sql\_endpoint](#input\_default\_values\_sql\_endpoint) | Default values for SQL Endpoint | <pre> object({ <br> cluster_size = string <br> min_num_clusters = number <br> max_num_clusters = number <br> auto_stop_mins = string <br> enable_photon = bool <br> enable_serverless_compute = bool <br> }) </pre> | <pre> { <br> cluster_size = "2X-Small" <br> min_num_clusters = 0 <br> max_num_clusters = 1 <br> auto_stop_mins = "30" <br> enable_photon = false <br> enable_serverless_compute = false <br> } </pre> | no |
54+
55+
## Outputs
56+
57+
| Name | Description |
58+
| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
59+
| <a name="output_sql_endpoint_jdbc_url"></a> [sql\_endpoint\_jdbc\_url](#output\_sql\_endpoint\_jdbc\_url) | JDBC connection string of SQL Endpoint |
60+
| <a name="output_sql_endpoint_data_source_id"></a> [sql\_endpoint\_data\_source\_id](#output\_sql\_endpoint\_data\_source\_id) | ID of the data source for this endpoint |
861
<!-- END_TF_DOCS -->
962

1063
## License
1164

12-
Apache 2 Licensed. For more information please see [LICENSE](https://github.com/data-platform-hq/terraform-azurerm<>/tree/master/LICENSE)
65+
Apache 2 Licensed. For more information please see [LICENSE](https://github.com/data-platform-hq/terraform-databricks-databricks-runtime-premium/blob/main/LICENSE)

0 commit comments

Comments
 (0)