You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/pe-docs/docs/devops/automation-pipelines/inbuilt-templates.md
+40-4Lines changed: 40 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
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.
2
2
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:
4
4
5
-
```
5
+
```yaml
6
6
steps:
7
-
- name: Build
7
+
- name: <step name>
8
8
template: choreo/<template name>
9
9
```
10
10
11
11
## Available Built-in Templates
12
12
13
13
!!! 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)
15
15
16
16
??? "choreo/buildpack-build@v1"
17
17
Builds applications using supported buildpacks within Choreo. This is used by Choreo’s default build pipeline.
@@ -42,3 +42,39 @@ steps:
42
42
43
43
??? "choreo/prism-build@v1"
44
44
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.
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.
5
5
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.
Copy file name to clipboardExpand all lines: en/pe-docs/docs/devops/automation-pipelines/manage-automation-pipeline.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,12 @@
3
3
Choreo allows to define automation pipelines at organization level. Follow these steps to create an automation pipeline.
4
4
5
5
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
9
10
10
-
## Define pipeline within Choreo
11
+
## Define Pipeline within Choreo
11
12
12
13
This option is useful when you are testing a pipeline or if you like to let Choreo to keep your pipeline definitions.
13
14
@@ -18,12 +19,12 @@ This option is useful when you are testing a pipeline or if you like to let Chor
18
19
19
20
This pipeline definition is managed within Choreo. You can update it after defining as well.
20
21
21
-
## Import pipeline from Git
22
+
## Import Pipeline from Git
22
23
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.
24
25
25
26
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.
27
28
3. Provide a name by which you can identify the pipeline.
28
29
4. Optionally provide a description
29
30
5. Click **Create**
@@ -33,7 +34,7 @@ Created pipelines will be listed in a tabular view.
33
34
34
35
# Edit Automation Pipelines
35
36
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 fullscreen 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.
37
38
38
39
!!! info "Note"
39
40
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.
44
45
# Delete Automation Pipelines
45
46
46
47
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.
Copy file name to clipboardExpand all lines: en/pe-docs/docs/devops/automation-pipelines/run-automation-pipeline.md
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ After a pipeline is defined, you can execute it. The pipeline may need some inpu
2
2
3
3
# Add Pipeline Variables and Secrets
4
4
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.
6
6
7
7
1. Click on **Pipeline Variables & Secrets** at upper right corner of the pipeline page.
8
8
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
11
11
!!! info "Note"
12
12
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.
13
13
14
-
## Manage existing Pipeline Variables and Secrets
14
+
## Manage Existing Pipeline Variables and Secrets
15
15
16
16
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.
17
17
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
19
33
20
34
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.
21
35
@@ -27,16 +41,16 @@ Under the Runs table, a new row will appear displaying a unique **Run ID** for t
27
41
-**Failed**: One or more steps in the pipeline failed.
28
42
-**Stopped**: The pipeline was manually stopped.
29
43
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.
31
45
32
46
33
-
# View pipeline logs
47
+
##View Pipeline Logs
34
48
35
49
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.
36
50
37
51
!!! info "Note"
38
-
Choreo keeps pipeline logs maximum for 30 days.
52
+
Choreo keeps pipeline logs maximum for 30 days.
39
53
40
-
# Stop a pipeline run
54
+
##Stop a Pipeline Run
41
55
42
56
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