diff --git a/README.md b/README.md index c41e028..67ef75a 100644 --- a/README.md +++ b/README.md @@ -350,28 +350,28 @@ This block deploys the HPCC helm chart. This block is optional. ### The `storage` block: This block deploys the HPCC persistent volumes. This block is required. - | Name | Description | Type | Default | Valid Options | Required | - | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | ------------------------------------------------------ | ---------------- | :---------: | - | default | Use AKS provided storage account? | bool | `false` | `true` , `false` | no | - | version | The version of the storage chart. | string | 0.1.0 | | no | - | local_chart | Path to local chart directory name or tgz file. Example1: /Users/foo/work/demo/helm-chart/helm/examples/azure/hpcc-azurefile Example2: https://github.com/hpcc-systems/helm-chart/raw/master/docs/hpcc-azurefile-0.1.0.tgz | string | null | no | - | remote_chart | URL of the remote chart. Example: https://hpcc-systems.github.io/helm-chart | name | Release name of the chart. | string | `myhpcck8s` | no | - | values | List of desired state files to use similar to -f in CLI. | list(string) | [] | no | - | storage_account | The storage account account to use. | object | Queries attributes' values from storage_account module | - | no | - | version | Version of the storage chart. | string | 0.1.0 | no | - | atomic | If set, installation process purges chart on fail. The `wait` flag will be set automatically if `atomic` is used. | bool | false | no | - | recreate_pods | Perform pods restart during upgrade/rollback. | bool | false | no | - | reuse_values | When upgrading, reuse the last release's values and merge in any overrides. If `reset_values` is specified, this is ignored. | bool | false | no | - | reset_values | When upgrading, reset the values to the ones built into the chart. | bool | false | no | - | force_update | Force resource update through delete/recreate if needed. | bool | false | no | - | cleanup_on_fail | Allow deletion of new resources created in this upgrade when upgrade fails. | bool | false | no | - | disable_openapi_validation | If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema. | bool | false | no | - | max_history | Maximum number of release versions stored per release. | number | 0 | no | - | wait | Will wait until all resources are in a ready state before marking the release as successful. It will wait for as long as `timeout` . | bool | true | no | - | dependency_update | Runs helm dependency update before installing the chart. | bool | false | no | - | timeout | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). | number | 600 | no | - | wait_for_jobs | If wait is enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as `timeout`. | bool | false | no | - | lint | Run the helm chart linter during the plan. | bool | false | no | + | Name | Description | Type | Default | Valid Options | Required | + | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | ------------------------------------------------------- | ---------------- | :---------: | + | default | Use AKS provided storage accounts? | bool | `false` | `true` , `false` | no | + | version | The version of the storage chart. | string | 0.1.0 | | no | + | local_chart | Path to local chart directory name or tgz file. Example1: /Users/foo/work/demo/helm-chart/helm/examples/azure/hpcc-azurefile Example2: https://github.com/hpcc-systems/helm-chart/raw/master/docs/hpcc-azurefile-0.1.0.tgz | string | null | no | + | remote_chart | URL of the remote chart. Example: https://hpcc-systems.github.io/helm-chart | name | Release name of the chart. | string | `myhpcck8s` | no | + | values | List of desired state files to use similar to -f in CLI. | list(string) | [] | no | + | storage_accounts | The storage account to use. | object | Queries attributes' values from storage_accounts module | - | no | + | version | Version of the storage chart. | string | 0.1.0 | no | + | atomic | If set, installation process purges chart on fail. The `wait` flag will be set automatically if `atomic` is used. | bool | false | no | + | recreate_pods | Perform pods restart during upgrade/rollback. | bool | false | no | + | reuse_values | When upgrading, reuse the last release's values and merge in any overrides. If `reset_values` is specified, this is ignored. | bool | false | no | + | reset_values | When upgrading, reset the values to the ones built into the chart. | bool | false | no | + | force_update | Force resource update through delete/recreate if needed. | bool | false | no | + | cleanup_on_fail | Allow deletion of new resources created in this upgrade when upgrade fails. | bool | false | no | + | disable_openapi_validation | If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema. | bool | false | no | + | max_history | Maximum number of release versions stored per release. | number | 0 | no | + | wait | Will wait until all resources are in a ready state before marking the release as successful. It will wait for as long as `timeout` . | bool | true | no | + | dependency_update | Runs helm dependency update before installing the chart. | bool | false | no | + | timeout | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). | number | 600 | no | + | wait_for_jobs | If wait is enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as `timeout`. | bool | false | no | + | lint | Run the helm chart linter during the plan. | bool | false | no |
#### The `storage_accounts` block: @@ -631,29 +631,29 @@ Type `yes` if you didn't pass the flag `-auto-approve`.
  1. -Change directory to terraform-azurerm-hpcc/modules/storage_account: `cd terraform-azurerm-hpcc/modules/storage_account`
    2. +Change directory to terraform-azurerm-hpcc/modules/storage_accounts: `cd terraform-azurerm-hpcc/modules/storage_accounts`
  2. -Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_account: `cp examples/admin.tfvars .`
    3. +Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_accounts: `cp examples/admin.tfvars .`
  • Windows OS
    1. -Change directory to terraform-azurerm-hpcc/modules/storage_account: `cd terraform-azurerm-hpcc/modules/storage_account`
      2. +Change directory to terraform-azurerm-hpcc/modules/storage_accounts: `cd terraform-azurerm-hpcc/modules/storage_accounts`
    2. -Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_account: `copy examples\admin.tfvars .`
      3. +Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_accounts: `copy examples\admin.tfvars .`
  • -Open `terraform-azurerm-hpcc/modules/storage_account/admin.tfvars` file.
    • +Open `terraform-azurerm-hpcc/modules/storage_accounts/admin.tfvars` file.
  • Set attributes to your preferred values.
  • -Save `terraform-azurerm-hpcc/modules/storage_account/admin.tfvars` file.
    • +Save `terraform-azurerm-hpcc/modules/storage_accounts/admin.tfvars` file.
  • Run `terraform init`. This step is only required before your first `terraform apply`.
    • diff --git a/examples/admin.tfvars b/examples/admin.tfvars index cabce47..ce02c46 100644 --- a/examples/admin.tfvars +++ b/examples/admin.tfvars @@ -234,7 +234,7 @@ elastic4hpcclogs = { max_history = 0 wait = true dependency_update = true - timeout = 300 + timeout = 900 wait_for_jobs = false lint = false remote_chart = "https://hpcc-systems.github.io/helm-chart" diff --git a/modules/storage_accounts/README.md b/modules/storage_accounts/README.md index cdf196b..a36bb67 100644 --- a/modules/storage_accounts/README.md +++ b/modules/storage_accounts/README.md @@ -8,7 +8,7 @@ ## Introduction -This module deploys a storage account for the HPCC Systems cloud native platform using remote modules. +This module deploys storage accounts for the HPCC Systems cloud native platform using remote modules.
    ## Providers @@ -128,7 +128,7 @@ Usage Example:
    -### The `storage_account` block: +### The `storage_accounts` block: This block deploys the storage accounts for HPCC-Platform data planes. This block is required. | Name | Description | Type | Default | Valid Options | Required |