CLI Tools

Deployments

Command Line Utilities for Sermos Deployments

deploy.validate(**kwargs)

Validate a compiled Sermos yaml is ready for deployment.

Arguments:

sermos-yaml (optional): Path to find your `sermos.yaml`
    configuration file. Defaults to `sermos.yaml`

deploy.deploy(**kwargs)

Invoke a Sermos build for your application.

Parameters:

• deployment-id (optional) – UUID for Deployment. Find in your Sermos Cloud Console. Will look under SERMOS_DEPLOYMENT_ID in environment if not provided.

• access-key (optional) – Defaults to checking the environment for SERMOS_ACCESS_KEY. If not found, will exit.

• sermos-yaml (optional) – Path to find your sermos.yaml configuration file. Defaults to sermos.yaml

• base-url (optional) – Defaults to primary Sermos Cloud base URL. Only modify this if there is a specific, known reason to do so. Can also set through environment SERMOS_BASE_URL.

deploy.status(**kwargs)

Check on the status of a Sermos build.

Parameters:

• deployment-id (optional) – UUID for Deployment. Find in your Sermos Cloud Console. If not provided, looks in environment under SERMOS_DEPLOYMENT_ID

• access-key (optional) – Defaults to checking the environment for SERMOS_ACCESS_KEY. If not found, will exit.

• base-url (optional) – Defaults to primary Sermos Cloud base URL. Only modify this if there is a specific, known reason to do so. Can also set through environment SERMOS_BASE_URL.

Proxy

Command Line Utilities for proxying into Sermos Cloud Services

proxy.proxy(**kwargs)

Proxy a Sermos Cloud service and bind to local port.

Connect to a Sermos Cloud service (typically a database) that is deployed behind Sermos’ private network. This will allow for local development by proxying traffic to the cloud service and binding to a local port.

Arguments:

proxy-id: The proxy `nice id` for a service. This is found in
    your Sermos Cloud dashboard and is specific to each Deployment.

service-id: The `nice id` for a service. This is found in
    your Sermos Cloud dashboard and is specific to each Deployment.

deployment-id (optional): UUID for Deployment. Find in your Sermos
    Cloud Console. If not provided, looks in environment under
    `SERMOS_DEPLOYMENT_ID`

local_port: Local port on which to bind.

local_host: Local host ip on which to bind.

manual_select: Manually choose the service/port selection from upstream
    service. Default behavior will use the standard DNS record and
    service port (recommended).

access-key (optional): Defaults to checking the environment for
    `SERMOS_ACCESS_KEY`. If not found, will exit.

base-url (optional): Defaults to primary Sermos Cloud base URL.
    Only modify this if there is a specific, known reason to do so.

debug (optional): Rarely used. Local devleopment purposes only with
    variable/non-guaranteed behavior.