From 19bd2ca30653e813bd65b115c53bf921ce0528fe Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Wed, 13 Nov 2024 13:28:04 +0530 Subject: [PATCH 1/5] gcs-create-bucket plugin doc --- docs/user-guide/plugins/gcs-create-bucket.md | 69 ++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/user-guide/plugins/gcs-create-bucket.md diff --git a/docs/user-guide/plugins/gcs-create-bucket.md b/docs/user-guide/plugins/gcs-create-bucket.md new file mode 100644 index 000000000..d6c3711e1 --- /dev/null +++ b/docs/user-guide/plugins/gcs-create-bucket.md @@ -0,0 +1,69 @@ +# GCS Create Bucket + +## Introduction +The **GCS Create Bucket** plugin of Devtron enables automated creation of Google Cloud Storage (GCS) buckets directly within CI/CD workflows. By integrating the GCS Create Bucket teams can simplify cloud storage provisioning and can efficiently manage and store application logs, deployment artifacts, backup data, and other critical application assets in a centralized cloud storage solution. + +### Prerequisites +Before integrating the **GCS Create Bucket** plugin, ensure you have a Google Cloud Platform (GCP) account and GCP Project with appropriate permissions. + +--- + +## Steps +1. Go to **Applications** → **Devtron Apps**. +2. Click your application. +3. Go to **App Configuration** → **Workflow Editor**. +4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. +5. Fill the required fields in the **Create build pipeline** window and navigate to the **Pre-build stage**. + +{% hint style="warning" %} +If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**. +{% endhint %} + +6. Under 'TASKS', click the **+ Add task** button. +7. Click the **GCS Create Bucket** plugin. +8. Enter the following [user inputs](#user-inputs) with appropriate values. +--- + +## User Inputs + +### Task Name +Enter the name of your task + +e.g., `GCS Create Bucket` + +### Description +Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. + +e.g., `A Plugin to create GCS Bucket` + +### Input Variables + +| Variable | Format | Description | Sample Value | +| ------------------------ | ------------ | ----------- | ------------ | +| BucketName | STRING | Name of the GCS bucket to be created | my-app-logs-bucket | +| StorageClass | STRING | Storage class for the bucket (STANDARD, NEARLINE, COLDLINE, ARCHIVE) | archive | +| Project | STRING | GCP project ID where the bucket will be created | gcp-68493 | +| EnableBucketPrefix | STRING | Enable prefix for bucket naming (true/false) | true | +| ServiceAccountCred | STRING | Base64 encoded GCP service account credentials | eyJ0eXBlIjoic2VydmljZV9hY2 | +| LocationType | STRING | Type of location (region/dual-region/multi-region) | region | +| Location | STRING | Geographic location where bucket will be created | us-central1 | +| EnableAutoClass | BOOL | Automatically optimizes storage costs by moving objects between storage classes based on how frequently they are accessed. Default is false. | true | +| UniformAccess | STRING | Enable uniform bucket-level access control to create bucket with bucket level permissions instead of Access control list (true/false) | true | + +### Trigger/Skip Condition +Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task. + +### Output Variables + +| Variable | Format | Description | +| ------------------------ | ------------ | ----------- | +| BucketName | STRING | The name of the bucket createed. + +### Pass/Failure Condition +Here you can define when a task should be marked as passed or failed. You can select `Set pass conditions` to define success criteria or `Set failure conditions` to specify failure scenarios. + + +Click **Update Pipeline**. + + + From 336856361f0b708104cbdad21b3507d6a46626de Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Fri, 15 Nov 2024 12:53:52 +0530 Subject: [PATCH 2/5] fix --- docs/user-guide/plugins/gcs-create-bucket.md | 69 -------------------- 1 file changed, 69 deletions(-) delete mode 100644 docs/user-guide/plugins/gcs-create-bucket.md diff --git a/docs/user-guide/plugins/gcs-create-bucket.md b/docs/user-guide/plugins/gcs-create-bucket.md deleted file mode 100644 index d6c3711e1..000000000 --- a/docs/user-guide/plugins/gcs-create-bucket.md +++ /dev/null @@ -1,69 +0,0 @@ -# GCS Create Bucket - -## Introduction -The **GCS Create Bucket** plugin of Devtron enables automated creation of Google Cloud Storage (GCS) buckets directly within CI/CD workflows. By integrating the GCS Create Bucket teams can simplify cloud storage provisioning and can efficiently manage and store application logs, deployment artifacts, backup data, and other critical application assets in a centralized cloud storage solution. - -### Prerequisites -Before integrating the **GCS Create Bucket** plugin, ensure you have a Google Cloud Platform (GCP) account and GCP Project with appropriate permissions. - ---- - -## Steps -1. Go to **Applications** → **Devtron Apps**. -2. Click your application. -3. Go to **App Configuration** → **Workflow Editor**. -4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. -5. Fill the required fields in the **Create build pipeline** window and navigate to the **Pre-build stage**. - -{% hint style="warning" %} -If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**. -{% endhint %} - -6. Under 'TASKS', click the **+ Add task** button. -7. Click the **GCS Create Bucket** plugin. -8. Enter the following [user inputs](#user-inputs) with appropriate values. ---- - -## User Inputs - -### Task Name -Enter the name of your task - -e.g., `GCS Create Bucket` - -### Description -Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. - -e.g., `A Plugin to create GCS Bucket` - -### Input Variables - -| Variable | Format | Description | Sample Value | -| ------------------------ | ------------ | ----------- | ------------ | -| BucketName | STRING | Name of the GCS bucket to be created | my-app-logs-bucket | -| StorageClass | STRING | Storage class for the bucket (STANDARD, NEARLINE, COLDLINE, ARCHIVE) | archive | -| Project | STRING | GCP project ID where the bucket will be created | gcp-68493 | -| EnableBucketPrefix | STRING | Enable prefix for bucket naming (true/false) | true | -| ServiceAccountCred | STRING | Base64 encoded GCP service account credentials | eyJ0eXBlIjoic2VydmljZV9hY2 | -| LocationType | STRING | Type of location (region/dual-region/multi-region) | region | -| Location | STRING | Geographic location where bucket will be created | us-central1 | -| EnableAutoClass | BOOL | Automatically optimizes storage costs by moving objects between storage classes based on how frequently they are accessed. Default is false. | true | -| UniformAccess | STRING | Enable uniform bucket-level access control to create bucket with bucket level permissions instead of Access control list (true/false) | true | - -### Trigger/Skip Condition -Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task. - -### Output Variables - -| Variable | Format | Description | -| ------------------------ | ------------ | ----------- | -| BucketName | STRING | The name of the bucket createed. - -### Pass/Failure Condition -Here you can define when a task should be marked as passed or failed. You can select `Set pass conditions` to define success criteria or `Set failure conditions` to specify failure scenarios. - - -Click **Update Pipeline**. - - - From a3ec6f4b909eec53e577439d5d3b832baffa3587 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Fri, 3 Jan 2025 14:45:32 +0530 Subject: [PATCH 3/5] doc for custom webhook notifier plugin --- docs/SUMMARY.md | 1 + .../plugins/custom-webhook-notifier.md | 61 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 docs/user-guide/plugins/custom-webhook-notifier.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 58af2000f..25922ad59 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -139,6 +139,7 @@ * [Copy Container Image](user-guide/plugins/copy-container-image.md) * [Cosign](user-guide/plugins/cosign.md) * [CraneCopy](user-guide/plugins/crane-copy.md) + * [Custom Webhook Notifier](user-guide/plugins/custom-webhook-notifier.md) * [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md) * [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md) * [Dependency track - Python](user-guide/plugins/dependency-track-python.md) diff --git a/docs/user-guide/plugins/custom-webhook-notifier.md b/docs/user-guide/plugins/custom-webhook-notifier.md new file mode 100644 index 000000000..3bab10b94 --- /dev/null +++ b/docs/user-guide/plugins/custom-webhook-notifier.md @@ -0,0 +1,61 @@ +# Custom Webhook Notifier + +## Introduction +The Custom Webhook Notifier plugin by Devtron allows users to set up automated webhook notifications that integrate with various third-party services in their Job pipelines and at pre/post stages of Devtron CI/CD workflows. Teams can seamlessly integrate this plugin to keep external services and team members updated about pipeline events and status changes. Some key use cases of this plugin can be: +- Configuring notifications at pre/post stages to update teams on task completion status, such as sending vulnerability scanning reports. +- Setting up automated alerts at the runbooks of auto-remediation. + +{% hint style="warning" %} +If you wish to get notifications at Trigger, Success, and Failure events of CI/CD pipelines, use Devtron's native [Notifications](https://docs.devtron.ai/global-configurations/manage-notification). +{% endhint %} + +### Prerequisites +Before integrating the **Custom Webhook Notifier** plugin, you must ensure that you have properly configured weebhook notifications in your Devtron setup. + +--- + +## Steps +1. Go to **Applications** → **Devtron Apps**. +2. Click your application. +3. Go to **App Configuration** → **Workflow Editor**. +4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. +5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**. + +{% hint style="warning" %} +If you have already configured workflow, edit the build pipeline, and navigate to **Post-build stage**. +{% endhint %} + +6. Under 'TASKS', click the **+ Add task** button. +7. Click the **Custom Webhook Notifier** plugin. +8. Enter the following [user inputs](#user-inputs) with appropriate values. + +--- + +## User Inputs + +### Task Name +Enter the name of your task + +e.g., `Webhook Notifier` + +### Description +Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. + +e.g., `The Custom Webhook Notifier plugin is integrated for sending an automated email notifications to relevant stakeholders.` + +### Input Variables +| Variable | Format | Description | Sample Value | +| ------------------------ | ------------ | ----------- | ------------ | +| CONFIG_TYPE | STRING | Type of notification configuration. SES or SMTP | SES | +| CONFIG_NAME | STRING | Name of the notification configuration to be used. This should match an existing notification configuration in Devtron. | vulnerability-scan report | + +### Trigger/Skip Condition +Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task. + +### Output Variables +Custom Webhook Notifier will not be generating an output variable. + +Click **Update Pipeline**. + + + From 0da94e45adececf8499d290dea6348d59b26e043 Mon Sep 17 00:00:00 2001 From: Bhushan Nemade Date: Thu, 30 Jan 2025 11:03:33 +0530 Subject: [PATCH 4/5] minor updates --- docs/user-guide/plugins/custom-webhook-notifier.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/custom-webhook-notifier.md b/docs/user-guide/plugins/custom-webhook-notifier.md index 3bab10b94..9c6a1a4af 100644 --- a/docs/user-guide/plugins/custom-webhook-notifier.md +++ b/docs/user-guide/plugins/custom-webhook-notifier.md @@ -3,7 +3,7 @@ ## Introduction The Custom Webhook Notifier plugin by Devtron allows users to set up automated webhook notifications that integrate with various third-party services in their Job pipelines and at pre/post stages of Devtron CI/CD workflows. Teams can seamlessly integrate this plugin to keep external services and team members updated about pipeline events and status changes. Some key use cases of this plugin can be: - Configuring notifications at pre/post stages to update teams on task completion status, such as sending vulnerability scanning reports. -- Setting up automated alerts at the runbooks of auto-remediation. +- Setting up automated alerts at the runbooks of auto-remediation using jobs. {% hint style="warning" %} If you wish to get notifications at Trigger, Success, and Failure events of CI/CD pipelines, use Devtron's native [Notifications](https://docs.devtron.ai/global-configurations/manage-notification). @@ -15,6 +15,11 @@ Before integrating the **Custom Webhook Notifier** plugin, you must ensure that --- ## Steps + +{% hint style="warning" %} +If you want to integrate the **Custom Webhook Notifier** at the job, navigate to the **[Custom Email Notifier](https://docs.devtron.ai/usage/plugins/plugin-list/custom-email-notifier)** plugin and follow the steps mentioned. +{% endhint %} + 1. Go to **Applications** → **Devtron Apps**. 2. Click your application. 3. Go to **App Configuration** → **Workflow Editor**. From 35cac45461453198103c84097392f70d5abe0807 Mon Sep 17 00:00:00 2001 From: Bhushan Nemade Date: Fri, 28 Feb 2025 12:36:42 +0530 Subject: [PATCH 5/5] fix --- docs/user-guide/plugins/custom-webhook-notifier.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/plugins/custom-webhook-notifier.md b/docs/user-guide/plugins/custom-webhook-notifier.md index 9c6a1a4af..11518c790 100644 --- a/docs/user-guide/plugins/custom-webhook-notifier.md +++ b/docs/user-guide/plugins/custom-webhook-notifier.md @@ -10,7 +10,7 @@ If you wish to get notifications at Trigger, Success, and Failure events of CI/C {% endhint %} ### Prerequisites -Before integrating the **Custom Webhook Notifier** plugin, you must ensure that you have properly configured weebhook notifications in your Devtron setup. +Before integrating the **Custom Webhook Notifier** plugin, you must ensure that you have properly configured webhook notifications in your Devtron setup. --- @@ -46,8 +46,7 @@ e.g., `Webhook Notifier` ### Description Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. -e.g., `The Custom Webhook Notifier plugin is integrated for sending an automated email notifications to relevant stakeholders.` - +e.g., `The Custom Webhook Notifier plugin is integrated to automatically send email notifications about the build pipeline status, keeping relevant stakeholders informed.` ### Input Variables | Variable | Format | Description | Sample Value | | ------------------------ | ------------ | ----------- | ------------ |