devtron-labs
diff --git a/‎api/cluster/EnvironmentRestHandler.go
Lines changed: 3 additions & 3 deletions b/‎api/cluster/EnvironmentRestHandler.go
Lines changed: 3 additions & 3 deletions
diff --git a/‎api/cluster/wire_cluster.go
Lines changed: 1 addition & 0 deletions b/‎api/cluster/wire_cluster.go
Lines changed: 1 addition & 0 deletions
diff --git a/‎api/k8s/application/k8sApplicationRestHandler.go
Lines changed: 1 addition & 0 deletions b/‎api/k8s/application/k8sApplicationRestHandler.go
Lines changed: 1 addition & 0 deletions
diff --git a/‎api/k8s/wire_k8sApp.go
Lines changed: 0 additions & 3 deletions b/‎api/k8s/wire_k8sApp.go
Lines changed: 0 additions & 3 deletions
diff --git a/‎cmd/external-app/wire_gen.go
Lines changed: 6 additions & 3 deletions b/‎cmd/external-app/wire_gen.go
Lines changed: 6 additions & 3 deletions
diff --git a/‎docs/SUMMARY.md
Lines changed: 3 additions & 0 deletions b/‎docs/SUMMARY.md
Lines changed: 3 additions & 0 deletions
diff --git a/‎docs/setup/install/ingress-setup.md
Lines changed: 140 additions & 13 deletions b/‎docs/setup/install/ingress-setup.md
Lines changed: 140 additions & 13 deletions
diff --git a/‎docs/user-guide/plugins/jira-updater.md
Lines changed: 57 additions & 0 deletions b/‎docs/user-guide/plugins/jira-updater.md
Lines changed: 57 additions & 0 deletions
diff --git a/‎docs/user-guide/plugins/jira-validator.md
Lines changed: 54 additions & 0 deletions b/‎docs/user-guide/plugins/jira-validator.md
Lines changed: 54 additions & 0 deletions
@@ -23,6 +23,7 @@ import (
 	"net/http"
 	"strconv"
 	"strings"
+	"sync"
 	"time"
 
 	k8s2 "github.com/devtron-labs/common-lib/utils/k8s"
@@ -513,9 +514,8 @@ func (impl EnvironmentRestHandlerImpl) GetEnvironmentConnection(w http.ResponseW
 		responseObj.ClusterReachable = false
 	}
 	//updating the cluster connection error to db
-	mapObj := map[int]error{
-		clusterBean.Id: err,
-	}
+	mapObj := &sync.Map{}
+	mapObj.Store(clusterBean.Id, err)
 	impl.environmentClusterMappingsService.HandleErrorInClusterConnections([]*request.ClusterBean{clusterBean}, mapObj, true)
 	common.WriteJsonResp(w, nil, responseObj, http.StatusOK)
 }
