Scripting Post Sync

Impulse API Authentication

Before you can call many of the Impulse API endpoints, you will need to have a user. Once you have a user you can use basic auth to access the endpoints.

What if I want to perform scripted actions after content syncs?

Some repositories require an additional command from a CLI to update the system with the new content or content type. You can add these commands to run at the end of a sync, before the transaction is finished but after the content has been synced.

How to perform SSH commands at the end of a sync

At this time, we do not have this functionality available in our UI. Instead you will need to use the REST endpoints to perform ssh commands. However, we do plan on add this functionality to the UI. Stay tuned.

Create/Update Config API

To create the configuration, you will need to use the "Hooks-ssh" API. Using cURL, you can make a request like the following:

curl --location -g --request PUT '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/hooks-ssh/config/{{endpointId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url" : "192.168.68.120:22",
    "username" : "root",
    "privateKey" : "b3BlbnNzaC1rZXktdjEAAAAABG5vbm"
}'

Request Body

The request body with variables to send is as follows:

{
    "url" : "{{remote-url}",
    "username" : "{{ssh-user}}",
    "privateKey" : "{{private-key}}"
}

A quick description of each attribute follows:

• url: remote host ip, it has to include the port, for example: 192.168.68.120:22

• username: is the user that has privileges in the remote host.

• privateKey: has to be encoded base64, and can't contain new lines. One way to generate it is like this: base64 -w 0 private-key-motiv.pem > encoded-private-key-motiv.pem (pass the content of encoded-private-key-motiv.pem make sure you are not copying any end of lines)

SSH Command

The sshPostHook flag is a global flag that can be set on all endpoints.

If used, it will send a request to the Hooks SSH service after the sync-manager receives the topic for all content has been synced.

This flag takes a single command to be run on the remote server. These commands will be run at the home (~) of the user set in the hooks-ssh config. i.e. If you use the user "ubuntu", then all command will be run from /home/ubunutu

It is set as follows: "sshPostHook:<command>"

Examples: "sshPostHook:touch posthook.file" or "sshPostHook:echo \"post hook text\" >> posthook.file && cat posthook.file"

Add SSH Command

Now that the config is created, you will need to define the command as part of the job.

To do this, get the job object via API.

{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/job-depot/jobs/{{job-id}}

The job object will look something like this:

{
  "id": "dd7f9cb7-52d3-434c-934e-64537ba0e2d2",
  "name": "my-job",
  "type": "manual",
  "description": "A job for end transaction ssh commands.",
  "active": true,
  "endpoints": [
    {
      "endpoint": {
        "id": "2e458822-9ba0-11ea-bb37-0242ac130002"
      },
      "type": "source",
      "detail": "contenttype:demo"
    },
    {
      "endpoint": {
        "id": "9538b3c8-d7c8-4602-80a7-20bb00599508"
      },
      "type": "destination",
      "detail": "contenttype:demo"
    }
  ]
}

You will need to add a new job.endpoints.detail for the endpoint you created the config for.

The detail key to add is sshPostHook followed by the ssh commands you want to run. For example, to create a file and view it's contents you can add the following detail separated by a comma. Only a single sshPostHook flag should be used on each endpoint.

sshPostHook:echo \"post hook text\" >> posthook.file && cat posthook.file

Updating the job we send this request:

curl --location -g --request PUT '{{impulse-protocol}}://{{impulse-domain}}:{{impulse-port}}/private/job-depot/jobs/{{job-id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "my-job",
  "type": "manual",
  "description": "A job for end transaction ssh commands.",
  "active": true,
  "endpoints": [
    {
      "endpoint": {
        "id": "2e458822-9ba0-11ea-bb37-0242ac130002"
      },
      "type": "source",
      "detail": "contenttype:demo"
    },
    {
      "endpoint": {
        "id": "9538b3c8-d7c8-4602-80a7-20bb00599508"
      },
      "type": "destination",
      "detail": "contenttype:demo,sshPostHook:echo \"post hook text\" >> posthook.file && cat posthook.file"
    }
  ]
}'

Run a Sync

After the config exists for the endpoint and the job has been updated with the new details, you can run a sync. After the job has moved the content to the destination, the script you set in the job details will then run. After the script is finished, the transaction will be complete.