chore: add aws example to readme
This commit is contained in:
27
README.md
27
README.md
@@ -12,7 +12,7 @@ To use this action, add the following step to your GitHub Action workflow:
|
|||||||
base64-kube-config: ${{ secrets.KUBE_CONFIG }}
|
base64-kube-config: ${{ secrets.KUBE_CONFIG }}
|
||||||
```
|
```
|
||||||
|
|
||||||
Keep in mind that the action expects a base64 encoded string of your Kubernetes configuration. The simplest way to do that is to run `cat $HOME/.kube/config | base64` and save that output as an action secret.
|
Keep in mind that the action expects a base64 encoded string of your Kubernetes configuration. The simplest way to do that is to run `cat $HOME/.kube/config | base64` and save that output as an action secret. It's additionally possible to generate a config file using the `aws` CLI for EKS or any other tools with other cloud providers.
|
||||||
|
|
||||||
It's also possible to specify the version of the [kubectl](https://kubernetes.io/docs/reference/kubectl/) CLI to use. The current default release used by this action is the latest version.
|
It's also possible to specify the version of the [kubectl](https://kubernetes.io/docs/reference/kubectl/) CLI to use. The current default release used by this action is the latest version.
|
||||||
|
|
||||||
@@ -40,3 +40,28 @@ jobs:
|
|||||||
base64-kube-config: ${{ secrets.KUBE_CONFIG }}
|
base64-kube-config: ${{ secrets.KUBE_CONFIG }}
|
||||||
- run: kubectl get pods
|
- run: kubectl get pods
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Here's an example using AWS EKS:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Kubectl Action
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Configure AWS Credentials
|
||||||
|
uses: aws-actions/configure-aws-credentials@v4
|
||||||
|
with:
|
||||||
|
role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
|
||||||
|
aws-region: us-east-2
|
||||||
|
- name: Generate kubeconfig
|
||||||
|
run: echo "EKS_CREDS=$(aws eks update-kubeconfig --region us-east-2 --name my-cluster --dry-run | base64) >> $GITHUB_ENV
|
||||||
|
- uses: tale/kubectl-action@v1
|
||||||
|
with:
|
||||||
|
base64-kube-config: ${{ env.EKS_CREDS }}
|
||||||
|
- run: kubectl get pods
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user