@@ -29,6 +29,7 @@ import (
 var ClusterWireSet = wire.NewSet(
 	repository.NewClusterRepositoryImpl,
 	wire.Bind(new(repository.ClusterRepository), new(*repository.ClusterRepositoryImpl)),
+	cluster.NewClusterServiceImpl,
 	cluster.NewClusterServiceImplExtended,
 	wire.Bind(new(cluster.ClusterService), new(*cluster.ClusterServiceImplExtended)),
 
 
@@ -559,6 +559,7 @@ func (handler *K8sApplicationRestHandlerImpl) GetPodLogs(w http.ResponseWriter,
 		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
 		return
 	}
+	handler.logger.Infow("get pod logs request", "request", request)
 	handler.requestValidationAndRBAC(w, r, token, request)
 	lastEventId := r.Header.Get(bean2.LastEventID)
 	isReconnect := false
 
@@ -53,7 +53,4 @@ var K8sApplicationWireSet = wire.NewSet(
 	informer.NewGlobalMapClusterNamespace,
 	informer.NewK8sInformerFactoryImpl,
 	wire.Bind(new(informer.K8sInformerFactory), new(*informer.K8sInformerFactoryImpl)),
-
-	cluster.NewClusterCronServiceImpl,
-	wire.Bind(new(cluster.ClusterCronService), new(*cluster.ClusterCronServiceImpl)),
 )
@@ -146,11 +146,14 @@
     * [DockerSlim](user-guide/plugins/docker-slim.md)
     * [GoLang-migrate](user-guide/plugins/golang-migrate.md)
     * [Jenkins](user-guide/plugins/jenkins.md)
+    * [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)
     * [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)
     * [SonarQube v1.1.0](user-guide/plugins/sonarqube-v1.1.0.md)
+    * [Vulnerability Scanning](user-guide/plugins/vulnerability-scanning.md)
 
 
 ## Resources
 
@@ -1,16 +1,144 @@
 # Ingress Setup
 
-After Devtron is installed, Devtron is accessible through service `devtron-service`.
-If you want to access Devtron through ingress, edit `devtron-service` and change the loadbalancer to ClusterIP. You can do this using `kubectl patch` command:
+## Introduction
+
+If you wish to use [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) as a means to access the Devtron services available in your cluster, you can configure it either during the installation or after the installation of Devtron.  
+
+Refer the section relevant to you:
+* [During Devtron Installation](#enabling-ingress-during-devtron-installation)
+* [After Devtron Installation](#configuring-ingress-after-devtron-installation)
+
+If you have successfully configured Ingress, refer [Post Ingress Setup](#enable-https-for-devtron).
+
+---
+
+## Enabling Ingress during Devtron Installation
+
+If you are installing Devtron, you can enable Ingress either via [set flag](#using-set-flag) or by using [ingress-values.yaml](#using-ingress-values.yaml) to specify the desired Ingress settings.
+
+### Using set flag
+
+You can use the `--set` flag to specify the desired Ingress settings.
+
+Here, we have added 5 configurations you can perform depending on your requirements:
+* [Only Basic Configuration](#only-basic-configuration)
+* [Configuration Including Labels](#configuration-including-labels)
+* [Configuration Including Annotations](#configuration-including-annotations)
+* [Configuration Including TLS Settings](#configuration-including-tls-settings)
+* [Comprehensive Configuration](#comprehensive-configuration)
+
+#### Only Basic Configuration
+
+To enable Ingress and set basic parameters, use the following command:
+
+```bash
+helm install devtron devtron/devtron-operator -n devtroncd \
+  --set components.devtron.ingress.enabled=true \
+  --set components.devtron.ingress.className=nginx \
+  --set components.devtron.ingress.host=devtron.example.com
+```
+
+#### Configuration Including Labels
+
+To add labels to the Ingress resource, use the following command:
+
+```bash
+helm install devtron devtron/devtron-operator -n devtroncd \
+  --set components.devtron.ingress.enabled=true \
+  --set components.devtron.ingress.className=nginx \
+  --set components.devtron.ingress.host=devtron.example.com \
+  --set components.devtron.ingress.labels.env=production
+```
+
+#### Configuration Including Annotations
+
+To add annotations to the Ingress resource, use the following command:
+
+```bash
+helm install devtron devtron/devtron-operator -n devtroncd \
+  --set components.devtron.ingress.enabled=true \
+  --set components.devtron.ingress.className=nginx \
+  --set components.devtron.ingress.host=devtron.example.com \
+  --set components.devtron.ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
+  --set components.devtron.ingress.annotations."nginx\.ingress\.kubernetes\.io\/app-root"="/dashboard"
+```
+
+#### Configuration Including TLS Settings
+
+To configure TLS settings, including `secretName` and `hosts`, use the following command:
+
+```bash
+helm install devtron devtron/devtron-operator -n devtroncd \
+  --set components.devtron.ingress.enabled=true \
+  --set components.devtron.ingress.className=nginx \
+  --set components.devtron.ingress.host=devtron.example.com \
+  --set components.devtron.ingress.tls[0].secretName=devtron-tls \
+  --set components.devtron.ingress.tls[0].hosts[0]=devtron.example.com
+```
+
+#### Comprehensive Configuration
+
+To include all the above settings in a single command, use:
+
+```bash
+helm install devtron devtron/devtron-operator -n devtroncd \
+  --set components.devtron.ingress.enabled=true \
+  --set components.devtron.ingress.className=nginx \
+  --set components.devtron.ingress.host=devtron.example.com \
+  --set components.devtron.ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
+  --set components.devtron.ingress.annotations."nginx\.ingress\.kubernetes\.io\/app-root"="/dashboard" \
+  --set components.devtron.ingress.labels.env=production \
+  --set components.devtron.ingress.pathType=ImplementationSpecific \
+  --set components.devtron.ingress.tls[0].secretName=devtron-tls \
+  --set components.devtron.ingress.tls[0].hosts[0]=devtron.example.com
+```
+
+
+### Using ingress-values.yaml
+
+As an alternative to the [set flag](#using-set-flag) method, you can enable Ingress using `ingress-values.yaml` instead. 
+
+Create an `ingress-values.yaml` file. You may refer the below format for an advanced ingress configuration which includes labels, annotations, secrets, and many more.
+
+```yml
+components:
+  devtron:
+    ingress:
+      enabled: true
+      className: nginx
+      labels: {}
+        # env: production
+      annotations: {}
+        # nginx.ingress.kubernetes.io/app-root: /dashboard
+      pathType: ImplementationSpecific
+      host: devtron.example.com
+      tls: []
+    #    - secretName: devtron-info-tls
+    #      hosts:
+    #        - devtron.example.com
+```
+
+Once you have the `ingress-values.yaml` file ready, run the following command:
+
+```bash
+helm install devtron devtron/devtron-operator -n devtroncd  --reuse-values  -f ingress-values.yaml
+```
+
+---
+
+## Configuring Ingress after Devtron Installation
+
+After Devtron is installed, Devtron is accessible through `devtron-service`. If you wish to access Devtron through ingress, you'll need to modify this service to use a ClusterIP instead of a LoadBalancer.
+
+You can do this using the `kubectl patch` command:
 
 ```bash
 kubectl patch -n devtroncd svc devtron-service -p '{"spec": {"ports": [{"port": 80,"targetPort": "devtron","protocol": "TCP","name": "devtron"}],"type": "ClusterIP","selector": {"app": "devtron"}}}'
 ```
 
-After this, create ingress by applying the ingress yaml file.
-You can use [this yaml file](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress.yaml) to create ingress to access Devtron:
+Next, create ingress to access Devtron by applying the `devtron-ingress.yaml` file. The file is also available on this [link](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress.yaml). You can access Devtron from any host after applying this yaml. 
 
-```yaml
+```yml
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -49,9 +177,9 @@ spec:
         pathType: ImplementationSpecific  
 ```        
 
-You can access Devtron from any host after applying this yaml. For k8s versions <1.19, [apply this yaml](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress-legacy.yaml):
+For k8s versions < 1.19, [apply this yaml](https://github.com/devtron-labs/devtron/blob/main/manifests/yamls/devtron-ingress-legacy.yaml):
 
-```yaml
+```yml
 apiVersion: extensions/v1beta1
 kind: Ingress
 metadata:
@@ -79,7 +207,7 @@ spec:
 
 Optionally, you also can access Devtron through a specific host by running the following YAML file:
 
-```yaml
+```yml
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -119,9 +247,11 @@ spec:
             pathType: ImplementationSpecific
 ```
 
+---
+
 ## Enable HTTPS For Devtron
 
-Once ingress setup for devtron is done and you want to run Devtron over `https`, you need to add different annotations for different ingress controllers and load balancers.
+Once Ingress setup for Devtron is done and you want to run Devtron over `https`, you need to add different annotations for different ingress controllers and load balancers.
 
 ### 1. Nginx Ingress Controller
 
@@ -175,7 +305,4 @@ In case of AWS application load balancer, the following annotations need to be a
 ```
 For an Ingress resource to be observed by AGIC (Application Gateway Ingress Controller) must be annotated with kubernetes.io/ingress.class: azure/application-gateway. Only then AGIC will work with the Ingress resource in question.
 
-> Note: Make sure NOT to use port 80 with HTTPS and port 443 with HTTP on the Pods.
-
-
-
+> Note: Make sure NOT to use port 80 with HTTPS and port 443 with HTTP on the Pods.
@@ -0,0 +1,57 @@
+# Jira Issue Updater
+
+## Introduction
+The Jira Issue Updater plugin extends the capabilities of Devtron CI by allowing updates to Jira issues directly from the pipeline. It can add build pipeline status and docker image ID as a comment on Jira tickets, keeping the issue tracking synchronized with your CI processes.
+
+### Prerequisites
+
+- A Jira account with the necessary [API access](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token).
+- The API credentials (username, password, and base URL) for your Jira instance. Obtain the API credentials from your Jira admin if required.
+- A pull request raised with your Git provider. Title of pull request must contain the Jira ID.
+- Jira Issue (e.g., REDOC-12)
+- Webhook added to the git repository. [Click here](https://docs.devtron.ai/usage/applications/creating-application/workflow/ci-pipeline#configuring-webhook) to know more.
+
+---
+
+## Steps
+
+1. On the **Edit build pipeline** page, go to the **Post-Build Stage**.
+2. Click **+ Add task**.
+3. Select **Jira Issue Updater** from the list of plugins.
+    * Enter a task name (mandatory).
+    * Optionally, enter a description.
+    * Provide values for the input variables.
+
+    | Variable                 | Format | Description                                               |
+    | ------------------------ | ------ | --------------------------------------------------------- |
+    | JiraUsername             | String | Your Jira username (e.g., [email protected])             |
+    | JiraPassword             | String | Your Jira API token provided by the Jira admin            |
+    | JiraBaseUrl              | String | The base URL of your Jira instance (e.g., https://yourdomain.atlassian.net/) |
+    | UpdateWithDockerImageId  | Bool   | Set to `true` to include the Docker Image ID in the update  |
+    | UpdateWithBuildStatus    | Bool   | Set to `true` to include the build status in the update     |
+
+    * `Trigger/Skip Condition` allows you to set conditions under which this task will execute or be skipped.
+    * `Pass/Failure Condition` allows you define conditions to determine if the build passes or fails based on the Jira update.
+
+4. Go to the **Build Stage**.
+
+5. Select **Pull Request** in the **Source Type** dropdown.
+
+6. Use filters to fetch only the PRs matching your regex. Here are few examples:
+    * **Title** can be a regex pattern (e.g., `^(?P<jira_Id>([a-zA-Z0-9-].*))`) to extract the Jira ID from the PR title. Only those PRs fulfilling the regex will be shown for image build process. 
+    * **State** can be `^open$`, where only PRs in open state will be shown for image build process.
+
+7. Click **Update Pipeline**.
+
+--- 
+
+## Results
+
+![Figure 1: Build Log](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/plugins/jira/jira-updater-log.jpg)
+
+![Figure 2: Comments added by the Plugin on the Jira Issue](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/plugins/jira/jira-updater.jpg)
+
+
+
+
+
@@ -0,0 +1,54 @@
+# Jira Issue Validator
+
+## Introduction
+The Jira Issue Validator plugin extends the filtering capabilities of the Devtron CI and lets users perform validation based on Jira Ticket ID status. This plugin ensures that only builds associated with valid Jira tickets are executed, improving the accuracy of the CI process.
+
+### Prerequisites
+
+- A Jira account with the necessary [API access](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token).
+- The API credentials (username, password, and base URL) for your Jira instance. Obtain the API credentials from your Jira admin if required.
+- A pull request raised with your Git provider. Title of pull request must contain the Jira ID.
+- Jira Issue (e.g., REDOC-12)
+- Webhook added to the git repository. [Click here](https://docs.devtron.ai/usage/applications/creating-application/workflow/ci-pipeline#configuring-webhook) to know more.
+
+---
+
+## Steps
+
+1. On the **Edit build pipeline** page, go to the **Pre-Build Stage** (or Post-Build Stage).
+2. Click **+ Add task**.
+3. Select **Jira Issue Validator** from the list of plugins.
+    * Enter a task name (mandatory).
+    * Optionally, enter a description.
+    * Provide values for the input variables.
+
+    | Variable       | Format | Description                                               |
+    | -------------- | ------ | --------------------------------------------------------- |
+    | JiraUsername   | String | Your Jira username  (e.g., [email protected])            |
+    | JiraPassword   | String | Your Jira API token provided by the Jira admin            |
+    | JiraBaseUrl    | String | The base URL of your Jira instance (e.g., https://yourdomain.atlassian.net) |
+
+    * `Trigger/Skip Condition` allows you to set conditions under which this task will execute or be skipped.
+    * `Pass/Failure Condition` allows you to define conditions that determine whether the build passes or fails based on Jira validation.
+
+4. Go to the **Build Stage**.
+
+5. Select **Pull Request** in the **Source Type** dropdown.
+
+6. Use filters to fetch only the PRs matching your regex. Here are few examples:
+    * **Title** can be a regex pattern (e.g., `^(?P<jira_Id>([a-zA-Z0-9-].*))`) to extract the Jira ID from the PR title. Only those PRs fulfilling the regex will be shown for image build process. 
+    * **State** can be `^open$`, where only PRs in open state will be shown for image build process.
+
+7. Click **Update Pipeline**.
+
+--- 
+
+## Results
+
+**Case 1**: If Jira issue exists and the same is found in the PR title
+
+![Figure 1: Jira Issue Match](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/plugins/jira/jira-issue-validator.jpg)
+
+**Case 2**: If Jira issue is not found
+
+![Figure 2: Error in Finding Jira Issue](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/plugins/jira/issue-validation-failed.jpg)
Original file line number	Diff line number	Diff line change
`@@ -559,6 +559,7 @@ func (handler *K8sApplicationRestHandlerImpl) GetPodLogs(w http.ResponseWriter,`
`559`	`559`	`common.WriteJsonResp(w, err, nil, http.StatusBadRequest)`
`560`	`560`	`return`
`561`	`561`	`}`
	`562`	`+ handler.logger.Infow("get pod logs request", "request", request)`
`562`	`563`	`handler.requestValidationAndRBAC(w, r, token, request)`
`563`	`564`	`lastEventId := r.Header.Get(bean2.LastEventID)`
`564`	`565`	`isReconnect := false`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,4 @@ var K8sApplicationWireSet = wire.NewSet(`
`53`	`53`	`informer.NewGlobalMapClusterNamespace,`
`54`	`54`	`informer.NewK8sInformerFactoryImpl,`
`55`	`55`	`wire.Bind(new(informer.K8sInformerFactory), new(*informer.K8sInformerFactoryImpl)),`
`56`		`-`
`57`		`- cluster.NewClusterCronServiceImpl,`
`58`		`- wire.Bind(new(cluster.ClusterCronService), new(*cluster.ClusterCronServiceImpl)),`
`59`	`56`	`)`