Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edvisor-io/meteor-google-cloud
Automate Meteor deployments on Google Cloud App Engine Flexible
https://github.com/edvisor-io/meteor-google-cloud
app-engine deployment gcp google hosting meteor
Last synced: about 2 months ago
JSON representation
Automate Meteor deployments on Google Cloud App Engine Flexible
- Host: GitHub
- URL: https://github.com/edvisor-io/meteor-google-cloud
- Owner: edvisor-io
- License: mit
- Created: 2019-04-30T08:16:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T20:42:13.000Z (about 2 years ago)
- Last Synced: 2024-11-16T09:30:49.034Z (about 2 months ago)
- Topics: app-engine, deployment, gcp, google, hosting, meteor
- Language: JavaScript
- Size: 1.18 MB
- Stars: 29
- Watchers: 8
- Forks: 7
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-meteor - meteor-google-cloud - Automate Meteor deployments on Google Cloud App Engine Flexible (Deployment)
README
# Meteor Google Cloud
[](https://www.repostatus.org/#active)
A command line tool for deploying Meteor applications on Google Cloud App Engine Flexible.
## What is Google Cloud App Engine Flexible?
App Engine allows developers to focus on doing what they do best, writing code. Based on Google Compute Engine, the App Engine flexible environment automatically scales your app up and down while balancing the load.
*Meteor needs to run on App Engine Flexible, not Standard.*
App Engine manages your virtual machines, ensuring that:
- Instances are health-checked, healed as necessary, and co-located with other services within the project.
Critical, backwards compatible updates are automatically applied to the underlying operating system.
- VM instances are automatically located by geographical region according to the settings in your project. Google's management services ensure that all of a project's VM instances are co-located for optimal performance.
- VM instances are restarted on a weekly basis. During restarts Google's management services will apply any necessary operating system and security updates.
- You always have root access to Compute Engine VM instances. SSH access to VM instances in the flexible environment is disabled by default. If you choose, you can enable root access to your app's VM instances.
For more information, check: [App Engine Flexible Environment's page](https://cloud.google.com/appengine/docs/flexible/).
## App Engine Flexible Pricing
Because we run Meteor on the Flexible environment you may not be able to use the free tier of App Engine Standard. For the first year you may have $300 in credit per month, but be aware of the costs:
- [Pricing calculator.](https://cloud.google.com/products/calculator/#id=126a7009-debc-49e7-8e36-f7d5574ecfc1)
- [More info on App Engine billing.](https://stackoverflow.com/questions/47125661/pricing-of-google-app-engine-flexible-env-a-500-lesson)
## Installation
```bash
npm install meteor-google-cloud -g
```
## Deploying
To deploy to App Engine Flexible, follow the steps bellow:
### 1. Install gcloud CLI
```bash
Follow the guide on: https://cloud.google.com/sdk/install
```
### 2. Init Meteor Google Cloud
If this is the first time you deploy, you will need some specific files on your repo, run the command below to get them automatically generated.
```bash
meteor-google-cloud --init
```
### 3. Set your App Engine Flexible settings
```bash
cd ./deploy
ls
Dockerfile app.yml settings.json
```
- Dockerfile: you can customize your Docker image, if you don't need to or don't know how to, you can either delete this fle or leave iit as is.
- app.yml: The settings and preferences of your App Engine service goes in here, check [Google's app.yml documentation](https://cloud.google.com/appengine/docs/standard/nodejs/config/appref) for full options.
- settings.json: This is your normal Meteor settings file, you will need to have the special key `meteor-google-cloud` for the deployment settings.
- Required keys:
- `project`: The project name of the project on Google Cloud to use.
- Other keys: You can add any option you would like here, and they will be passed to `gcloud deploy app` command, for the full list, check [Google's gcloud deploy documentation](https://cloud.google.com/sdk/gcloud/reference/app/deploy).
### 4. Deploy
```bash
meteor-google-cloud --settings deploy/settings.json --app deploy/app.yml --docker deploy/Dockerfile
```
P.S: It may take a few minutes to build your app, which may appear to be unresponsive, but it's not, just wait.
## CLI options
The Meteor Google Cloud CLI supports the following options:
```bash
-v, --version output the version number
-i, --init init necessary files on your repo
-b, --build-only build only, without deploying to gcp
-s, --settings path to settings file (settings.json)
-c, --app path to app.yaml config file
-d, --docker path to Dockerfile file
-p, --project path of the directory of your Meteor project
-o, --output-dir path of the output directory of build files
-v, --verbose enable verbose mode
-q, --quiet enable quite mode
-ci, --ci add --allow-superuser flag in meteor commands for running in CI
-h, --help output usage information
--node-version set custom node version
--npm-version set custom npm version
```
## FAQ
**1. Does App Engine supports websockets?**
Yes, announced in February 5, 2019, [more info](https://cloud.google.com/blog/products/application-development/introducing-websockets-support-for-app-engine-flexible-environment).
**2. Does App Engine supports session affinity?** Yes.
**3. Do I get auto scaling?** Yes.
**4. Do I get auto healing?** Yes.
**5. Can I add the environment variables to the `settings.json?`** Yes. Just create add a property `env_variables` to `meteor-google-cloud`. It will prefer those over the ones in your `app.yaml`.
## Support
We welcome any questions, contributions or bug reports in the GitHub [issue tracker](https://github.com/EducationLink/meteor-google-cloud/issues).
## Meteor Azure
This package was heavily inspired on `meteor-azure`, a deployment packge for Meteor applicatons on Microsoft Azure, [click here](https://github.com/fractal-code/meteor-azure) for more information.
## License
[MIT](https://github.com/EducationLink/meteor-google-cloud/blob/master/LICENSE)