Use Serverless to deploy Sample Google Cloud Functions

As a AWS Cloud practitionar, I use various serverless deployment in AWS cloud. However as a experiment wanted to see do serverless provide similar experience for google cloud too! Let’s check.

Installation Of Software

Serverless installation is based on npm pacakage. I am using Linux Mint OS (ubuntu architecture). So command may very for other operating systems.

## Install Nodejs & npm
curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs
## You may also need development tools to build native addons:
     sudo apt-get install gcc g++ make
## To install the Yarn package manager, run:
     curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | gpg --dearmor | sudo tee /usr/share/keyrings/yarnkey.gpg >/dev/null
     echo "deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
     sudo apt-get update && sudo apt-get install yarn
# Install actual software :) serverless
npm install -g serverless

Check installation software versions

To debug any issue, it is very important that version of software we are using. so check below command & verify version. I have noted down the output for reference too

nirav@nirav-IdeaPad-Gaming-3-15ARH05:~$ npm version
{
  npm: '8.12.1',
  node: '18.4.0',
  v8: '10.2.154.4-node.8',
  uv: '1.43.0',
  zlib: '1.2.11',
  brotli: '1.0.9',
  ares: '1.18.1',
  modules: '108',
  nghttp2: '1.47.0',
  napi: '8',
  llhttp: '6.0.6',
  openssl: '3.0.3+quic',
  cldr: '41.0',
  icu: '71.1',
  tz: '2022a',
  unicode: '14.0',
  ngtcp2: '0.1.0-DEV',
  nghttp3: '0.1.0-DEV'
}
nirav@nirav-IdeaPad-Gaming-3-15ARH05:~$ node --version
v18.4.0
nirav@nirav-IdeaPad-Gaming-3-15ARH05:~$ yarn --version
1.22.19
nirav@nirav-IdeaPad-Gaming-3-15ARH05:~$ sls --version
Framework Core: 3.19.0
Plugin: 6.2.2
SDK: 4.3.2
nirav@nirav-IdeaPad-Gaming-3-15ARH05:~$ serverless --version
Framework Core: 3.19.0
Plugin: 6.2.2
SDK: 4.3.2

Install Cloudfunction specific library

Now that we have setup serverless, we can use modules which we wanted to work upon. In this example we are going to use cloud function. So install that plugin.

npm install --save serverless-google-cloudfunctions

Login with google Auth

We can connect serverless with google authentication or with service account. I am using google authentication for simplicity.

gcloud auth application-default login

Enable servicez

By default Google cloud allow few services in each project. For newly created project please enable it. This activity is one time only.

gcloud services enable deploymentmanager.googleapis.com
gcloud services enable cloudfunctions.googleapis.com
gcloud services enable cloudbuild.googleapis.com

Write Simple http function

serverless makes it easy to setup. We can create below small file which has environment variables defined too. That’s it sample code ready to fly

# serverless.yml
service: my-gcloud-service
package:
  patterns:
   - '!node_modules/**'
  excludeDevDependencies: true
provider:
  name: google
  project: my-test
  labels:
    application: serverless-example
environment:
  max_delay: '5000'
plugins:
  - serverless-google-cloudfunctions
functions:
  first:
    handler: http
    events:
    - http: path
    labels:
      team: gcf-team

Index file: A small http response

// index.js
exports.http = (request, response) =>{
  response.status(200).send('Hello World!');
};

Test Locally

Most important thing abot serverless is simple command to test locally or from server.

nirav@nirav-IdeaPad-Gaming-3-15ARH05:~/gcloud$ sls invoke local  --function first
Running "serverless" from node_modules
{
    "status": 200,
    "headers": {
        "content-type": "text/html; charset=utf-8",
        "content-length": "12",
        "etag": "W/\"c-Lve95gjOVATpfV8EL5X4nxwjKHE\""
    },
    "body": "Hello World!"
}

[optionally] Package function

We can package function to see any compile time error or build errors. This steps is optional & already covered by deploy function too.

nirav@nirav-IdeaPad-Gaming-3-15ARH05:~/gcloud$ sls package
Running "serverless" from node_modules
Compiling function "first"...

Deploy function

Same way we can deploy funtion in environment we are conencted with. Please check required information where it is pointing before executing.

#Testing we are pointing right environment
gcloud info
gcloud auth list
# deploy function
nirav@nirav-IdeaPad-Gaming-3-15ARH05:~/gcloud$ sls deploy 
Running "serverless" from node_modules
Compiling function "first"...
Uploading artifacts...
Artifacts successfully uploaded...
Updating deployment...
Checking deployment update progress...
..........
Done...
Service Information
service: my-gcloud-service
project: awacs-test
stage: dev
region: us-central1
Deployed functions
first
  https://us-central1-my-test.cloudfunctions.net/my-gcloud-service-dev-first

Execute Functions

When you execute url directly it will fail, as it do require authentication

We can execute it with serverless or gcloud command

#With gcloud command
nirav@nirav-IdeaPad-Gaming-3-15ARH05:~/gcloud$ gcloud functions call my-gcloud-service-dev-first 
executionId: ykno5z83bs3c
result: Hello World!
#With sls
sls invoke  --function first

Reference:

Reference:

Serverless Framework - Google Cloud Functions Guide - Installing The Serverless Framework

https://techviewleo.com/how-to-install-nodejs-in-linux-mint/

Serverless Framework - Google Cloud Functions Guide - Credentials