App Engine Deploy
Environment and Deployment Manager for Google App Engine Applications., (*1)
Supports multiple modules and multiple deployment targets (i.e. deploy to multiple unique appid's)., (*2)
Working towards this: http://12factor.net/config, (*3)
Table of Contents
What is this? Is it different from appcfg.py?
This allows you to deploy the same code/application to multiple target environments (local, multiple different App Engine projects)., (*4)
Critically, it also allows you to manage environment variables distinctly for each deployment target., (*5)
This tool uses appcfg.py to actually push the deployments out, but it builds a dynamic command, overriding the target application id and environment variables at deploy time., (*6)
Example deploy.json file
Deployment targets and environments are configured in deploy.json, usually in your project root., (*7)
Here's a quick example where we have different database credentials for alpha and live environments., (*8)
{
"targets": {
"alpha": {
"app_id": "myapp-alpha",
"version": "alpha++",
"require_label": false,
"environment": {
"APP_DB_USER": "root",
"APP_DB_NAME": "DatabaseName",
"APP_DB_SOCKET": "/cloudsql/myapp:instance"
}
},
"live": {
"app_id": "myapp",
"version": "2",
"require_label": true,
"environment": {
"APP_DB_USER": "root",
"APP_DB_NAME": "LiveDatabaseName",
"APP_DB_SOCKET": "/cloudsql/myapp:instance"
}
}
}
}
Local development environment
You can configure the environment variables for your local development server in your yaml files like this:, (*9)
env_variables:
APP_DB_USER: root
APP_DB_NAME: localdb
Usage
Deployment targets configured in deploy.json are executed using the deploy command, which is made available the vendor/bin folder by Composer., (*10)
For example, from your project root:, (*11)
Deploy the examples module to the alpha target environment, (*12)
vendor/bin/deploy --run --module=examples --target=alpha
Create a template deploy.json file, (*13)
vendor/bin/deploy --init
Show the planned appcfg.py command for a deployment, but do not run it, (*14)
vendor/bin/deploy --test --module=default --target=live
List the configured deployment targets, (*15)
vendor/bin/deploy --verbose targets
Default Module
You can use either app or default to deploy the default App Engine module (which is configured in your app.yaml file)., (*16)
Targets
Each target is a different deployment, like "staging" and "production"., (*17)
They must be uniquely named., (*18)
Versions
If you suffix your version name with ++ then we will auto-increment the version on each deployment., (*19)
In the example above, the first deployment gets alpha1 and the second alpha2 and so on., (*20)
In order to do this, we have to be able to detect what versions are already running. So, if you delete all your versions, we will start at 1 again., (*21)
Labels
You can supply a version label like this:, (*22)
vendor/bin/deploy --run --module=examples --target=alpha --label=rel200
When the code is deployed, the label will be suffixed to the version number. So, for example if the version is "alpha3":, (*23)
alpha3-rel200, (*24)
If your configuration defines "require_label" as true, when you deploy to that target, you will be required to enter a
label. This is particularly useful for production environments, for managing feature releases, etc., (*25)
Important Labels must match the following regex: [a-zA-Z0-9_]+ (one or more alphanumerics or underscores), (*26)
Code Separation, Redirects
You can "redirect" from your deploy.json file to another, usually intended for situations where your environment configurations are stored in another version control repository., (*27)
So, this might be your deploy file from your application folder:, (*28)
{
"file":"../vendor/my-company/my-app-environment/deploy.json"
}
In your composer.json require section:, (*29)
{
"venditan/appengine-deploy": "1.1.*"
}
or with the command line, (*30)
composer require venditan/appengine-deploy:1.1.*
Wallogit.com
