How to set up a staging environment on Google App Engine
Question:
Having properly configured a Development server and a Production server, I would like to set up a Staging environment on Google App Engine useful to test new developed versions live before deploying them to production.
I know two different approaches:
A. The first option is by modifying the app.yaml version parameter.
version: app-staging
What I don’t like of this approach is that Production data is polluted with my staging tests because (correct me if I’m wrong):
- Staging version and Production version share the same Datastore
Staging version and Production version share the same logs
Regarding the first point, I don’t know if it could be “fixed” using the new namespaces python API.
B. The second option is by modifying the app.yaml application parameter
application: foonamestaging
with this approach, I would create a second application totally independent from the Production version.
The only drawback I see is that I’m forced to configure a second application (administrators set up).
With a backuprestore tool like Gaebar this solution works well too.
What kind of approach are you using to set up a staging environment for your web application?
Also, do you have any automated script to change the yaml before deploying?
Answers:
I chose the second option in my set-up, because it was the quickest solution, and I didn’t make any script to change the application-parameter on deployment yet.
But the way I see it now, option A is a cleaner solution. You can with a couple of code lines switch the datastore namespace based on the version, which you can get dynamically from the environmental variable CURRENT_VERSION_ID as documented here: http://code.google.com/appengine/docs/python/runtime.html#The_Environment
If separate datastore is required, option B looks cleaner solution for me because:
- You can keep versions feature for real versioning of production applications.
- You can keep versions feature for traffic splitting.
- You can keep namespaces feature for multi-tenancy.
- You can easily copy entities from one app to another. It’s not so easy between namespaces.
- Few APIs still don’t support namespaces.
- For teams with multiple developers, you can grant upload to production permission for a single person.
We use option B.
In addition to Zygmantas suggestions about the benefits of separating dev from prod at application level, we also use our dev application to test performance.
Normally the dev instance runs without much available in the way of resources, this helps to see where the application “feels” slow. We can then also independently tweak the performance settings to see what makes a difference (e.g. front-end instance class).
Of course sometimes we need to bite the bullet and tweak & watch on live. But it’s nice to have the other application to play with.
Still use namespaces and versions, just dev is dirty and experimental.
We went with the option B. And I think it is better in general as it isolates the projects completely. So for example playing around with some of the configurations on the staging server will not affect and wont compromise security or cause any other butterfly effect in your production environment.
As for the deployment script, you can have any application name you want in your app.yaml. Some dummy/dev name and when you deploy, just use an -A parameter:
appcfg.py -A your-app-name update .
That will simplify your deploy script quite much, no need to string replace or anything similar in your app.yaml
No need to create a separate project. You can use dispatch.yaml to route your staging URL to another service (staging) in the same project.
- Create a custom domain staging.yourdomain.com
-
Create a separate app-staging.yaml, that specifies staging service.
…
service: staging
…
-
Create distpatch.yaml that contains something like
…
-
url: “*staging.mydomain.com/”
service: staging
-
url: “*mydomain.com/”
service: default
…
- gloud app deploy app-staging.yaml dispatch.yaml
Here is what the Google documentation says :
A general recommendation is to have one project per application per
environment. For example, if you have two applications, "app1" and
"app2", each with a development and production environment, you would
have four projects: app1-dev, app1-prod, app2-dev, app2-prod. This
isolates the environments from each other, so changes to the
development project do not accidentally impact production, and gives
you better access control, since you can (for example) grant all
developers access to development projects but restrict production
access to your CI/CD pipeline
With this in mind, add a dispatch.yaml file at the root directory, and in each directory or repository that represents a single service and contain that service, add a app.yaml file along with the associated source code, as explained here : Structuring web services in App Engine
Edit, check out the equivalent link in the python section if you’re using python.
use of application in app.yaml has been shut down.
Instead Google recommends
gcloud app deploy --project [YOUR_PROJECT_ID]
Please see https://cloud.google.com/appengine/docs/standard/python/config/appref
Having properly configured a Development server and a Production server, I would like to set up a Staging environment on Google App Engine useful to test new developed versions live before deploying them to production.
I know two different approaches:
A. The first option is by modifying the app.yaml version parameter.
version: app-staging
What I don’t like of this approach is that Production data is polluted with my staging tests because (correct me if I’m wrong):
- Staging version and Production version share the same Datastore
Staging version and Production version share the same logs
Regarding the first point, I don’t know if it could be “fixed” using the new namespaces python API.
B. The second option is by modifying the app.yaml application parameter
application: foonamestaging
with this approach, I would create a second application totally independent from the Production version.
The only drawback I see is that I’m forced to configure a second application (administrators set up).
With a backuprestore tool like Gaebar this solution works well too.
What kind of approach are you using to set up a staging environment for your web application?
Also, do you have any automated script to change the yaml before deploying?
I chose the second option in my set-up, because it was the quickest solution, and I didn’t make any script to change the application-parameter on deployment yet.
But the way I see it now, option A is a cleaner solution. You can with a couple of code lines switch the datastore namespace based on the version, which you can get dynamically from the environmental variable CURRENT_VERSION_ID as documented here: http://code.google.com/appengine/docs/python/runtime.html#The_Environment
If separate datastore is required, option B looks cleaner solution for me because:
- You can keep versions feature for real versioning of production applications.
- You can keep versions feature for traffic splitting.
- You can keep namespaces feature for multi-tenancy.
- You can easily copy entities from one app to another. It’s not so easy between namespaces.
- Few APIs still don’t support namespaces.
- For teams with multiple developers, you can grant upload to production permission for a single person.
We use option B.
In addition to Zygmantas suggestions about the benefits of separating dev from prod at application level, we also use our dev application to test performance.
Normally the dev instance runs without much available in the way of resources, this helps to see where the application “feels” slow. We can then also independently tweak the performance settings to see what makes a difference (e.g. front-end instance class).
Of course sometimes we need to bite the bullet and tweak & watch on live. But it’s nice to have the other application to play with.
Still use namespaces and versions, just dev is dirty and experimental.
We went with the option B. And I think it is better in general as it isolates the projects completely. So for example playing around with some of the configurations on the staging server will not affect and wont compromise security or cause any other butterfly effect in your production environment.
As for the deployment script, you can have any application name you want in your app.yaml. Some dummy/dev name and when you deploy, just use an -A parameter:
appcfg.py -A your-app-name update .
That will simplify your deploy script quite much, no need to string replace or anything similar in your app.yaml
No need to create a separate project. You can use dispatch.yaml to route your staging URL to another service (staging) in the same project.
- Create a custom domain staging.yourdomain.com
-
Create a separate app-staging.yaml, that specifies staging service.
…
service: staging
… -
Create distpatch.yaml that contains something like
…
-
url: “*staging.mydomain.com/”
service: staging -
url: “*mydomain.com/”
service: default
…
-
- gloud app deploy app-staging.yaml dispatch.yaml
Here is what the Google documentation says :
A general recommendation is to have one project per application per
environment. For example, if you have two applications, "app1" and
"app2", each with a development and production environment, you would
have four projects: app1-dev, app1-prod, app2-dev, app2-prod. This
isolates the environments from each other, so changes to the
development project do not accidentally impact production, and gives
you better access control, since you can (for example) grant all
developers access to development projects but restrict production
access to your CI/CD pipeline
With this in mind, add a dispatch.yaml file at the root directory, and in each directory or repository that represents a single service and contain that service, add a app.yaml file along with the associated source code, as explained here : Structuring web services in App Engine
Edit, check out the equivalent link in the python section if you’re using python.
use of application in app.yaml has been shut down.
Instead Google recommends
gcloud app deploy --project [YOUR_PROJECT_ID]
Please see https://cloud.google.com/appengine/docs/standard/python/config/appref