Skip to content

Commit

Permalink
Merge pull request #20 from gfortil/HPCC-28377
Browse files Browse the repository at this point in the history
Fix storage_accounts references in readme and elastic4hpcclogs timeout issue.
  • Loading branch information
Godji Fortil authored Oct 13, 2022
2 parents 629273a + 78f38f0 commit a2e14d6
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 31 deletions.
56 changes: 28 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
<br>

#### The `storage_accounts` block:
Expand Down Expand Up @@ -631,29 +631,29 @@ Type `yes` if you didn't pass the flag `-auto-approve`. </li>
<ol>
<li>

Change directory to terraform-azurerm-hpcc/modules/storage_account: `cd terraform-azurerm-hpcc/modules/storage_account` </li>
Change directory to terraform-azurerm-hpcc/modules/storage_accounts: `cd terraform-azurerm-hpcc/modules/storage_accounts` </li>
<li>

Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_account: `cp examples/admin.tfvars .` </li>
Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_accounts: `cp examples/admin.tfvars .` </li>
</ol>
<li>Windows OS</li>
<ol>
<li>

Change directory to terraform-azurerm-hpcc/modules/storage_account: `cd terraform-azurerm-hpcc/modules/storage_account` </li>
Change directory to terraform-azurerm-hpcc/modules/storage_accounts: `cd terraform-azurerm-hpcc/modules/storage_accounts` </li>
<li>

Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_account: `copy examples\admin.tfvars .` </li>
Copy examples/admin.tfvars to terraform-azurerm-hpcc/modules/storage_accounts: `copy examples\admin.tfvars .` </li>
</ol>
<li>

Open `terraform-azurerm-hpcc/modules/storage_account/admin.tfvars` file. </li>
Open `terraform-azurerm-hpcc/modules/storage_accounts/admin.tfvars` file. </li>
<li>

Set attributes to your preferred values. </li>
<li>

Save `terraform-azurerm-hpcc/modules/storage_account/admin.tfvars` file. </li>
Save `terraform-azurerm-hpcc/modules/storage_accounts/admin.tfvars` file. </li>
<li>

Run `terraform init`. This step is only required before your first `terraform apply`. </li>
Expand Down
2 changes: 1 addition & 1 deletion examples/admin.tfvars
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions modules/storage_accounts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<br>

## Providers
Expand Down Expand Up @@ -128,7 +128,7 @@ Usage Example:

<br>

### 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 |
Expand Down

0 comments on commit a2e14d6

Please sign in to comment.