Skip to main content

SDK for interacting with Puppet Relay

Project description

This is the Python SDK for use with the internal Relay service APIs. The SDK requires Python 3.8.

It is intended for use by integration authors who are building containers to run inside the service. For running workflows and interacting with the user-facing service APIs, use the Relay CLI.

The API documentation is auto-generated from the source code. Here are some higher-level examples that show the main SDK classes that integration authors will interact with.

Installation

The SDK is available to install via pip:

pip install relay-sdk

If you use the relaysh/core:latest-python container image as your base image, it’ll be pre-installed.

Usage

The main purpose of the SDK is to provide helpers for interacting with Relay’s metadata service. Each container that runs in Relay has access to this service, which allows the container to read and write key-value data, emit events, and generate logs.

Accessing Data from the step spec

The Interface class is the primary way to interact with the service. Import it and instantiate an object, then call methods on that object to access metadata, which comes from the spec section of the step and global Connection information. The Dynamic class provides syntactic sugar for getting data like connection credentials, workflow-specific parameters, and secrets. It represents nested data structures as dot-separated method accessors.

from relay_sdk import Interface, Dynamic as D

relay = Interface()
azuresecret = relay.get(D.azure.connection.secret) # using Dynamic
azureclient = relay.get('azure["connection"]["clientID"]') # same as above
secret = relay.get(D.mysecret)
relay.outputs.set("outputkey","This will be the value of outputkey")

Running Workflows

The Workflow class offers the method run to run a workflow.

Use the following to run the workflow my_workflow with parameter param_name and value param_value:

from relay_sdk import Interface

relay = Interface()
relay.workflows.run('my_workflow', parameters={'param_name':'param_value'})

Webhook Triggers

The WebhookServer class provides a helper that sets up a webserver to handle incoming requests for Trigger actions.

This example, from the Docker Hub integration, makes use of the Interface class to access the events.emit method, which will cause the workflow associated with this trigger to be run with the inline mapping of workflow parameters to values extracted from the webhook payload.

The WebhookServer class can run any WSGI or ASGI application passed to it. The integrations the Relay team develops internally use the Quart web app framework.

from relay_sdk import Interface, WebhookServer
from quart import Quart, request, jsonify, make_response

relay = Interface()
app = Quart('image-pushed')

@app.route('/', methods=['POST'])
async def handler():
    event_payload = await request.get_json()

    if event_payload is None:
        return await make_response(jsonify(message='not a valid Docker Hub event'), 400)

    pd = event_payload['push_data']
    rd = event_payload['repository']

    relay.events.emit({
        'pushedAt': pd['pushed_at'],
        'pusher': pd['pusher'],
        'tag': pd['tag'],
        'name': rd['repo_name']
    })

    return await make_response(jsonify(message='success'), 200)


if __name__ == '__main__':
    WebhookServer(app).serve_forever()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

relay-sdk-0.3.1.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

relay_sdk-0.3.1-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file relay-sdk-0.3.1.tar.gz.

File metadata

  • Download URL: relay-sdk-0.3.1.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for relay-sdk-0.3.1.tar.gz
Algorithm Hash digest
SHA256 0cfd32ecd0904520fe58930098ffc4a256f9b268e22580a768d25f85e3218659
MD5 ff08e18dabe43969d8b598ed18e34d72
BLAKE2b-256 afdbb2344245b10d8b02dfd38fa391658fe744bd1edd45fead85fc6d28a11727

See more details on using hashes here.

File details

Details for the file relay_sdk-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: relay_sdk-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for relay_sdk-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 229d2459d7fca3b9a5a4ac1a445e27db7876431d31251547b7d98948024db021
MD5 163269b1a82a94a869261fcefb7cfb49
BLAKE2b-256 a996bcbe968fa45367b36436a257b808a8dbbfaffb7d0bbd6aece8c29b2f83cb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page