Cloud Services

Enterprise Marketplace

Onboarding by discovery
Published On Jun 14, 2024 - 9:03 AM

Onboarding by discovery

Describes how to onboard actions using the Discovery feature.
Actions Discovery allows you to import content and create your own actions from two sources and also Ansible Tower. Select this option to create actions from scratch for playbooks discovered in a Github or Ansible Tower account.
The main benefit of Actions Discovery is that it enables you to bring your personalized action content available in your sources, such as GitHub or Ansible Tower using the user interface (UI). This makes the discovery of action content automatically, and onboards the actions into the Kyndryl Modern Operations Applications very quickly.

Prerequisites

The following permissions are needed to be able to discover and onboard actions.
  • The
    Actions Registry Admin
     action role is the only role that includes all these permissions.
  • The
    Platform Administrator
     can create Custom Roles and assign them the permissions needed to discover and onboard actions.
Permission
Description
actions.action_types.crud
Allow to perform crud operation on action types
actions.action_onboarding.crud
Allow to perform crud operation on action onboarding
actions.action_definition.view
Allow to perform view operation on action definition
actions.action_definition.crud
Allow to perform crud operation on action definition
actions.action_policy.view
Allow to perform view operation on action policy
The onboarding process is divided into four steps:

Step 1: Select content sources

  1. From the
    Actions Admin
     page, click the
    onboard action +
     button.
  2. Select the following import option:
    Onboard by discovery
    .
  3. Click
    Ok
    .
  4. A new page is displayed. Select one of the following source types: 
    Github
     or
    Ansible Tower
    .
  5. Select the
    source account
      to discover your actions from the dropdown list.
  6. Add the
    content technology
     from the dropdown list.
  7. Different content sources are displayed based on the source account selected. To look for an specific content source, use the search bar.
    1. For Github: Check the box next to the content name. A maximum of five sources can be selected.
    2. For Ansible Tower: Select
      Workflow
       or
      Template
      .
  8. Click the
    Select and continue
     button.
The discovery process initiates. You can wait for the discovery to finish or select to go to the
Actions Admin
 page.
Each type of content source has associated content technologies, which refers to the type of files to be discovered.

Step 2: Discover and select actions

Once the discovery process is completed and successful, a tree structure opens.
  1. Select the action files that need to be onboarded.
  2. Click
    Save and Continue
    .

(Optional) Step 3: Bulk assign actions

  1. Select one or more actions to assign to a target provider. You can select multiple actions at once for a more expedited process. However, only one provider can be assigned to those actions.
  2. Click
    Bulk Assign
    , select the target provider to be assigned, and click
    Continue
    .

Step 4: Onboard actions

You are presented with a summary of the actions to be onboarded and the target provider for each of them. Click
Save and Continue
 to start the onboarding process.
Publishing onboarded actions.
To publish your recently discovered actions, follow these steps:
Edit the action definition
  1. Select the action that you want to onboard and click the
    overflow menu
    .
  2. Select
    Details
    . The Details page opens.
  3. Click
    Edit details
    .
  4. Make the necessary edits to the action's details, and
    Save
     the changes.
The details page shows the following fields for you to update, if needed:
  • Action Definition ID:
     ID used for linking actions files.
  • Action Definition Display Label:
     Label shown to the user on the application side.
  • Action Type:
     Select
    Config Change
     if you need the user to enter some data to execute the action. Otherwise, classify your action as State Change, Deprovision, or Provision New.
  • Description:
     A brief description of what this action is for.
  • Actions template:
     A template containing key information for the execution of the template. For example, the link between resource information and the playbook variables. For more information, click the
    Information
     icon.
  • Associated to resource family:
     Resource families where this action is shown.
  • Context:
     Scope for action execution.
  • Application:
     Application where the user can run this action from.
  • Content Provider:
     Usually the content source.
  • Target Provider:
     Cloud provider where the action is performed.
  • Fulfillment Provider:
     Tool provider in charge of execution.
Add an action configuration
  1. When
    Action Type
     has been set to
    Config Change
    , the actions requires some input from the user. To configure these inputs, click
    Manage Configuration
    .
    Remember to save any other changes made to the details page before going to the Manage Configuration page.
  2. Add the configuration name of your choice. You can add as many configurations as inputs are required from the user.
  3. Click
    View more
     in each of the configuration IDs added to make the required configuration updates.
    Config Id
     and
    Binding
     usually take the same value. This value is linked to the playbook through the Action Template.
    • For
      Input type:
      • Select
        Free Text
         to display an input box where the user can enter any text.
      • Select
        Single Select
         to display a dropdown menu where the user can select only one choice.
      • Select
        Multi Select
         to display a dropdown menu where the user can select more than one choice.
    • For
      Description:
       This is a help text displayed so the user knows important information about that input.
    • For
      Validation:
       This is a regex expression used to validate the user input. If validation fails, then whatever is in the
      Error Message
       text box is shown.
Validate action data
Once the configuration details are complete, click
Validate
 to check if the information provided is correct.
Publish action
To publish your action, from the
Actions Admin
 page, follow one of these three options:
  • Click the
    Overflow menu
     for the action you want to publish, and select
    Validate & Publish
    .
  • Select the checkbox for multiple actions that you want to publish, and click
    Validate & Publish
     on the top of the table.
  • Go to the
    Actions Details
     page for the action that you want to publish and click
    Publish
     at the bottom of that page.

Executing discovered actions

Your discovered actions must be visible for the respective resource families once they are published. In this way, you can execute that action as previously explained.

Troubleshooting

In case of error during the execution time, check the action definition and configuration for any mistakes. Editing published actions is not supported yet. If you are unable to fix any errors, start a new discovery process and fill all data from scratch.
Do you have two minutes for a quick survey?
Take Survey