Onboard a new tool using DevOps generic playbook

  • Release version: Washingtondc
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Onboard a new tool using DevOps generic playbook

    The DevOps Change establishes a pre-built playbook to assist users in onboarding new tools. This guided experience in the DevOps Change Workspace ensures a consistent and efficient process for integrating custom tools, focusing on visual and task-oriented guidance for end users.

    Show full answer Show less

    Key Features

    • Tool Capability Identification: Determine the capabilities supported by the tool, which can include code, plan, and orchestration.
    • Activity Definitions: Activities within the playbook are linked to specific definitions, allowing for customization based on the tool's capabilities.
    • Dynamic UI Configuration: Configure Activity UIs to define the user experience, allowing for different UIs to be rendered based on specific conditions.

    Key Outcomes

    Upon completing the onboarding steps, your custom tool will be effectively integrated into the DevOps framework, enabling streamlined operations and improved consistency in tool management. This process allows for tailored configurations based on specific tool capabilities and requirements, enhancing overall efficiency in DevOps practices.

    DevOps Change has a pre-build playbook setup for users to configure a new tool. Custom tool integrations can be created using the guided playbook experience in the DevOps Change Workspace.

    Playbooks provide end users with a visual, task-oriented guide with the steps to complete a process, ensuring a consistent experience for tool onboarding. For detailed information about playbooks, see About Playbook Experience.

    Perform the following steps to onboard your custom tool using the DevOps generic playbook.

    1. Identify tool capabilities

    To configure a tool using the generic playbook, first you must identify the capabilities supported by the tool. A tool can have one or more capabilities like code, plan, and orchestration.

    The Generic playbook consists of the following stages and each stage has its related activities:
    1. Connect to a tool
      1. Connect to a tool
      2. Specify tool access
      3. Configure the tool
    2. Capability

      Capability can be of type plan, code, or orchestrate. If the tool has multiple capabilities, multiple stages exist with the capability name.

      1. Select to track
      2. Import data
      3. Associate (This activity is for the Orchestration tools to associate pipeline steps)
    3. Summary

    This is how a playbook with multiple capabilities looks like:Playbook with multiple capabilities.

    2. Configure Activity Definitions

    Each Activity in a playbook is associated to an activity definition. DevOps has the following activity definitions:
    • DevOps CreateTool AD
    • DevOps Configure & Test AD
    • DevOps Select Associated Objects AD
    • DevOps Import Data AD
    • DevOps Associate Services AD
    • DevOps Summary AD
    For more information, see Exploring Playbooks and About Playbook Experience.

    The DevOps table sn_devops_capability_activity_mapping has been created to maintain associations between Activity definitions and capabilities. This table configuration is used to dynamically render the stages and activities for a tool. You can update the conditions as needed to either enable or disable a particular activity for a tool.

    The Tool Capability Activity Mappings table.

    For example, tools like GitLab and JFrog don’t support data import. So you don't require the Data Import activity for such tools. In that case, you must add the logic in the condition column to return false for these types of tools. See the following image as a reference:Example where data import logic is false.

    3. Configure Activity UI for the Activity Definition

    Playbook Activity UIs define the experience type and UI template rendered to users while managing Playbooks. You can configure multiple Activity UIs for an Activity Definition and render any one dynamically based on the condition evaluation.

    DevOps has the following AUIs for Create Tool activity. Except this, all other activity definitions have only one Activity UI.

    DevOps AUIs.

    You can configure any one the Activity UI based on the requirement. Refer to to navigate the Playbook Activity UI.

    Identify the required activity UI and add your tool in the condition builder so that the UI gets effected in the playbook for the tool.Override playbook activity.

    Result

    After completing these steps, your tool can be onboarded using the DevOps generic playbook.