1.8 Execution Inputs

1. Introduction
2. What is an Execution Input?
3. Input types
4. Calling the input in the action
5. Adding the new input

 

1. Introduction

In this article, you will know what execution inputs are, their usage, and how to add an execution input to a pipeline. 

You will get to know the types of execution inputs in Kaholo, how to create new Input Form and how to pass data to a pipeline using execution inputs.

To know more about using Execution Inputs with the Main Code Layer of a pipeline, visit Kaholo SDK Documentation.

2. What is an Execution Input?

Execution inputs provide a level of abstraction on top of the Kaholo pipeline allowing your users to execute a pipeline with a set of inputs that you define. These inputs are then linked to specific Action parameters in your pipeline using the Code option.

Inputs can be optional or required before a pipeline execution.

 

Pic.1 Main view of the Execution Inputs

 

2. Input types:

There is a few types of Kaholo Inputs that you may pass through the Execution Inputs Form.

  • Code  –  Allows to inject JavaScript code directly to the action
  • Multi-Line Text   –  String value
  • Number    – Integer or Float value
  • Options Dropdown – Predefined list of options that operator/user may choose
  • Single-Line Text  –  String value
  • True/False (Boolean) – Toggle switch indicating true or false
  • Vault Item – Allows to pass Kaholo Vaults (Secrets)

Pic. 2 Input Types

3. Calling an input in the action

To call input in the action, you should use syntax kaholo.execution.inputs.<field-ID> from the Kaholo SDK in the JS Code field

To call an input defined in the Execution Inputs section you need to know ID of the input that you defined. In our Example ID is “instanceType”

 

To call it inside the action, go to the Design tab, click on action where you wish to pass this value, next choose which parameter should be replaced and passed as an input. Toggle button to switch to the Javascript Code Layer and type: kaholo.execution.inputs.instanceType

Pic.3 Calling input in the action

 

4. Adding the new input

To add new execution input click on button “ADD INPUT” in the lower right corner. New form will pop up. Most of the fields to fill up are standard like ID (which is important when you want to call it later). You have also fields to fill title and description that will be displayed and visible for user/operator, that is going to execute a pipeline. In our Example we will fill all options to create working dropdown list to choose EC2 Instance type that is going to be provision by the pipeline.

Pic. 4 Form filled for dropdown list for the Execution Inputs

Ready form based on configuration above:

Pic.5 Ready form based on filled up parameters

 

Summary:

Execution Inputs are the great feature to use if you want to customize your pipeline before each run or you want to allow to execute this pipeline several operators/users. With good description of the Execution Inputs operators are able to use and configure pipeline without going in the details with the workflow, code and configurations that are behind it. Simple syntax kaholo.execution.inputs.<field-ID> from the Kaholo SDK in the JS Code field gives you possiblity to pass various values as well as use them as only one component of needed parameter