Working with Pipeline

The guide covers the important lifecycle operations for managing pipelines. Learn how to add ,edit or delete a pipeline.

The UI's Add Pipeline button allows pipeline addition. ADOC recommends adding the pipeline via SDK. This improves pipeline access and monitoring.

To add a pipeline perform the following action:

• Add a Pipeline via SDK or
• Add a Pipeline via UI

Actions after adding the pipeline:

• Edit a Pipeline
• Delete a Pipeline

Add a Pipeline via SDK

The ADOC UI monitors pipelines, whereas the Acceldata SDK registers new ones. Add your pipeline using these steps.

1. Environment Configuration: First prepare your development environment with the required components.

   1. Install the SDK: Install acceldata-sdk for Python or adoc-java-sdk for Java using pip.
   2. Generate API Keys: Your accessKey and secretKey can be generated from Admin > API Keys in the ADOC UI. These are needed for request authentication.
   3. Start the Client: Create an SDK client using your ADOC URL and API keys.

2. Define the Pipeline Object: Next, specify the pipeline object's core attributes.

   1. Instantiate Object: Create a Python CreatePipeline object or use CreatePipeline.builder() in Java.
   2. Required fields: Provide a pipeline uid and name.
   3. Optional fields: Use context to provide a description, owner information (meta), and other annotations.

3. Register the Pipeline: Send the object to the ADOC server : Call the create_pipeline()method on your initialized client, passing in the pipeline object. This action registers the new pipeline in ADOC.

4. Run Pipeline: Finally, run the pipeline to collect observability data.

Apply create_pipeline_run() to the previous response object.

This starts the first run instance, letting ADOC track executions, performance data, and alerts.

You can now view the created pipeline in the ADOC pipeline list.

Add a Pipeline via UI

To add pipeline via UI:

1. Click Add Pipeline to open a create form.

2. Fill the pipeline details:

   • Name - User-friendly and unique pipeline name.
   • UID - A permanent, unique pipeline ID. ID cannot be changed later.
   • Description - (Optional) A brief explanation of the pipeline's purpose.
   • Owner - (Optional) Name of pipeline owner or service account.
   • Team - (Optional) The name of the team that owns the pipeline.
   • Code location: (Optional) A pipeline source code repository or definition file URL.
   • Context: (Optional) A key-value field for custom metadata or annotations.
   • Pipeline tags: (Optional) Classify and filter pipelines with descriptive tags. Add tags by pressing Enter.

3. Click Save to create the pipeline.

Edit a Pipeline

To edit a pipeline:

1. For the selected pipeline, click the ellipsis icon ⋮ .
2. Select the pen icon 🖉.
3. Make the changes. Click Save.

Delete a Pipeline

To delete a pipeline:

1. For the selected pipeline, click the ellipsis icon ⋮.
2. Select the bin icon 🗑.
3. Click Confirm.