Skip to content

Commit 2a8a386

Browse files
committed
Update automation pipeline docs with new changes.
1 parent e61e2b2 commit 2a8a386

File tree

5 files changed

+74
-957
lines changed

5 files changed

+74
-957
lines changed

en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
When configuring a pipeline, you can use built-in pipeline templates provided by Choreo. These templates include pre-defined functionality that can simplify and accelerate pipeline creation.
22

3-
[Choreo’s pipeline specification](./specification.md) supports referencing these templates using the following syntax:
3+
[Choreo’s pipeline specification](https://github.com/wso2/choreo-pipeline-specification/tree/main/docs/specification) supports referencing these templates using the following syntax:
44

5-
```
5+
```yaml
66
steps:
7-
- name: Build
7+
- name: <step name>
88
template: choreo/<template name>
99
```
1010
1111
## Available Built-in Templates
1212
1313
!!! info "Note"
14-
The list of built-in templates is continuously growing.
14+
The list of built-in templates is continuously growing. Check [complete list of Choreo built-in templates](https://github.com/wso2/choreo-pipeline-specification/blob/main/docs/specification/built-in-templates.md)
1515
1616
??? "choreo/buildpack-build@v1"
1717
Builds applications using supported buildpacks within Choreo. This is used by Choreo’s default build pipeline.
@@ -42,3 +42,41 @@ steps:
4242
4343
??? "choreo/prism-build@v1"
4444
Builds Prism projects.
45+
46+
## Publish to Choreo Marketplace
47+
48+
At the end of all the resource provisioning steps in the automation pipeline, to publish metadata and credentials of provisioned resources to the Choreo marketplace, use inbuilt pipeline template `choreo/marketplace-publish@v1`. This template accepts an input argument called `resource` which needs to have a specific structure. Following is an example used to publish details of a provisioned MSSQL database.
49+
50+
{% raw %}
51+
```yaml
52+
steps:
53+
- name: publish-marketplace
54+
template: choreo/marketplace-publish@v1
55+
arguments:
56+
parameters:
57+
- name: resource
58+
yamlObject:
59+
name: "mssql-db-$ENVIRONMENT"
60+
version: 1.0.0
61+
category: Database
62+
description: MSSQL Database
63+
tags:
64+
- dev
65+
properties:
66+
databaseName: "{{steps.run-terraform.outputs.parameters.sql_database_name}}"
67+
sqlServerFQDN: "{{steps.run-terraform.outputs.parameters.sql_server_fqdn}}"
68+
connectionCredentials:
69+
- environments:
70+
- Development
71+
parameters:
72+
- key: ConnectionString
73+
value: "{{steps.run-terraform.outputs.parameters.connection_string}}"
74+
isSecret: false
75+
- key: DBUsername
76+
value: "{{steps.run-terraform.outputs.parameters.db_user_username}}"
77+
isSecret: true
78+
- key: DBUserPassword
79+
value: "{{steps.run-terraform.outputs.parameters.db_user_password}}"
80+
isSecret: true
81+
```
82+
{% endraw %}
Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# What are Automation Pipelines
22

33
!!! info "Note"
4-
Automation pipeline capabilities are only available in paid plans for private data plane organizations.
4+
Automation pipeline capabilities are only available for private data plane organizations.
55

6-
Choreo provides the capability to define and run any automated workflow within your IDP infrastructure. You can write your automation pipeline using the [Choreo pipeline syntax](./specification.md) which is a simplified version of [Argo workflows syntax](https://argoproj.github.io/workflows/) syntax.
7-
8-
There are a few variations of automation pipelines - CI pipelines, CD pipelines and Infrastructure provisioning pipelines depending on what you are automating.
6+
Choreo provides the capability to define and run any automated workflow with multiple steps within your IDP infrastructure. You can write your automation pipeline using the [Choreo pipeline syntax](https://github.com/wso2/choreo-pipeline-specification/tree/main/docs/specification) which is a simplified version of [Argo workflows syntax](https://argoproj.github.io/workflows/) syntax.

en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
Choreo allows to define automation pipelines at organization level. Follow these steps to create an automation pipeline.
44

55
1. Sign in to the [Choreo Console](https://console.choreo.dev/).
6-
2. In the left navigation menu, click **DevOps** and then click **Automation Pipelines**.
7-
3. Click **+ Create**.
8-
4. You can define an inline yaml or import from GitHub
6+
2. Open **Platform Operations** perspective.
7+
3. In the left navigation menu, click **DevOps** and then click **Automation Pipelines**.
8+
4. Click **+ Create**.
9+
5. You can define an inline yaml or import from GitHub
910

10-
## Define pipeline within Choreo
11+
## Define Pipeline within Choreo
1112

1213
This option is useful when you are testing a pipeline or if you like to let Choreo to keep your pipeline definitions.
1314

@@ -18,12 +19,12 @@ This option is useful when you are testing a pipeline or if you like to let Chor
1819

1920
This pipeline definition is managed within Choreo. You can update it after defining as well.
2021

21-
## Import pipeline from Git
22+
## Import Pipeline from Git
2223

23-
If your organization manages pipelines in Git, you can authorize and let Choreo to refer it. It could be a monolithic repository having multiple pipelines.
24+
If your organization manages pipelines in Git (GitHub, Bitbucket or GitLab), you can authorize and let Choreo to refer it. It could be a monolithic repository having multiple pipelines.
2425

2526
1. Under `Import Pipeline from Git` Click on the Git provider to authorize, and proceed with steps to grant access.
26-
2. You can select **Repository**, **Branch** and Specific **Pipeline Yaml** File within and directory in the repository.
27+
2. You can select **Repository**, **Branch** and Specific **Pipeline Yaml** file within a directory in the repository.
2728
3. Provide a name by which you can identify the pipeline.
2829
4. Optionally provide a description
2930
5. Click **Create**
@@ -33,7 +34,7 @@ Created pipelines will be listed in a tabular view.
3334

3435
# Edit Automation Pipelines
3536

36-
Editing is only possible for pipelines defined within Choreo. Click **Edit Pipeline YAML** and in the right side panel that opens up you can edit the pipeline definition. You can view the pipeline definition in full screen view as well by maximizing the panel.
37+
Editing is only possible for pipelines defined within Choreo. Click **Edit Pipeline YAML** and in the right side panel that opens up you can edit the pipeline definition. You can view the pipeline definition in full-screen view as well by maximizing the panel.
3738

3839
!!! info "Note"
3940
Once a pipeline is edited, you cannot roll back to a previous version.
@@ -44,4 +45,3 @@ To update the pipeline, modify it in Git and trigger a new run.
4445
# Delete Automation Pipelines
4546

4647
In the pipeline listing, under the **Actions** column, click the **Delete** icon. A confirmation pop-up will appear. Upon confirmation, the pipeline and all its associated runs will be permanently removed from Choreo.
47-

en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ After a pipeline is defined, you can execute it. The pipeline may need some inpu
22

33
# Add Pipeline Variables and Secrets
44

5-
The pipelines are defined at the organization level. Thus the variables defined for them are injected at the same level. Learn more on how to define a input variable in your pipeline at [Variables and Secrets - Choreo Pipelines Specification](abc). Follow these steps to define inputs and their values for a given pipeline.
5+
The pipelines are defined at the organization level. Thus the variables defined for them are injected at the same level. Learn more on how to define a input variable in your pipeline at [Variables and Secrets - Choreo Pipelines Specification](https://github.com/wso2/choreo-pipeline-specification/blob/36f292dcb34bdcf2292f5c8537efc57ef5f5e5a4/docs/specification/environment-variables.md). Follow these steps to define inputs and their values for a given pipeline.
66

77
1. Click on **Pipeline Variables & Secrets** at upper right corner of the pipeline page.
88
2. A panel will appear on the right side. To add a variable, under **Variables** section, add a new one by providing the Name and Value. The variable name must exactly match the name expected by the pipeline.
@@ -11,11 +11,25 @@ The pipelines are defined at the organization level. Thus the variables defined
1111
!!! info "Note"
1212
Once a secret is added, it is securely uploaded to the environment’s configured vault and injected into the pods running the workflow. You will not be able to view the secret value again after it is added.
1313

14-
## Manage existing Pipeline Variables and Secrets
14+
## Manage Existing Pipeline Variables and Secrets
1515

1616
To update or remove a secret, click the three vertical dots in the upper-right corner of the variable box in the Choreo UI. From the menu, choose the appropriate action.
1717

18-
# Run pipeline
18+
## Pipeline Parameters
19+
20+
Parameters are another type of variables referred by automation pipelines. Speciality of these variables is, before running the pipeline, user needs to choose a value for the parameters out of specified.
21+
22+
In pipeline definition, specify parameters like below.
23+
24+
```
25+
parameters:
26+
- name: environment
27+
default: "Development"
28+
enum: ["Development", "Production"]
29+
displayName: "Environment"
30+
```
31+
32+
# Run Pipeline
1933

2034
Once the pipeline inputs are configured, click **Start New Run** to trigger a workflow run. The run will use the latest version of the pipeline definition along with the configured inputs.
2135

@@ -27,16 +41,16 @@ Under the Runs table, a new row will appear displaying a unique **Run ID** for t
2741
- **Failed**: One or more steps in the pipeline failed.
2842
- **Stopped**: The pipeline was manually stopped.
2943
3. **Start Time** – The timestamp when the pipeline run was triggered.
30-
4. **Duration** – The total time taken to execute the pipeline. If the pipeline runs for more than a predefined threshold (e.g., xx minutes), it will be automatically force-stopped by Choreo.
44+
4. **Duration** – The total time taken to execute the pipeline. If the pipeline runs for more than a predefined threshold (default 60 minutes), it will be automatically force-stopped by Choreo.
3145

3246

33-
# View pipeline logs
47+
## View Pipeline Logs
3448

3549
Click **View Logs** for a selected pipeline run in the Runs table. This opens a panel on the right, displaying logs for each step of the pipeline. You can close or maximize the log panel using the icons in the upper-right corner of the panel.
3650

3751
!!! info "Note"
38-
Choreo keeps pipeline logs maximum for 30 days.
52+
Choreo keeps pipeline logs maximum for 30 days.
3953

40-
# Stop a pipeline run
54+
## Stop a Pipeline Run
4155

4256
One a pipeline run is triggered, Click on **View Logs** and then in the log panel that opens to the right, click on **Stop Run**.

0 commit comments

Comments
 (0)