skygear.yaml

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:
1
app: my-app
2
​
3
api_version: v2.1
4
​
5
deployments:
6
  - name: backend
7
    type: http-service
8
    path: /api
9
    port: 8080
10
    context: backend
11
    template: nodejs:12
12
    environment:
13
      - name: SERVER_PORT
14
        value: "8080"
15
      - secret: DATABASE_URL
16
  - name: frontend
17
    type: http-service
18
    path: /
19
    port: 8080
20
    context: frontend
21
    template: nodejs:12
22
​
23
hooks:
24
  - path: /api/after_user_create
25
    event: after_user_create
Copied!
Configurations of the microservices are declared under the key deployments, while those of hooks are under the key hooks.
api_version
The top-level key api_version declares the API version. Use the value v2.1 for now.
deployments
The top-level key deployments contains a list of deployment items. In the above sample, there are two micro-service deployment items, named backend and frontend.
name
The name of a deployment item, must be unique in this list (i.e. under the key deployments).
type
Defines the type of a deployment item, where http-service and static is supported.
path
Indicates the path which the deployment item would be mounted and be available at. For details, refer to Routing documentation.
http-service
port
The port key specifies the TCP port the micro-service is listening for. Required.
command
The command key specifies the command of a microservice. It will be translated to the args key of Kubernetes deployment.
template, context and image
The template, context, and image keys specify a microservice item's Docker image source. For details, refer to Deployment Image documentation.
environment
The environment key specifies the environment variables of a microservice item.
For environment variables, it can be configured with a literal pair of name and value.
For environment variables using a Kubernetes Secret as the source, use the secret key. name is optional, with use the Secret's name when not given.
static
context
The relative path to static assets.
fallback_page
The file to serve when the path cannot be found. The HTTP status code of response is 200.
error_page
The file to serve when the path cannot be found. The HTTP status code of response is 404.
index_file
The name of index file. Default to index.html
expires
The cache expiry time in seconds. Valid value ranged from 0 to 604800 (7 days).
hooks
Web-hook configurations are put under the hooks key. Each entry represents a web-hook handler.
event
The event key 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.
path
The path key 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).
​