Merge pull request #112 from dineshba/workload-identity-gcr-gar

Update readme with workload identity based authentication for GCR and GAR
This commit is contained in:
CrazyMax 2022-02-03 17:48:36 +01:00 committed by GitHub
commit 17f28ab24d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

104
README.md
View file

@ -39,7 +39,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -64,7 +64,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -92,7 +92,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -118,7 +118,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -142,6 +142,45 @@ jobs:
> Google Container Registry, use the information [on this page](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr) > Google Container Registry, use the information [on this page](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr)
> to learn about transitioning to Google Artifact Registry. > to learn about transitioning to Google Artifact Registry.
You can use either workload identity federation based keyless authentication or service account based authentication.
#### Workload identity federation based authentication
Configure the workload identity federation for github actions in gcloud (for steps, [refer here](https://github.com/google-github-actions/auth#setting-up-workload-identity-federation)). In the steps, your service account should the ability to push to GCR. Then use google-github-actions/auth action for authentication using workload identity like below:
```yaml
name: ci
on:
push:
branches: main
jobs:
login:
runs-on: ubuntu-latest
steps:
- id: 'auth'
name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0'
with:
token_format: 'access_token'
workload_identity_provider: '<workload_identity_provider>'
service_account: '<service_account>'
- name: Login to GCR
uses: docker/login-action@v1
with:
registry: gcr.io
username: oauth2accesstoken
password: ${{ steps.auth.outputs.access_token }}
```
> Replace `<workload_identity_provider>` with configured workload identity provider. For steps to configure, [refer here](https://github.com/google-github-actions/auth#setting-up-workload-identity-federation).
> Replace `<service_account>` with configured service account in workload identity provider which has access to push to GCR
#### Service account based authentication
Use a service account with the ability to push to GCR and [configure access control](https://cloud.google.com/container-registry/docs/access-control). Use a service account with the ability to push to GCR and [configure access control](https://cloud.google.com/container-registry/docs/access-control).
Then create and download the JSON key for this service account and save content of `.json` file Then create and download the JSON key for this service account and save content of `.json` file
[as a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) [as a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@ -153,7 +192,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -170,6 +209,47 @@ jobs:
### Google Artifact Registry (GAR) ### Google Artifact Registry (GAR)
You can use either workload identity federation based keyless authentication or service account based authentication.
#### Workload identity federation based authentication
Configure the workload identity federation for github actions in gcloud (for steps, [refer here](https://github.com/google-github-actions/auth#setting-up-workload-identity-federation)). In the steps, your service account should the ability to push to GAR. Then use google-github-actions/auth action for authentication using workload identity like below:
```yaml
name: ci
on:
push:
branches: main
jobs:
login:
runs-on: ubuntu-latest
steps:
- id: 'auth'
name: 'Authenticate to Google Cloud'
uses: 'google-github-actions/auth@v0'
with:
token_format: 'access_token'
workload_identity_provider: '<workload_identity_provider>'
service_account: '<service_account>'
- name: Login to GAR
uses: docker/login-action@v1
with:
registry: <location>-docker.pkg.dev
username: oauth2accesstoken
password: ${{ steps.auth.outputs.access_token }}
```
> Replace `<workload_identity_provider>` with configured workload identity provider
> Replace `<service_account>` with configured service account in workload identity provider which has access to push to GCR
> Replace `<location>` with the regional or multi-regional [location](https://cloud.google.com/artifact-registry/docs/repo-organize#locations)
> of the repository where the image is stored.
#### Service account based authentication
Use a service account with the ability to push to GAR and [configure access control](https://cloud.google.com/artifact-registry/docs/access-control). Use a service account with the ability to push to GAR and [configure access control](https://cloud.google.com/artifact-registry/docs/access-control).
Then create and download the JSON key for this service account and save content of `.json` file Then create and download the JSON key for this service account and save content of `.json` file
[as a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) [as a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository)
@ -181,7 +261,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -210,7 +290,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -233,7 +313,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -260,7 +340,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -293,7 +373,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -327,7 +407,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login:
@ -353,7 +433,7 @@ name: ci
on: on:
push: push:
branches: master branches: main
jobs: jobs:
login: login: