Skip to content

feat(gitops): add an Artifact Registry push target #509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lucaghersi wants to merge 1 commit into from
Closed

feat(gitops): add an Artifact Registry push target #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 31 additions & 15 deletions .github/workflows/template_gitops.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ on:
type: boolean
default: false
description: "Create GitHub Deployments on the source repository and write tracking annotations to the GitOps CRs"
artifact-registry:
required: false
type: boolean
default: false
description: "Push to Google Artifact Registry instead of Harbor. Overrides docker-registry and prefixes docker-image with the publish repository. Pass the gcp-service-account-key secret alongside it."
multi-arch:
required: false
type: boolean
Expand All @@ -106,6 +111,8 @@ on:
required: false
docker-password:
required: false
gcp-service-account-key:
required: false
docker-build-secrets:
required: false
docker-build-secret-files:
Expand Down Expand Up @@ -148,11 +155,14 @@ jobs:

- name: GitOps (build, push and deploy a new Docker image)
id: gitops
uses: Staffbase/gitops-github-action@158275454d56fd8fa923995220ee1b9eb1030032 # v8.2.1
uses: Staffbase/gitops-github-action@2c7f44d08b1e3e03357a10cfd703bea1c55051c9 # UNRELEASED - re-pin to the release tag before merging
with:
docker-registry: ${{ inputs.docker-registry }}
docker-username: ${{ secrets.docker-username }}
docker-password: ${{ secrets.docker-password }}
# Empty is falsy in an expression, so the condition is negated rather than
# selecting '' on the true branch, which would fall through to the Harbor value.
docker-registry: ${{ inputs.artifact-registry && 'europe-docker.pkg.dev' || inputs.docker-registry }}
docker-username: ${{ !inputs.artifact-registry && secrets.docker-username || '' }}
docker-password: ${{ !inputs.artifact-registry && secrets.docker-password || '' }}
gcp-service-account-key: ${{ secrets.gcp-service-account-key }}
docker-build-args: |
${{ inputs.docker-build-args }}
GONOSUMDB=${{ vars.gonosumdb }}
Expand All @@ -164,7 +174,7 @@ jobs:
docker-build-provenance: ${{ inputs.docker-build-provenance }}
docker-disable-retagging: ${{ inputs.docker-disable-retagging }}
docker-file: ${{ inputs.docker-file }}
docker-image: ${{ inputs.docker-image }}
docker-image: ${{ inputs.artifact-registry && format('staffbase-artifacts/images-publish/{0}', inputs.docker-image) || inputs.docker-image }}
docker-custom-tag: ${{ inputs.docker-custom-tag }}
docker-tag-timestamp: ${{ inputs.docker-tag-timestamp }}
gitops-organization: ${{ inputs.gitops-organization }}
Expand Down Expand Up @@ -200,13 +210,16 @@ jobs:
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

- name: GitOps (build and push by digest)
uses: Staffbase/gitops-github-action@158275454d56fd8fa923995220ee1b9eb1030032 # v8.2.1
uses: Staffbase/gitops-github-action@2c7f44d08b1e3e03357a10cfd703bea1c55051c9 # UNRELEASED - re-pin to the release tag before merging
with:
multiarch-mode: build
multiarch-artifact-name: ${{ inputs.multiarch-artifact-name }}
docker-registry: ${{ inputs.docker-registry }}
docker-username: ${{ secrets.docker-username }}
docker-password: ${{ secrets.docker-password }}
# Empty is falsy in an expression, so the condition is negated rather than
# selecting '' on the true branch, which would fall through to the Harbor value.
docker-registry: ${{ inputs.artifact-registry && 'europe-docker.pkg.dev' || inputs.docker-registry }}
docker-username: ${{ !inputs.artifact-registry && secrets.docker-username || '' }}
docker-password: ${{ !inputs.artifact-registry && secrets.docker-password || '' }}
gcp-service-account-key: ${{ secrets.gcp-service-account-key }}
docker-build-args: |
${{ inputs.docker-build-args }}
GONOSUMDB=${{ vars.gonosumdb }}
Expand All @@ -216,7 +229,7 @@ jobs:
docker-build-provenance: ${{ inputs.docker-build-provenance }}
docker-disable-retagging: ${{ inputs.docker-disable-retagging }}
docker-file: ${{ inputs.docker-file }}
docker-image: ${{ inputs.docker-image }}
docker-image: ${{ inputs.artifact-registry && format('staffbase-artifacts/images-publish/{0}', inputs.docker-image) || inputs.docker-image }}
docker-custom-tag: ${{ inputs.docker-custom-tag }}
docker-tag-timestamp: ${{ inputs.docker-tag-timestamp }}
working-directory: ${{ inputs.working-directory }}
Expand Down Expand Up @@ -248,13 +261,16 @@ jobs:

- name: GitOps (merge manifests and deploy)
id: gitops
uses: Staffbase/gitops-github-action@158275454d56fd8fa923995220ee1b9eb1030032 # v8.2.1
uses: Staffbase/gitops-github-action@2c7f44d08b1e3e03357a10cfd703bea1c55051c9 # UNRELEASED - re-pin to the release tag before merging
with:
multiarch-mode: merge
multiarch-artifact-name: ${{ inputs.multiarch-artifact-name }}
docker-registry: ${{ inputs.docker-registry }}
docker-username: ${{ secrets.docker-username }}
docker-password: ${{ secrets.docker-password }}
# Empty is falsy in an expression, so the condition is negated rather than
# selecting '' on the true branch, which would fall through to the Harbor value.
docker-registry: ${{ inputs.artifact-registry && 'europe-docker.pkg.dev' || inputs.docker-registry }}
docker-username: ${{ !inputs.artifact-registry && secrets.docker-username || '' }}
docker-password: ${{ !inputs.artifact-registry && secrets.docker-password || '' }}
gcp-service-account-key: ${{ secrets.gcp-service-account-key }}
docker-build-args: |
${{ inputs.docker-build-args }}
GONOSUMDB=${{ vars.gonosumdb }}
Expand All @@ -265,7 +281,7 @@ jobs:
docker-build-provenance: ${{ inputs.docker-build-provenance }}
docker-disable-retagging: ${{ inputs.docker-disable-retagging }}
docker-file: ${{ inputs.docker-file }}
docker-image: ${{ inputs.docker-image }}
docker-image: ${{ inputs.artifact-registry && format('staffbase-artifacts/images-publish/{0}', inputs.docker-image) || inputs.docker-image }}
docker-custom-tag: ${{ inputs.docker-custom-tag }}
docker-tag-timestamp: ${{ inputs.docker-tag-timestamp }}
gitops-organization: ${{ inputs.gitops-organization }}
Expand Down
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,23 @@ jobs:

</details>

#### Pushing to Google Artifact Registry

Set `artifact-registry: true` and pass the `GCP_ARTIFACT_PUBLISHER_KEY` organization secret. The
registry becomes `europe-docker.pkg.dev` and `docker-image` is prefixed with the publish
repository, so `sb-images/my-service` is pushed as
`europe-docker.pkg.dev/staffbase-artifacts/images-publish/sb-images/my-service`.

```yaml
with:
artifact-registry: true
secrets:
gcp-service-account-key: ${{ secrets.GCP_ARTIFACT_PUBLISHER_KEY }}
```

Drop `docker-username` and `docker-password`: they are ignored when `artifact-registry` is set.
Pulls are unaffected either way, because the `images` repository serves Harbor as an upstream.

### Jira Ticket Tagging

<details>
Expand Down
Loading