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 725eb6d5481726481e43edcf2386248e9d7428d8 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Fri, 13 Dec 2024 17:26:22 +0530 Subject: [PATCH 3/5] GKE plugin update --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 45f93a507..982945483 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -140,7 +140,6 @@ * [Copy Container Image](user-guide/plugins/copy-container-image.md) * [Cosign](user-guide/plugins/cosign.md) * [CraneCopy](user-guide/plugins/crane-copy.md) - * [GKE Provisioner](user-guide/plugins/gke-provisioner.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) @@ -151,6 +150,7 @@ * [EKS Create Cluster](user-guide/plugins/eks-create-cluster.md) * [GCS Create Bucket](user-guide/plugins/gcs-create-bucket.md) * [GitHub Pull Request Updater](user-guide/plugins/github-pull-request-updater.md) + * [GKE Provisioner](user-guide/plugins/gke-provisioner.md) * [GoLang-migrate](user-guide/plugins/golang-migrate.md) * [Jenkins](user-guide/plugins/jenkins.md) * [Jira Issue Validator](user-guide/plugins/jira-validator.md) From 22a68a331beb8f329b8fb244de95aaa94eb269e6 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Thu, 30 Jan 2025 11:06:55 +0530 Subject: [PATCH 4/5] doc for mail master plugin --- docs/SUMMARY.md | 1 + docs/user-guide/plugins/mail-master.md | 68 ++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 docs/user-guide/plugins/mail-master.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 982945483..ffa9bd050 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -156,6 +156,7 @@ * [Jira Issue Validator](user-guide/plugins/jira-validator.md) * [Jira Issue Updater](user-guide/plugins/jira-updater.md) * [K6 Load Testing](user-guide/plugins/k6-load-testing.md) + * [Mail Master](user-guide/plugins/mail-master.md) * [Pull images from container repository](user-guide/plugins/pull-images-from-container-repository.md) * [Semgrep](user-guide/plugins/semgrep.md) * [SonarQube](user-guide/plugins/sonarqube.md) diff --git a/docs/user-guide/plugins/mail-master.md b/docs/user-guide/plugins/mail-master.md new file mode 100644 index 000000000..9f6c68269 --- /dev/null +++ b/docs/user-guide/plugins/mail-master.md @@ -0,0 +1,68 @@ +# Mail Master + +## Introduction +The Mail Master plugin by Devtron streamlines email communication by enabling automated bulk email notifications through your configured SMTP server. It helps keep all stakeholders informed throughout the application lifecycle, ensuring seamless communication for workflow events. When integrated into Devtron's post-CD stage, this plugin can automatically notify multiple team members, project managers, clients, and other stakeholders about new application deployments. To ensure that everyone stays informed about the latest changes and features. + +### Prerequisites +Before integrating the **Mail Master** plugin, you must ensure that you have properly configured SMTP 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 deploy pipeline** window and navigate to the **Post-deploy stage**. + +{% hint style="warning" %} +If you have already configured workflow, edit the build pipeline, and navigate to **Post-deploy stage**. +{% endhint %} + +6. Under 'TASKS', click the **+ Add task** button. +7. Click the **Mail Master** plugin. +8. Enter the following [user inputs](#user-inputs) with appropriate values. + +--- + +## User Inputs + +### Task Name +Enter the name of your task + +e.g., `Mail Master` + +### 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 Mail Master plugin is integrated for sending bulk automated email notifications to relevant stakeholders.` + +### Input Variables +| Variable | Format | Description | Sample Value | +| ------------------------ | ------------ | ----------- | ------------ | +| SmtpServer | STRING | The host name of SMTP server | smtp.gmail.com | +| SmtpUsername | STRING | The username of SMTP connection | user@example.com | +| SmtpPassword | STRING | Password of SMTP connection | mysecretpassword | +| SenderEmail | STRING | Sender's email address | sender@example.com | +| EmailContentFile | STRING | Provide path of email content file | /path/to/emailContent.html | +| SmtpPort | NUMBER | Port that will be used for SMTP connection. Default port is 587 | 433 | +| RecipientConfigFile | STRING | Provide path of config.json, that contains list of recipients | /path/to/recipientsConfig.json | +| EmailSubject | STRING | Provide subject for the email. Subject can also be provided in `EmailContentFile` after "Subject" | "Monthly Release" | +| BatchSize | NUMBER | Number of emails that should be sent per batch. The default number is 10 | 200 | +| BatchDelayTime | NUMBER | Time to wait in two batch (in seconds) | 15 | +| SenderName | STRING | Name of sender | John Doe | +| RecipientsGroupName | STRING | Group id for selecting recipients from config.json | "ReleaseTeam" | +| RecipientsSubGroupName | STRING | The Sub-group id for selecting recipients from config.json | "NorthRegion" | +| Recipients | STRING | Emails of recipients seprated by "," if user is not specified in config.json file | recipient1@example.com,recipient2@example.com | + + +### 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 +Mail Master will not be generating an output variable. + +Click **Update Pipeline**. + + + From 652366980ada5c4017e9ea98f29914280b23d134 Mon Sep 17 00:00:00 2001 From: Bhushan Nemade Date: Mon, 3 Feb 2025 16:30:35 +0530 Subject: [PATCH 5/5] minor changes at steps --- docs/user-guide/plugins/mail-master.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/mail-master.md b/docs/user-guide/plugins/mail-master.md index 9f6c68269..e78713a3b 100644 --- a/docs/user-guide/plugins/mail-master.md +++ b/docs/user-guide/plugins/mail-master.md @@ -16,7 +16,7 @@ Before integrating the **Mail Master** plugin, you must ensure that you have pro 5. Fill the required fields in the **Create deploy pipeline** window and navigate to the **Post-deploy stage**. {% hint style="warning" %} -If you have already configured workflow, edit the build pipeline, and navigate to **Post-deploy stage**. +If you have already configured workflow, edit deployment pipeline, and navigate to **Post-deploy stage**. {% endhint %} 6. Under 'TASKS', click the **+ Add task** button.