Skip to content

Work on creating a mesh network on GCP using Cloud Run managed & Cloud Functions

Notifications You must be signed in to change notification settings

AnatidaeProject/serverless-mesh-gcp

Repository files navigation

@anatidaeproject/serverless-mesh

Overview

Creating an ephermal service mesh using 100% serverless PAAS solutions on GCP.

Platform services used:

  • GCP Cloud Run
  • GCP Cloud Functions
  • GCP Cloud PubSub
  • Firebase Realtime Database

Setup

1. Install Firebase Tools

Make sure to install the emulators for testing.

npm i -g firebase-tools

Firebase can be a little picky about credentials, even when you are working locally. To this end, you will want to modify a few files and generate a service account key

2. Service Account Key:

Form the Firebase console, generate a service account key. This will be a JSON file. Mine looks like: serverless-mesh-brianm-firebase-adminsdk-ezhk3-8eed18e18a.json. Add that file to a top level folder called __SECRETS__ or whatever else you feel like using.

Modify the files so that the projet name is correct and the path to your secrets file is correct:

.env.test
.firebaserc

3. Install Dependencies

Just like all NodeJS projects, install everything

npm install

Running Demo

Functions

In order to test the functions, build them with:

npm run build:functions

Or if you want to modify the code, you can start the watcher

npm run build:functions:watch

Services Detail

The NX tooling treats apps as deployable units. libs are shared libaries. In this case, the apps will represent a node. In the case of the apps/functions this will represent multiple nodes as Firebase Functions can deploy from a single entry point.

Most of the logic for this demo will reside in libs


This project was generated using Nx.

🔎 Nx is a set of Extensible Dev Tools for Monorepos.

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • React
    • npm install --save-dev @nrwl/react
  • Web (no framework frontends)
    • npm install --save-dev @nrwl/web
  • Angular
    • npm install --save-dev @nrwl/angular
  • Nest
    • npm install --save-dev @nrwl/nest
  • Express
    • npm install --save-dev @nrwl/express
  • Node
    • npm install --save-dev @nrwl/node

There are also many community plugins you could add.

Generate an application

Run nx g @nrwl/react:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run nx g @nrwl/react:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are sharable across libraries and applications. They can be imported from @anatidaeproject/mylib.

Development server

Run nx serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run nx g @nrwl/react:component my-component --project=my-app to generate a new component.

Build

Run nx build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run nx test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx dep-graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Computation Memoization in the Cloud

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.

About

Work on creating a mesh network on GCP using Cloud Run managed & Cloud Functions

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published