diff --git a/docs/assets/operator-guide/devsecops/defectdojo-addons-deploy.png b/docs/assets/operator-guide/devsecops/defectdojo-addons-deploy.png new file mode 100644 index 000000000..4fc852f18 Binary files /dev/null and b/docs/assets/operator-guide/devsecops/defectdojo-addons-deploy.png differ diff --git a/docs/assets/operator-guide/devsecops/defectdojo-api-key.png b/docs/assets/operator-guide/devsecops/defectdojo-api-key.png new file mode 100644 index 000000000..0a42fde8f Binary files /dev/null and b/docs/assets/operator-guide/devsecops/defectdojo-api-key.png differ diff --git a/docs/assets/operator-guide/devsecops/defectdojo-createuser.png b/docs/assets/operator-guide/devsecops/defectdojo-createuser.png index a02dc0a30..9b4c423c1 100644 Binary files a/docs/assets/operator-guide/devsecops/defectdojo-createuser.png and b/docs/assets/operator-guide/devsecops/defectdojo-createuser.png differ diff --git a/docs/operator-guide/devsecops/defectdojo.md b/docs/operator-guide/devsecops/defectdojo.md index aabccf5e5..33f3fbfe7 100644 --- a/docs/operator-guide/devsecops/defectdojo.md +++ b/docs/operator-guide/devsecops/defectdojo.md @@ -25,7 +25,25 @@ Inspect the main steps to perform for installing DefectDojo via Helm Chart. and [Deploy DefectDojo into the Kubernetes cluster](https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/KUBERNETES.md) sections for details. ::: -To install DefectDojo, follow the steps below: +## Installation DefectDojo Cluster Add-On Approach + +To install DefectDojo in environment, it's recommended to use the resources provided in the [Cluster Add-Ons](https://github.com/epam/edp-cluster-add-ons) repository. Leveraging the Cluster Add-Ons simplifies the deployment and management process, providing a streamlined method to integrate DefectDojo into infrastructure. + +1. Navigate to the forked cluster Add-Ons repository and align the [defectdojo values.yaml](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/defectdojo/values.yaml) file. Follow the instructions to deploy DefectDojo. + +2. Update the configuration to enable **DefectDojo** in [Add-Ons](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core/apps/values.yaml) repository: + + ```yaml title="clusters/core/apps/values.yaml" + defectdojo: + createNamespace: true + enable: true + ``` + +3. Sync resources and wait till the all **DefectDojo** resources is created: + + ![DefectDojo ArgoCD applications](../../assets/operator-guide/devsecops/defectdojo-addons-deploy.png "DefectDojo ArgoCD applications") + +## Installation DefectDojo Helm Chart Approach 1. Check that a security namespace is created. If not, run the following command to create it: @@ -212,13 +230,13 @@ To install DefectDojo, follow the steps below: -## Configuration +## Configuration DefectDojo ci-user To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: 1. Create ci user in DefectDojo UI: - * Login to DefectDojo UI using admin credentials: + * Login to DefectDojo UI using `admin` credentials: ```bash echo "DefectDojo admin password: $(kubectl \ @@ -230,7 +248,7 @@ To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: * Go to User section - * Create new user with write permission: + * Create new user Global role `Maintainer` permission: ![DefectDojo update manual secret](../../assets/operator-guide/devsecops/defectdojo-createuser.png "DefectDojo set user permission") @@ -238,16 +256,20 @@ To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: * Login to the DefectDojo UI using the credentials from previous steps. - * Go to the API v2 key (token). + * Click on profile button select the `API v2 key`. * Copy the API key. -3. Provision the secret using `Portal UI`, `Manifest` or with the `externalSecrets` operator: + ![DefectDojo api key](../../assets/operator-guide/devsecops/defectdojo-api-key.png "DefectDojo api-key") + +## Integration DefectDojo with KubeRocketCI + +Provision the secret using `Portal UI`, `Manifest` or with the `externalSecrets` operator: diff --git a/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-addons-deploy.png b/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-addons-deploy.png new file mode 100644 index 000000000..4fc852f18 Binary files /dev/null and b/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-addons-deploy.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-api-key.png b/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-api-key.png new file mode 100644 index 000000000..0a42fde8f Binary files /dev/null and b/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-api-key.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-createuser.png b/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-createuser.png index a02dc0a30..9b4c423c1 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-createuser.png and b/versioned_docs/version-3.10/assets/operator-guide/devsecops/defectdojo-createuser.png differ diff --git a/versioned_docs/version-3.10/operator-guide/devsecops/defectdojo.md b/versioned_docs/version-3.10/operator-guide/devsecops/defectdojo.md index aabccf5e5..33f3fbfe7 100644 --- a/versioned_docs/version-3.10/operator-guide/devsecops/defectdojo.md +++ b/versioned_docs/version-3.10/operator-guide/devsecops/defectdojo.md @@ -25,7 +25,25 @@ Inspect the main steps to perform for installing DefectDojo via Helm Chart. and [Deploy DefectDojo into the Kubernetes cluster](https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/KUBERNETES.md) sections for details. ::: -To install DefectDojo, follow the steps below: +## Installation DefectDojo Cluster Add-On Approach + +To install DefectDojo in environment, it's recommended to use the resources provided in the [Cluster Add-Ons](https://github.com/epam/edp-cluster-add-ons) repository. Leveraging the Cluster Add-Ons simplifies the deployment and management process, providing a streamlined method to integrate DefectDojo into infrastructure. + +1. Navigate to the forked cluster Add-Ons repository and align the [defectdojo values.yaml](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/defectdojo/values.yaml) file. Follow the instructions to deploy DefectDojo. + +2. Update the configuration to enable **DefectDojo** in [Add-Ons](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core/apps/values.yaml) repository: + + ```yaml title="clusters/core/apps/values.yaml" + defectdojo: + createNamespace: true + enable: true + ``` + +3. Sync resources and wait till the all **DefectDojo** resources is created: + + ![DefectDojo ArgoCD applications](../../assets/operator-guide/devsecops/defectdojo-addons-deploy.png "DefectDojo ArgoCD applications") + +## Installation DefectDojo Helm Chart Approach 1. Check that a security namespace is created. If not, run the following command to create it: @@ -212,13 +230,13 @@ To install DefectDojo, follow the steps below: -## Configuration +## Configuration DefectDojo ci-user To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: 1. Create ci user in DefectDojo UI: - * Login to DefectDojo UI using admin credentials: + * Login to DefectDojo UI using `admin` credentials: ```bash echo "DefectDojo admin password: $(kubectl \ @@ -230,7 +248,7 @@ To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: * Go to User section - * Create new user with write permission: + * Create new user Global role `Maintainer` permission: ![DefectDojo update manual secret](../../assets/operator-guide/devsecops/defectdojo-createuser.png "DefectDojo set user permission") @@ -238,16 +256,20 @@ To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: * Login to the DefectDojo UI using the credentials from previous steps. - * Go to the API v2 key (token). + * Click on profile button select the `API v2 key`. * Copy the API key. -3. Provision the secret using `Portal UI`, `Manifest` or with the `externalSecrets` operator: + ![DefectDojo api key](../../assets/operator-guide/devsecops/defectdojo-api-key.png "DefectDojo api-key") + +## Integration DefectDojo with KubeRocketCI + +Provision the secret using `Portal UI`, `Manifest` or with the `externalSecrets` operator: diff --git a/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-addons-deploy.png b/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-addons-deploy.png new file mode 100644 index 000000000..4fc852f18 Binary files /dev/null and b/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-addons-deploy.png differ diff --git a/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-api-key.png b/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-api-key.png new file mode 100644 index 000000000..0a42fde8f Binary files /dev/null and b/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-api-key.png differ diff --git a/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-createuser.png b/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-createuser.png index a02dc0a30..9b4c423c1 100644 Binary files a/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-createuser.png and b/versioned_docs/version-3.9/assets/operator-guide/devsecops/defectdojo-createuser.png differ diff --git a/versioned_docs/version-3.9/operator-guide/devsecops/defectdojo.md b/versioned_docs/version-3.9/operator-guide/devsecops/defectdojo.md index aabccf5e5..33f3fbfe7 100644 --- a/versioned_docs/version-3.9/operator-guide/devsecops/defectdojo.md +++ b/versioned_docs/version-3.9/operator-guide/devsecops/defectdojo.md @@ -25,7 +25,25 @@ Inspect the main steps to perform for installing DefectDojo via Helm Chart. and [Deploy DefectDojo into the Kubernetes cluster](https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/KUBERNETES.md) sections for details. ::: -To install DefectDojo, follow the steps below: +## Installation DefectDojo Cluster Add-On Approach + +To install DefectDojo in environment, it's recommended to use the resources provided in the [Cluster Add-Ons](https://github.com/epam/edp-cluster-add-ons) repository. Leveraging the Cluster Add-Ons simplifies the deployment and management process, providing a streamlined method to integrate DefectDojo into infrastructure. + +1. Navigate to the forked cluster Add-Ons repository and align the [defectdojo values.yaml](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/defectdojo/values.yaml) file. Follow the instructions to deploy DefectDojo. + +2. Update the configuration to enable **DefectDojo** in [Add-Ons](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core/apps/values.yaml) repository: + + ```yaml title="clusters/core/apps/values.yaml" + defectdojo: + createNamespace: true + enable: true + ``` + +3. Sync resources and wait till the all **DefectDojo** resources is created: + + ![DefectDojo ArgoCD applications](../../assets/operator-guide/devsecops/defectdojo-addons-deploy.png "DefectDojo ArgoCD applications") + +## Installation DefectDojo Helm Chart Approach 1. Check that a security namespace is created. If not, run the following command to create it: @@ -212,13 +230,13 @@ To install DefectDojo, follow the steps below: -## Configuration +## Configuration DefectDojo ci-user To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: 1. Create ci user in DefectDojo UI: - * Login to DefectDojo UI using admin credentials: + * Login to DefectDojo UI using `admin` credentials: ```bash echo "DefectDojo admin password: $(kubectl \ @@ -230,7 +248,7 @@ To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: * Go to User section - * Create new user with write permission: + * Create new user Global role `Maintainer` permission: ![DefectDojo update manual secret](../../assets/operator-guide/devsecops/defectdojo-createuser.png "DefectDojo set user permission") @@ -238,16 +256,20 @@ To prepare DefectDojo for integration with KubeRocketCI, follow the steps below: * Login to the DefectDojo UI using the credentials from previous steps. - * Go to the API v2 key (token). + * Click on profile button select the `API v2 key`. * Copy the API key. -3. Provision the secret using `Portal UI`, `Manifest` or with the `externalSecrets` operator: + ![DefectDojo api key](../../assets/operator-guide/devsecops/defectdojo-api-key.png "DefectDojo api-key") + +## Integration DefectDojo with KubeRocketCI + +Provision the secret using `Portal UI`, `Manifest` or with the `externalSecrets` operator: