The deployment configuration file
All deployment configuration of an app is defined with
skygear.yaml. Configurations can be divided into two types, microservice and web hooks respectively.
A sample deployment configuration file looks like this:
- name: backend
- name: SERVER_PORT
- secret: DATABASE_URL
- name: frontend
- path: /api/after_user_create
Configurations of the microservices are declared under the key
deployments, while those of hooks are under the key
The top-level key
api_versiondeclares the API version. Use the value
The top-level key
deploymentscontains a list of deployment items. In the above sample, there are two micro-service deployment items, named
The name of a deployment item, must be unique in this list (i.e. under the key
Indicates the path which the deployment item would be mounted and be available at. For details, refer to Routing documentation.
portkey specifies the TCP port the micro-service is listening for. Required.
commandkey specifies the command of a microservice. It will be translated to the
argskey of Kubernetes deployment.
imagekeys specify a microservice item's Docker image source. For details, refer to Deployment Image documentation.
environmentkey specifies the environment variables of a microservice item.
- For environment variables, it can be configured with a literal pair of
- For environment variables using a Kubernetes Secret as the source, use the
nameis optional, with use the Secret's name when not given.
The relative path to static assets.
The file to serve when the path cannot be found. The HTTP status code of response is 200.
The file to serve when the path cannot be found. The HTTP status code of response is 404.
The name of index file. Default to
The cache expiry time in seconds. Valid value ranged from 0 to 604800 (7 days).
Web-hook configurations are put under the
hookskey. Each entry represents a web-hook handler.
eventkey reflects the event name that the web-hook handler would handle. The same event name can appears multiple times in the list. For list of event names, refer to Web-hooks documentation.
pathkey specifies the location of web-hook handler. It can be an absolute URL (e.g.
https://example.com), or path (which would be resolved to absolute URL based on the app endpoint).