Difference between revisions of "Rundeck"

From Hornbill
Jump to navigation Jump to search
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
+
This document can now be found at its new location in the [https://docs.hornbill.com/ibridge-packages/welcome Hornbill Document Library].
__NOTOC__[[Main Page|Home]] > [[Integration]] > [[Business Process Automation & Orchestration]] > [[Hornbill iBridge]] > Rundeck
 
</div>
 
{|style="width: 100%"
 
|- valign="top"
 
|style="width:73%"|
 
[[File:Rundeck-logotype-512.png|150px]]
 
<br>
 
==Introduction==
 
Rundeck is an IT process automation platform.
 
  
Execute jobs on your Rundeck instance, and read back execution details to monitor the status of those jobs.
+
    [[file:hornbill-document-library.png|iBridge Package Reference|link=https://docs.hornbill.com/ibridge-packages/welcome]]
 
 
As Rundeck is an on-premise platform, your Rundeck instance will need to be accessible outside of your network for the Hornbill integrations to function.
 
|style="width:5%"|
 
|
 
|style="width:22%; border-style: solid; border-width: 1px; border-color:#e6e6e6; background-color:#f2f2f2;"|
 
 
 
== Related Articles ==
 
:* [[Hornbill iBridge]]
 
:* [[Hornbill_KeySafe|KeySafe]]
 
:* [[Integration Call]]
 
:* [[Business_Process_Designer|Business Process Designer]]
 
|}
 
==KeySafe Configuration==
 
[[File:Rundeck_api_key.png|400px|right]]
 
In order to integrate with Rundeck, you will first need to configure, and securely store the authentication credentials for the Rundeck Account/s you want to use with the Hornbill App.
 
 
 
Configure your '''Rundeck''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''' in order to use the Rundeck options.  
 
 
 
In the admin console > System > Security > KeySafe
 
 
 
* Select on '''+''' and select '''API Key'''
 
* Give the API Key a title (this is the name / identifier for the Rundeck account as you will see it when using the Integration Call node in your business process)
 
* Optionally add a description
 
* API Key. This is an API Token, generated against a user profile on your Rundeck instance
 
* Add the API Endpoint. This is the internet-accessible API Endpoint URL of your Rundeck instance, including the port number (default of 4440)
 
* Select '''Create Key''' to save
 
 
 
'''Managing Rundeck Configurations'''
 
 
 
* Use KeySafe to create, store and enable integrations with multiple Rundeck accounts for use in your business processes
 
 
 
==Business Process==
 
 
 
===Options (Methods)===
 
Once you have your Rundeck account authorised, you're all set to use it with the '''[[Integration Call]]''' in your business processes. The following options are now available for you to use with Rundeck:
 
 
 
* '''Run Job''': This integration type takes a Job ID (mandatory) and an array of options (optional) as its inputs, and executes the job on your Rundeck instance, before returning:
 
** The execution ID
 
** The execution status
 
** The URL of the execution record in your Rundeck instance
 
* '''Get Job Execution Details''': This in integration type takes an Execution ID (mandatory) as its input parameter, and returns various data about the execution, including its status and start & end date/times.
 
 
 
Read more about using the '''[[Integration Call]]''' from the Related Articles section, and learn how to work with input and output parameters for each of the Rundeck options.
 
 
 
[[Category:Integration]]
 

Revision as of 18:38, 18 January 2024

This document can now be found at its new location in the Hornbill Document Library.

   iBridge Package Reference