Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Align DefectDojo integration guide #154

Merged
merged 1 commit into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/operator-guide/devsecops/defectdojo-createuser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 29 additions & 7 deletions docs/operator-guide/devsecops/defectdojo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -212,13 +230,13 @@ To install DefectDojo, follow the steps below:

</details>

## 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 \
Expand All @@ -230,24 +248,28 @@ 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")

2. Get a token of the DefectDojo user:

* 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:

<Tabs
defaultValue="portal"
values={[
{label: 'UI Portal', value: 'portal'},
{label: 'Portal UI', value: 'portal'},
{label: 'Manifest', value: 'manifest'},
{label: 'External Secrets Operator', value: 'eso'}
]}>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 29 additions & 7 deletions versioned_docs/version-3.10/operator-guide/devsecops/defectdojo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -212,13 +230,13 @@ To install DefectDojo, follow the steps below:

</details>

## 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 \
Expand All @@ -230,24 +248,28 @@ 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")

2. Get a token of the DefectDojo user:

* 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:

<Tabs
defaultValue="portal"
values={[
{label: 'UI Portal', value: 'portal'},
{label: 'Portal UI', value: 'portal'},
{label: 'Manifest', value: 'manifest'},
{label: 'External Secrets Operator', value: 'eso'}
]}>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 29 additions & 7 deletions versioned_docs/version-3.9/operator-guide/devsecops/defectdojo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -212,13 +230,13 @@ To install DefectDojo, follow the steps below:

</details>

## 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 \
Expand All @@ -230,24 +248,28 @@ 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")

2. Get a token of the DefectDojo user:

* 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:

<Tabs
defaultValue="portal"
values={[
{label: 'UI Portal', value: 'portal'},
{label: 'Portal UI', value: 'portal'},
{label: 'Manifest', value: 'manifest'},
{label: 'External Secrets Operator', value: 'eso'}
]}>
Expand Down