☰
Conductor Documentation

REST Plugin

Description

The purpose of this plugin is to provide a generic type in a blueprint in order to integrate with REST based systems. The plugin is suitable for REST API’s which expose a relatively high level of abstraction. The general concept is to use JINJA templates that will be evaluated as the content of several independent REST calls. Very often it happens that certain intent requires several REST calls - therefore we can put them in a single template to make blueprint much cleaner to read.

Features:

Blueprint

Example Node Templates:

  user:
    type: cloudify.rest.Requests
    properties:
      hosts:
      - { get_input: rest_endpoint }
      port: 443
      ssl: true
      verify: false
    interfaces:
      cloudify.interfaces.lifecycle:
        start:
          inputs:
            template_file: templates/get-user-all-properties-template.yaml

An example of cloudify.rest.BunchRequests provided here.

Action inputs in cloudify.rest.Requests:

Action inputs in cloudify.rest.BunchRequests is list of inputs from cloudify.rest.Requests.

Node properties for cloudify.rest.Requests and cloudify.rest.BunchRequests:

Use rest calls actionable events

Add such event handler to /opt/mgmtworker/config/hooks.conf. See the actionable events documentation for more information.

hooks:
- event_type: workflow_succeeded
  implementation: cloudify-utilities-plugin.cloudify_rest.tasks.execute_as_workflow
  inputs:
    logger_file: /tmp/hooks_log.log
    properties:
      hosts: ["jsonplaceholder.typicode.com"]
      port: 443
      ssl: true
      verify: false
    template_file: /opt/manager/resources/blueprints/default_tenant/examples/templates/get-user-all-properties-template.yaml
  description: A hook for workflow_succeeded

Supported parameters:

Templates

Templates are a place where we can place multiple REST template calls.

Template parameters:

Example content of REST template:

rest_calls:
   - path: /users/10
    method: GET
    headers:
      Content-type: application/json
    payload:
    response_format: json
    recoverable_codes: [400]
    response_translation: [user]
    response_expectation:
        - ['id', '10']

  - path: /posts/{{POST_ID}}
    method: PUT
    headers:
      Content-type: application/json
    payload:
      title: '{{ USERNAME }}'
      body: '{{ WEBSITE }}'
      userId: '{{ USER_ID }}'
    response_format: json
    recoverable_codes: [400]
    response_expectation:
      - ['id', '{{POST_ID}}']

Example

blueprint: example-1-blueprint.yaml

The example is a REST API from test website: https://jsonplaceholder.typicode.com/.

The purpose of blueprint is to demonstrate how response_translation work.

For example, suppose that you were to use a simple GET call, such as:

GET https://jsonplaceholder.typicode.com/users/10**

This returns the following JSON:

{
    "id": 10,
    "name": "Clementina DuBuque",
    "username": "Moriah.Stanton",
    "email": "Rey.Padberg@karina.biz",
    "address": {
        "street": "Kattie Turnpike",
        "suite": "Suite 198",
        "city": "Lebsackbury",
        "zipcode": "31428-2261",
        "geo": {
            "lat": "-38.2386",
            "lng": "57.2232"
        }
    },
    "phone": "024-648-3804",
    "website": "ambrose.net",
    "company": {
        "name": "Hoeger LLC",
        "catchPhrase": "Centralized empowering task-force",
        "bs": "target end-to-end models"
    }
}

In the blueprint there are two nodes:

Example 2

blueprint: example-2-blueprint.yaml

Same as above we’re using test REST API but this time we’ll demonstrate how we can combine multiple REST calls in a single template. Overall idea is that we’ll first query REST API to provide user details and later on we’ll use this details in order to create user post with POST method.

Example 3

blueprint: example-3-blueprint.yaml

Real life example how F5 BigIP can be provisioned with REST API.

Example 4

blueprint: example-5-blueprint.yaml

Example for get users list, create new user based on first result and than remove new created user. use cloudify.rest.BunchRequests with params_attributes.

For more examples, see rest examples.