Skip to content

Commit

Permalink
Update docs(#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
evelynzhaojie authored May 13, 2024
1 parent 509c167 commit 2ece906
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 13 deletions.
3 changes: 3 additions & 0 deletions docs/guides/azure_deployment_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ resource "celerdatabyoc_classic_cluster" "azure_terraform_test" {
}
csp = "azure"
region = local.cluster_region
depends_on = [azurerm_role_assignment.assignment_app_roles,azurerm_role_assignment.assignment_identity_roles]
}
```

Expand Down Expand Up @@ -366,6 +367,8 @@ The `celerdatabyoc_classic_cluster` resource contains the following required arg

- `region`: The ID of the Azure region to which the AWS VPC hosting the cluster belongs. See [Supported cloud platforms and regions](https://docs.celerdata.com/private/main/get_started/cloud_platforms_and_regions#aws). Set this argument to `local.cluster_region`, as we recommend that you set the bucket element as a local value `cluster_region` in your Terraform configuration. See [Local Values](https://developer.hashicorp.com/terraform/language/values/locals).

- `depends_on`: This argument creates a dependency between resources. If you want to deploy an Azure cluster, you must ensure that the resources used to declare the privileges of the resource group and managed identity are destroyed only after the cluster is released. To achieve this, you need to add this dependency.

**Optional:**

- `fe_node_count`: The number of FE nodes in the cluster. Valid values: `1`, `3`, and `5`. Default value: `1`.
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/azure_data_credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ This resource is also a prerequisite for the implementation of the credential-re
```terraform
resource "celerdatabyoc_azure_data_credential" "example" {
name = "<data_credential_name>"
managed_identity_resource_id = azurerm_user_assigned_identity.example.id
storage_account_name = azurerm_storage_account.example.name
container_name = azurerm_storage_container.example.name
managed_identity_resource_id = "<managed_identity_id>"
storage_account_name = "<storage_account_name>"
container_name = "<container_name>"
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/azure_deployment_credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ This resource is also a prerequisite for the implementation of the credential-re
```terraform
resource "celerdatabyoc_azure_deployment_credential" "example" {
name = "<deployment_credential_name>"
application_id = azuread_application_registration.example.client_id
directory_id = azuread_service_principal.app_service_principal.application_tenant_id
client_secret_value = azuread_application_password.example.value
ssh_key_resource_id = azurerm_ssh_public_key.example.id
application_id = "<application_id>"
directory_id = "<directory_id>"
client_secret_value = "<client_secret_value>"
ssh_key_resource_id = "<ssh_public_key_id>"
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/azure_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Therefore, you must implement these resources before implementing this one. For
```terraform
resource "celerdatabyoc_azure_network" "example" {
name = "<network_credential_name>"
deployment_credential_id = celerdatabyoc_azure_deployment_credential.example.id
virtual_network_resource_id = azurerm_virtual_network.example.id
subnet_name = azurerm_subnet.example.name
region = local.cluster_region
deployment_credential_id = "<deployment_credential_id>"
virtual_network_resource_id = "<virtual_network_id>"
subnet_name = "<subnet_name>"
region = "<region_id>"
public_accessible = true
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/classic_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,15 +244,15 @@ This resource contains the following required arguments and optional arguments:
- `be_disk_number`: (Forces new resource) The maximum number of disks that are allowed for each BE. Valid values: [1,24]. Default value: `2`.
- `be_disk_per_size`: The size per disk for each BE. Unit: GB. Maximum value: `16000`. Default value: `100`. You can only increase the value of this parameter, and the time interval between two value changes must be greater than 6 hours.

~> You can use the `be_disk_number` and `be_disk_per_size` argumentAs to specify the disk space. The total disk space provisioned to a cluster is equal to `be_disk_number` * `be_disk_per_size`.
~> You can use the `be_disk_number` and `be_disk_per_size` arguments to specify the disk space. The total disk space provisioned to a cluster is equal to `be_disk_number` * `be_disk_per_size`.

- `resource_tags`: The tags to be attached to the cluster.
- `init_scripts`: The configuration block to specify the paths to which scripts and script execution results are stored. The maximum number of executable scripts is 20. For information about the formats supported by these arguments, see `scripts.logs_dir` and `scripts.script_path` in [Run scripts](https://docs.celerdata.com/private/main/run_scripts).
- `logs_dir`: (Forces new resource) The path in the AWS S3 bucket to which script execution results are stored. This S3 bucket can be the same as or different from the S3 bucket you specify in the `celerdatabyoc_aws_data_credential` resource.
- `script_path`: (Forces new resource) The path in the AWS S3 bucket that stores the scripts to run via Terraform. This S3 bucket must be the one you specify in the `celerdatabyoc_aws_data_credential` resource.
- `run_scripts_parallel`: Whether to execute the scripts in parallel. Valid values: `true` and `false`. Default value: `false`.
- `query_port`: The query port, which must be within the range of 1-65535 excluding 443. The default query port is port 9030. Note that this argument can be specified only at cluster deployment, and cannot be modified once it is set.
- `idle_suspend_interval`: The amount of time (in minutes) during which the cluster can stay idle. After the specified time period elapses, the cluster will be automatically suspended. The Auto Suspend feature is disabled by default. To enable the Auto Suspend feature, set this argument to an integer with the range of 60-999999. To disable this feature again, remove this argument from your Terraform configuration.
- `idle_suspend_interval`: The amount of time (in minutes) during which the cluster can stay idle. After the specified time period elapses, the cluster will be automatically suspended. The Auto Suspend feature is disabled by default, and therefore it is not included in the configuration example above. To enable the Auto Suspend feature, set this argument to an integer within the range of 60-999999. To disable this feature again, remove this argument from your Terraform configuration.

## See Also

Expand Down

0 comments on commit 2ece906

Please sign in to comment.