Settings and Locks

Store configuration parameters using the command line:

$ curl -X POST 'https://<my-workspace-name>.cloudomation.com/api/latest/setting' -d '{"name":"notification_emails","value":["toni@example.com","cory@example.com"]}' -H "Authorization: $TOKEN"

Read the configuration parameter in a flow:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    # we use the setting named "notification_emails" and access it's value
    emails = system.setting('notification_emails').get('value')
    this.connect(
        'my-smtp-server',
        name='send notification',
        from_='noreply@example.com',
        to=emails,
        subject='notification from Cloudomation',
        text='test email content',
    )
    return this.success('all done')

If you choose to change the emails which should receive notifications you only need to update it in one place: the setting value:

$ curl -X PATCH 'https://<my-workspace-name>.cloudomation.com/api/latest/setting/notification_emails?by=name' -d '{"value":["toni@example.com","cory@example.com","tracy@example.com"]}' -H "Authorization: $TOKEN"

and with the next execution your flow scripts will read and use the new value.

Storing the result of some processing in a setting:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    # do some processing
    result = 42
    # store the result
    system.setting('occurrences_found').save(value=result)
    return this.success('all done')

Other flow scripts can read the value and adapt their behaviour accordingly:

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    count = system.setting('occurrences_found').get('value')
    if count > 32:
        this.task(
            'SMTP',
            smtp_host='mail.example.com',
            from='no-reply@example.com',
            to='kevin@example.com',
            subject='counter alert',
            text=f'found {count} occurrences'
        )
    return this.success('all done')

The value can also be retrieved using the REST API:

$ curl 'https://<my-workspace-name>.cloudomation.com/api/latest/setting/occurrences_found?by=name' -H "Authorization: $TOKEN" | jq .

{
    "setting": {
        "name": "occurences_found",
        "value": 42,
        ...
    }
}

Make sure only one cloud-vm is provisioned at once.

import flow_api
def handler(system: flow_api.System, this: flow_api.Execution):
    # we try to acquire the lock
    system.setting('cloud-vm-lock').acquire()
    # start the flow which launches the cloud-vm
    this.flow('create-cloud-vm')
    # use the cloud-vm
    this.connect('cloud-vm', script='sleep 30')
    # delete the cloud-vm
    this.flow('remove-cloud-vm')
    # free the lock
    system.setting('cloud-vm-lock').release()
    return this.success('all done')