Skip to content

Commit dfff758

Browse files
authored
Merge pull request #4 from evosecurity/main
Update readme and add option for helm —wait
2 parents 6672210 + fdffa23 commit dfff758

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,23 @@ Note: If your EKS cluster administrative access is in a private network, you wi
1010

1111
Following inputs can be used as `step.with` keys
1212

13-
| Name | Type | Description |
14-
|------------------|---------|------------------------------------|
15-
| `aws-secret-access-key` | String | AWS secret access key part of the aws credentials. This is used to login to EKS. |
16-
| `aws-access-key-id` | String | AWS access key id part of the aws credentials. This is used to login to EKS. |
17-
| `aws-region` | String | AWS region to use. This must match the region your desired cluster lies in. |
18-
| `cluster-name` | String | The name of the desired cluster. |
19-
| `cluster-role-arn` | String | If you wish to assume an admin role, provide the role arn here to login as. |
20-
| `config-files` | String | Comma separated list of helm values files. |
21-
| `namespace` | String | Kubernetes namespace to use. Will create if it does not exist |
22-
| `values` | String | Comma separated list of value set for helms. e.x: key1=value1,key2=value2 |
23-
| `name` | String | The name of the helm release |
24-
| `chart-path` | String | The path to the chart. (defaults to `helm/`) |
25-
| `chart-repository` | String | The URL of the chart-repository (Optional)
26-
| `plugins` | String | Comma separated list of plugins to install. e.x: https://github.com/hypnoglow/helm-s3.git, https://github.com/someuser/helm-plugin.git (defaults to none) |
27-
13+
| Name | Type | Description |
14+
| ----------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| `aws-secret-access-key` | String | AWS secret access key part of the aws credentials. This is used to login to EKS. |
16+
| `aws-access-key-id` | String | AWS access key id part of the aws credentials. This is used to login to EKS. |
17+
| `aws-region` | String | AWS region to use. This must match the region your desired cluster lies in. |
18+
| `cluster-name` | String | The name of the desired cluster. |
19+
| `cluster-role-arn` | String | If you wish to assume an admin role, provide the role arn here to login as. |
20+
| `config-files` | String | Comma separated list of helm values files. |
21+
| `namespace` | String | Kubernetes namespace to use. Will create if it does not exist |
22+
| `values` | String | Comma separated list of value set for helms. e.x: key1=value1,key2=value2 |
23+
| `name` | String | The name of the helm release |
24+
| `chart-path` | String | The path to the chart. (defaults to `helm/`) |
25+
| `chart-repository` | String | The URL of the chart-repository (Optional) |
26+
| `plugins` | String | Comma separated list of plugins to install. e.x: https://github.com/hypnoglow/helm-s3.git, https://github.com/someuser/helm-plugin.git (defaults to none) |
27+
| `timeout` | String | The value of the timeout for the helm release |
28+
| `update-deps` | String | Update chart dependencies |
29+
| `helm-wait` | String | Add the helm --wait flag to the helm Release |
2830

2931
## Example usage
3032

action.yaml

+5-1
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,12 @@ inputs:
5151
plugins:
5252
description: 'Comma separated list of helm plugins to install. e.x: https://github.com/hypnoglow/helm-s3.git,https://github.com/someuser/helm-plugin.git'
5353
required: false
54+
helm-wait:
55+
description: 'Add the --wait flag to helm'
56+
required: false
5457
runs:
5558
using: 'docker'
56-
image: 'bitovi/deploy-eks-helm:v1.0.0'
59+
image: 'docker://bitovi/deploy-eks-helm:v1.0.1'
5760
env:
5861
AWS_REGION: ${{ inputs.aws-region }}
5962
AWS_SECRET_ACCESS_KEY: ${{ inputs.aws-secret-access-key }}
@@ -68,4 +71,5 @@ runs:
6871
TIMEOUT: ${{ inputs.timeout }}
6972
UPDATE_DEPS: ${{ inputs.update-deps }}
7073
HELM_REPOSITORY: ${{ inputs.chart-repository }}
74+
HELM_WAIT: ${{ inputs.helm-wait }}
7175
PLUGINS_LIST: ${{ inputs.plugins }}

deploy.sh

+5
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ fi
5656
# Upgrade or install the chart. This does it all.
5757
HELM_COMMAND="helm upgrade --install --timeout ${TIMEOUT}"
5858

59+
# If we should wait, then do so
60+
if [ -n "${HELM_WAIT}" ]; then
61+
HELM_COMMAND="${HELM_COMMAND} --wait"
62+
fi
63+
5964
# Set paramaters
6065
for config_file in ${DEPLOY_CONFIG_FILES//,/ }
6166
do

0 commit comments

Comments
 (0)