deploy
Module to help deploy and run Google App Engine projects with features like:
- Deploy multiple services for production and staging.
- Sync static files from your PC to Google Storage and to App instances.
Install
npm install @invisible/deploy
# or
yarn add @invisible/deploy
Make sure to install as a normal dependency, since part of it is run on the deployed instance, and dev-dependencies are not installed on production.
Prerequisites
- Create a project https://console.cloud.google.com and note the project ID.
- Install the
gcloud
sdk https://cloud.google.com/sdk/downloads - If this is your first time using the gcloud sdk make sure to run
gcloud auth login
- From your project directory, run
gcloud app create --project=your-project-id --region=us-central
Setting up
- Create an
.env
file in your project's root folder.
Add your GCLOUD_PROJECT
environment variable to it. Don't set PORT
in your staging/.env
or production/.env
, GAE will set this for you.
GCLOUD_PROJECT=gae-project-id-1a6std
This will be used to sync your local storage
files to the bucket.
-
Run ./node_modules/.bin/deploy setup
to create the backend bucket on Google Cloud.
-
Create a folder named storage
on your project's root folder. Inside this folder you should have one folder for each services you want to deploy.
In each folder you should store the files you want to sync in your instances.
storage
├── production
│ └── .env
└── staging
└── .env
-
Add storage
to your .gitignore
file.
-
Create an GAE yaml config file for each environment you want to have.
service: default
runtime: nodejs
env: flex
skip_files:
- ^node_modules$
- ^ignore$
- ^.env$
service: staging
runtime: nodejs
env: flex
skip_files:
- ^node_modules$
- ^ignore$
- ^.env$
manual_scaling:
instances: 1
- Add sync to your
prestart
hook on package.json
:
// package.json
"scripts": {
"prestart": "./node_modules/.bin/sync",
...
}
-
Make sure you already have a default
service running before you deploy any other. You can deploy to production with ./node_modules/.bin/deploy production
.
-
If you are experience a bug, it might be a problem with the --quiet
flag, so try running the command
gcloud app deploy production.yaml --project=your-project-id --promote
Commands
deploy
Usage:
deploy [setup|download|static|production|staging|branchName]
Argument can be:
-
setup
Creates the default backend bucket for this project.
-
download
Downloads all static files from the backend bucket.
-
static
Uploads all static files to the backend bucket.
-
branchName
Uploads branch static files and deploys the App to Google App Engine based on branchName.yaml
file.
sync
Usage: Add ./node_modules/.bin/sync
as the value of scripts.prestart
on your package.json
.
Retrieve files from your project's backend bucket and place it on current instance's root folder.