Quick Start Guide

This section details the entire process of utilizing the Catalyst Pipelines service, from creating the pipeline and configuring it by defining the necessary components in a YAML file, to executing the pipeline.

Let us have a look at the steps in detail:

1. Create a Catalyst project:

Access the Catalyst console to create a new project. After the project creation is done, you will be able to access the Catalyst Pipelines service in the console. You can also explore other Catalyst services from the console.

2. Create a pipeline:

In the Catalyst Pipelines service, you can create a pipeline directly from the console. Refer to his help page to know the detailed steps to create a pipeline.

• Connect an Integration Source - When creating a pipeline, you can choose to integrate it with any Git provider, such as GitHub, GitLab, or Bitbucket. To enable this, you need to configure the pipeline execution flow in the catalyst-pipelines.yaml file and commit this file to the integrated Git provider repository. This setup will automatically trigger the pipeline whenever changes are pushed to the linked repository. When the pipeline is triggered, the complete source code from the integrated Git repository, along with the YAML file, will be automatically fetched and downloaded as a ZIP file to Catalyst. Note that this integration is optional.

3. Configure the pipeline:

You can configure the pipeline execution flow by defining necessary components like stages, jobs, runners, images, conditions and variables based on your requirements in the catalyst-pipelines.yaml. You can use our built-in YAML code editor or visual builder for this purpose. Refer to this page for more details on configuring the pipeline.

4. Commit the catalyst-pipelines.yaml file:

This step applies only if you have linked an integration source with the pipeline during its creation. Once you have finished configuring the pipeline, you need to commit the catalyst-pipelines.yaml file to any preferred branch in your source repository. The YAML file will be committed to the branch in the selected integration source from Step 2. It is mandatory to commit the YAML file each time any changes are made to the pipeline flow.

Note: If you have not connected the pipeline with an integration source, you can skip this step and proceed to execute the pipeline.

5. Execute the pipeline:

After configuring the pipeline, you can initiate its execution directly from the Catalyst console. If the pipeline is linked to an integration source, it will automatically execute whenever any changes are pushed to the linked repository.

Additionally, you can monitor the execution status and access detailed logs of the pipeline execution using the Basic and Advanced tabs within the Execution History section of the console. We will discuss this in detail in this help page.