GitHub Action
gcpcc
v1.0.2
Latest version
Simple tool to print out the current number of compute instances on GCP
Created to to prefrom GitHub Actions powered automatic checks.
Did someone leave a compute instance on that shouldn't be?
Currently none, authentication credentials are read from the environment.
There are 3 recomended approaches:
- Pass GCP credentials JSON directly via
GOOGLE_APPLICATION_CREDENTIALS_DATA - The "typical" approach of
GOOGLE_APPLICATION_CREDENTIALS(path to JSON file) - Using GitHub Actions OIDC with GCP see here
# ...
steps:
- uses: dacbd/gcpcc@v1
env:
GOOGLE_APPLICATION_CREDENTIALS_DATA: ${{ secrets.GCP_SA_KEY_JSON }}# ...
steps:
- uses: google-github-actions/auth@v0
with:
credentials_json: ${{ secrets.gcp_sa_key_json }}
- uses: dacbd/gcpcc@v1# ...
# Add "id-token" with the intended permissions.
permissions:
contents: 'read'
id-token: 'write'
steps:
- uses: google-github-actions/auth@v0
with:
workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'
service_account: 'my-service-account@my-project.iam.gserviceaccount.com'
- uses: dacbd/gcpcc@v1| outputs | value |
|---|---|
| total | int - total number of compute instance |
Basic example:
name: Check ML Training instances
on:
schedule:
cron:
- ''
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3 # not technically required
- uses: google-github-actions/auth@v0
with:
credentials_json: ${{ secrets.GCP_SA_KEY_JSON }}
- uses: dacbd/gcpcc@v1
id: gcpcc
- uses: dacbd/create-issue-action@v1
if: steps.gcpcc.outputs.total != 0
with:
token: ${{ github.token }}
title: Instance left on in `${{ env.GCP_PROJECT }}`
assignees: dacbd,some_github_username
body: |
Automatic check found `${{ steps.gcpcc.outputs.total }}` instance\s left on.TODO