-
-
Save troyharvey/bae82c86c27a3aa539dea83857ee9ecd to your computer and use it in GitHub Desktop.
# Update Jan 2024 | |
# Deploying Cloud Functions is much simpler than it was 6 years ago. | |
# I'm leaving the gist in it's original 2018 state for now, | |
# but skip the the recent comments below for a simpler solution. | |
variables: | |
GCP_ZONE: us-central1-a | |
stages: | |
- npm-install | |
- push | |
npm-install: | |
image: node:8-alpine | |
stage: npm-install | |
only: | |
- master | |
script: | |
- cd replaceWithYourCloudFunction | |
- npm install | |
artifacts: | |
paths: | |
- replaceWithYourCloudFunction/node_modules/ | |
push: | |
stage: push | |
image: docker:latest | |
only: | |
- master | |
dependencies: | |
- npm-install | |
script: | |
# Install CA certs, openssl to https downloads, python for gcloud sdk | |
- apk add --update make ca-certificates openssl python | |
- update-ca-certificates | |
# Download and install Google Cloud SDK | |
- wget https://dl.google.com/dl/cloudsdk/release/google-cloud-sdk.tar.gz | |
- tar zxvf google-cloud-sdk.tar.gz && ./google-cloud-sdk/install.sh --quiet --usage-reporting=false --path-update=true | |
- PATH="google-cloud-sdk/bin:${PATH}" | |
- gcloud --quiet components update | |
- gcloud components install beta | |
# Authenticate using the service account stored here: https://gitlab.com/groups/{YOUR_GITLAB_PROJECT}/-/settings/ci_cd | |
- echo $GCLOUD_SERVICE_KEY > ${HOME}/gcloud-service-key.json | |
- gcloud auth activate-service-account --key-file ${HOME}/gcloud-service-key.json | |
# Deploy | |
- gcloud beta functions deploy replaceWithYourCloudFunction --source=./replaceWithYourCloudFunction --trigger-http |
@muratcorlu
If you set the service key as a file variable instead of a normal variable, then you don't need to create the tmp file, removing first and last step.
@jligeza Good information, thanks. So it'll be that much simple:
deploy to gcloud:
image: google/cloud-sdk:latest
script:
- gcloud auth activate-service-account --key-file $GCLOUD_SERVICE_KEY_FILE
- gcloud functions deploy function-name --runtime nodejs8 --entry-point handler --trigger-http
Hello @muratcorlu,
First thanks for sharing the CI/CD :)
I'll share my tests at this moment to help if other needs them.
For me, the project ID is still mandatory, else I get a:
ERROR: (gcloud.app.deploy) The required property [project] is not currently set.
You may set it for your current workspace by running:
$ gcloud config set project VALUE
or it can be set temporarily by the environment variable [CLOUDSDK_CORE_PROJECT]
ERROR: Job failed: exit code 1
(Which is still strange, cause It's clearly indicated in the JSON as project_id).
Also not sure of what @jiligeza said because i'm not sure of what a "file variable" is (maybe a setting in giltab CI I did not found) and passing it without create a file still cause an error as:
ERROR: (gcloud.auth.activate-service-account) argument --key-file: expected one argument
Usage: gcloud auth activate-service-account [ACCOUNT] --key-file=KEY_FILE [optional flags]
For the moment i'm fighting to find why the CI/CD successfully deploy on staging, but not on prod. Same key, same code and I get a:
ERROR: (gcloud.auth.activate-service-account) Could not read json file /tmp/124294711.json: Expecting value: line 2 column 1 (char 1)
ERROR: Job failed: exit code 1
While on dev branch
$ gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json
Activated service account credentials for: [gitlab@[MASKED].iam.gserviceaccount.com]
Finally got it, problem of variable protection, https://gitlab.com/gitlab-com/support-forum/issues/4660 gave me the lead I was missing.
Got working App Engine CI/CD with:
deploy:
stage: deploy
image: google/cloud-sdk:alpine
only:
- dev
before_script:
- echo $FIREBASE_KEY > ${CI_PROJECT_DIR}/key.json
- echo $GCLOUD_SERVICE_KEY > /tmp/$CI_PIPELINE_ID.json
- gcloud auth activate-service-account --key-file /tmp/$CI_PIPELINE_ID.json
- gcloud config set project $CLOUDSDK_CORE_PROJECT
script:
- cd ${CI_PROJECT_DIR}
- gcloud app deploy
allow_failure: false
And Gitlab CI/CD conf as:
@linceaerian File variable is the type of Pipeline Variable as shown below:
Content will be same. In that case your variable will hold file path of the temporary file that is autmatically created by Gitlab CI. So you will not need to manually create a file and put the content in it.
@muratcorlu, Thanks a lot, I found it later in the day, i've already switched it for the credential part :)
This was a helpful page if you are not familiar with gcloud deploy
https://cloud.google.com/sdk/gcloud/reference/functions/deploy
This + the comments helped me as a template. Thank you so much.
This should be enough for deployment: