@itentialopensource/push-bundles-to-gitlab-using-adapter v0.0.11-2021.2.1

Push Bundles to Gitlab using Adapter

Table of Contents

• Overview
• Installation Prerequisites
• Requirements
• Features
• How to Install
• How to Run

Overview

The Push Bundles to Gitlab pre-built takes an Admin Essentials installed artifact and creates a new project in GitLab using the up-to-date artifact bundle. If the project and branch already exists in the specified GitLab group, it will create a new branch and open a merge request (MR) in GitLab with any changes made in the lab environment.

Installation Prerequisites

Users must satisfy the following pre-requisites:

• Itential Automation Platform
  • ^2021.2
• App-Artifacts
  • 6.1.16-2021.1.2
• GitLab Adapter

Requirements

This artifact requires the following:

• Artifact installed in Admin Essentials
• GitLab environment URL to a specific group
• GitLab private access token
• Argo (Itential open source Docker Hub image) access via GitLab pipeline

Features

The main benefits and features of the artifact are outlined below.

• Supports internal Git repos with no internet access (Argo docker image can be digested offline).
• Automatically create repo and branch.
• Automatically create MR when repo and branch exist.
• Allows user to perform rediscovery of an installed artifact (where new components were added).
• Updates Admin Essentials with the latest list of components.
• Adds the current IAP user whoami username to the MR description for the MR reviewer.
• Checks-in all necessary files for CI/CD (including auto artifact.json generator script).
• Helps to handle "Artifact-As-Code" with version control, MR, and code-promotion procedures.

How to Install

To install this pre-built:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section.
• The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button.

How to Run

Use the following to run the artifact:

1. In Automation Catalog, find the Push Bundles to Gitlab entry.
2. Fill out the form with the appropriate values.
3. Continue with all manual tasks in the workflow.

Form Inputs (look for above screenshot for example inputs) 1. Adapter Name - Adapter name configured with user token 2. GitLab Project Name - Project name in GitLab to Update/Create 3. GitLab Group Path - Group path for GitLab subgroup 4. Re-discover - Perform re0discover 5. MR Type - Type of MR (patch/minor/major) 6. Commit Message - Commit message to add for commit tasks 7. Target Branch - Traget branch to set for MR