Skip to content

Commit

Permalink
Cosmetics in README, bump image version (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoDiazL authored Oct 28, 2024
1 parent e7895b3 commit 99dab66
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 39 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM alpine/k8s:1.29.1
FROM alpine/k8s:1.29.10

COPY deploy.sh /usr/local/bin/deploy

Expand Down
75 changes: 37 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The following inputs are available as `step.with` keys:

```yaml
- name: Deploy Helm
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand All @@ -89,7 +89,7 @@ The following inputs are available as `step.with` keys:
## Example 2 - Custom Chart Repo
```yaml
- name: Deploy Helm
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand All @@ -109,7 +109,7 @@ The following inputs are available as `step.with` keys:
## Example 3 - OCI Chart Repo
```yaml
- name: Deploy Helm
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand All @@ -132,7 +132,7 @@ The following inputs are available as `step.with` keys:
aws-region: ${{ env.aws-region }}

- name: Install Helm Chart
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-region: ${{ env.aws-region }}
cluster-name: eks-cluster-${{ env.environment }}
Expand All @@ -142,7 +142,7 @@ The following inputs are available as `step.with` keys:
## Example 5 - Use secrets with vals backend
```yaml
- name: Deploy Helm
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand All @@ -157,10 +157,36 @@ The following inputs are available as `step.with` keys:
plugins: https://github.com/jkroepke/helm-secrets
```
## Example 6 - Use with S3 as repo
## Example 6 - Define multiple values
```yaml
- name: Install Karpenter
uses: bitovi/[email protected]
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: ${{ vars.AWS_REGION }}
cluster-name: ${{ vars.CLUSTER_NAME }}
cluster-role-arn: ${{ secrets.AWS_ROLE_ARN }}
chart-repository: oci://public.ecr.aws
chart-path: karpenter/karpenter
helm-wait: true
namespace: karpenter
name: karpenter
values: |
settings.clusterName=${{ vars.CLUSTER_NAME }},
settings.interruptionQueue=${{ vars.CLUSTER_NAME }}-karpenter,
controller.resources.requests.cpu=1,
controller.resources.requests.memory=1Gi,
controller.resources.limits.cpu=1,
controller.resources.limits.memory=1Gi
version: 1.0.6
```
## Example 7 - Use with S3 as repo
```yaml
- name: Deploy S3 Helm chart
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand All @@ -175,7 +201,7 @@ The following inputs are available as `step.with` keys:
```
* See the [official AWS Guide](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/set-up-a-helm-v3-chart-repository-in-amazon-s3.html) on how to set this up.
## Example 7 - Use a different role in the Action than the role the cluster was built with
## Example 8 - Use a different role in the Action than the role the cluster was built with
**action.yaml**
```yaml
Expand All @@ -185,40 +211,13 @@ The following inputs are available as `step.with` keys:
role-to-assume: arn:aws:iam::${{ env.aws-account-id }}:role/${{ env.aws-assume-role }}
aws-region: ${{ env.aws-region }}
- name: Install Helm Chart
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-region: ${{ env.aws-region }}
cluster-name: eks-cluster-${{ env.environment }}
... (put your other arguments here)
```

## Example 8 - Use a different role in the Action than the role the cluster was built with

**action.yaml**
```yaml
- name: Install Karpenter
uses: bitovi/github-actions-deploy-eks-helm
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: ${{ vars.AWS_REGION }}
cluster-name: ${{ vars.CLUSTER_NAME }}
cluster-role-arn: ${{ secrets.AWS_ROLE_ARN }}
chart-repository: oci://public.ecr.aws
chart-path: karpenter/karpenter
helm-wait: true
namespace: karpenter
name: karpenter
values: |
settings.clusterName=${{ vars.CLUSTER_NAME }},
settings.interruptionQueue=${{ vars.CLUSTER_NAME }}-karpenter,
controller.resources.requests.cpu=1,
controller.resources.requests.memory=1Gi,
controller.resources.limits.cpu=1,
controller.resources.limits.memory=1Gi
version: 1.0.6
```
**terraform.tf**
```yaml
... (surrounding code)
Expand Down Expand Up @@ -254,7 +253,7 @@ The following inputs are available as `step.with` keys:

```yaml
- name: Deploy Helm
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand All @@ -269,7 +268,7 @@ The following inputs are available as `step.with` keys:
```yaml
- name: Deploy Helm
uses: bitovi/[email protected].10
uses: bitovi/[email protected].11
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand Down

0 comments on commit 99dab66

Please sign in to comment.