aligor/cloud-functions-proxy repository overview

⁠cloud-functions-proxy

⁠Install

go get -d -v ./...

Optional if you want to run app with docker.

⁠Run

# With go 1.15
go run .
# You can also use docker
make run

You can check it here: http://localhost:8080/up⁠

⁠Quick call

⁠Without service account

GCP_PROJECT=#Google project ID
GCP_FUNCTIONS_REGION=#Cloud functions region
GCP_TOKEN=$(gcloud auth print-identity-token) #OIDC token
CLOUD_FUNCTION=#Cloud function's path
curl "localhost:8080/api/$CLOUD_FUNCTION" -H "GCP_PROJECT: $GCP_PROJECT" -H "GCP_FUNCTIONS_REGION: $GCP_FUNCTIONS_REGION" -H "GCP_TOKEN: $GCP_TOKEN"

⁠With service account

export GOOGLE_APPLICATION_CREDENTIALS="PATH_TO_CREDENTIALS"
GCP_PROJECT=#Google project ID
GCP_FUNCTIONS_REGION=#Cloud functions region
CLOUD_FUNCTION=#Cloud function's path
curl "localhost:8080/api/$CLOUD_FUNCTION" -H "GCP_PROJECT: $GCP_PROJECT" -H "GCP_FUNCTIONS_REGION: $GCP_FUNCTIONS_REGION"

⁠Build

You can build the docker image:

make build

Or a go binary:

env GOOS=target-OS GOARCH=target-architecture go build .

⁠Functionnalities

⁠Endpoint /up

Simple call to test if application is ready.

⁠Endpoint /kill

This call can be use to stop the application.

⁠Endpoint /api

This is the base endpoint to use proxy call.

To target a Google Cloud Function with a path like /my-function, you have to call /api/my-function of this proxy.

In order to specify which audience you want to call, you need to set these variables:

There is 2 ways to set it.

1. In an environment variable with the same name.
2. In a header of the request call with the same name. (Override the first way).

Now to authenticate your calls, there is 2 ways again:

1. With GCP_TOKEN set in request's header with an OIDC token which identify an account/user with cloudfunctions.functions.invoke permission.
2. With a service account:
   Set GOOGLE_APPLICATION_CREDENTIALS environement variable to target path to json/p12 credentials file of the service account with cloudfunctions.functions.invoke permission. This cannot be overriden by the first way.