Skip to content

Commit ffca749

Browse files
committed
#2086 reformat persistence-storage.md to use markdown instead of HTML. This fits better with Docusaurus
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
1 parent a1bbace commit ffca749

1 file changed

Lines changed: 39 additions & 53 deletions

File tree

‎documentation/docs/how-tos/persistence-storage.md‎

Lines changed: 39 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ helm upgrade --install \
8282

8383
<details>
8484
<summary>Using kind:</summary>
85-
<code>
85+
```shell
8686
git clone https://github.com/DefectDojo/django-DefectDojo
8787
cd django-DefectDojo
8888

@@ -104,7 +104,7 @@ helm upgrade --install \
104104
--set createPostgresqlSecret=true \
105105
--set host="defectdojo.default.kind.local" \
106106
--set "alternativeHosts={localhost,defectdojo.default.kind.local:8080,defectdojo-django.default.svc}"
107-
</code>
107+
```
108108
</details>
109109

110110
After a while, you should see that all pods are running:
@@ -338,55 +338,41 @@ set DefectDojo to [read-only mode](https://www.securecodebox.io/docs/hooks/defec
338338

339339
<details>
340340
<summary>Troubleshooting</summary>
341-
Connecting the SCB to a persistence provider, especially DefectDojo, can sometimes be a bit tricky.
342-
The following tips might help in case that something went wrong:
343-
<br /><br />
344-
<ul>
345-
<li> <b>Waiting:</b> It takes some time for the DefectDojo or Kibana instance to come up. You might also have to refresh
346-
several times in order to connect to localhost after the port-forward.
347-
</li>
348-
<li> <b>Verbose logging:</b> You can view verbose output for everything in your cluster,
349-
for example via <a href="https://github.com/wercker/stern">stern</a>.
350-
For the following steps,
351-
you have to have <a href="https://krew.sigs.k8s.io/docs/user-guide/setup/install/#bash">krew</a> installed:
352-
<br />
353-
<code>
354-
kubectl krew install stern <br />
355-
# View all logs in default namespace: <br />
356-
kubectl stern .* <br />
357-
# View for a specific namespace <br />
358-
kubectl stern .* --namespace scanning
359-
</code>
360-
</li>
361-
<li> <b>Re-Installation of DefectDojo:</b> Node that if anything went wrong, and you have to re-install
362-
DefectDojo in the cluster, the <i>createSecret</i> flags in the values.yaml file of DefectDojo must not be set.
363-
You can find more
364-
details <a href="https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/KUBERNETES.md#re-install-the-chart">here</a>.
365-
</li>
366-
<li> <b>Server error in DefectDojo</b>: Make sure that all pods are running. If you are continuing to experience errors
367-
after a re-installation, consider to use a different cluster manager (e.g. kind instead of minikube).
368-
</li>
369-
<li> <b>Using a local instance of DefectDojo rather than Kubernetes</b>: If nothing helps, you still have the option
370-
to run DefectDojo outside
371-
your cluster (instructions <a href="https://github.com/DefectDojo/django-DefectDojo#quick-start">here</a>). After that,
372-
you can connect the DefectDojo hook treating it like a <i>remote</i> instance of DefectDojo. The helm install command
373-
for the hook would look like this: <br />
374-
<code>
375-
# $YOURLOCALIP should look something like http://192.168.2.242:8080 <br />
376-
helm upgrade --install persistence-defectdojo secureCodeBox/persistence-defectdojo \ <br />
377-
--set="defectdojo.url=$YOURLOCALIP"
378-
</code>
379-
</li>
380-
<li> <b>Increasing cluster resources</b>: Running a lot of pods at the same time can be resource-intensive. If you
381-
find that your persistence providers are not reacting in appropriate time, you might want to increase the number of
382-
cpus and memory usage for your minikube cluster: <br />
383-
<code>
384-
# If you already created a cluster, you most likely have to delete it at first <br />
385-
minikube stop <br />
386-
minikube delete <br />
387-
# Create a new cluster with more resources <br />
388-
minikube start --memory 8192 --cpus 4
389-
</code>
390-
</li>
391-
</ul>
341+
342+
Connecting the SCB to a persistence provider, especially DefectDojo, can sometimes be a bit tricky. The following tips might help in case that something went wrong:
343+
344+
- **Waiting:** It takes some time for the DefectDojo or Kibana instance to come up. You might also have to refresh several times in order to connect to localhost after the port-forward.
345+
346+
- **Verbose logging:** You can view verbose output for everything in your cluster, for example via [stern](https://github.com/wercker/stern). For the following steps, you have to have [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/#bash) installed:
347+
348+
```shell
349+
kubectl krew install stern
350+
# View all logs in default namespace:
351+
kubectl stern .*
352+
# View for a specific namespace
353+
kubectl stern .* --namespace scanning
354+
```
355+
356+
- **Re-Installation of DefectDojo:** Note that if anything went wrong, and you have to re-install DefectDojo in the cluster, the _createSecret_ flags in the values.yaml file of DefectDojo must not be set. You can find more details [here](https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/KUBERNETES.md#re-install-the-chart).
357+
358+
- **Server error in DefectDojo:** Make sure that all pods are running. If you are continuing to experience errors after a re-installation, consider using a different cluster manager (e.g., kind instead of minikube).
359+
360+
- **Using a local instance of DefectDojo rather than Kubernetes:** If nothing helps, you still have the option to run DefectDojo outside your cluster (instructions [here](https://github.com/DefectDojo/django-DefectDojo#quick-start)). After that, you can connect the DefectDojo hook treating it like a _remote_ instance of DefectDojo. The helm install command for the hook would look like this:
361+
362+
```shell
363+
# $YOURLOCALIP should look something like http://192.168.2.242:8080
364+
helm upgrade --install persistence-defectdojo secureCodeBox/persistence-defectdojo \
365+
--set="defectdojo.url=$YOURLOCALIP"
366+
```
367+
368+
- **Increasing cluster resources:** Running a lot of pods at the same time can be resource-intensive. If you find that your persistence providers are not reacting in appropriate time, you might want to increase the number of CPUs and memory usage for your minikube cluster:
369+
370+
```shell
371+
# If you already created a cluster, you most likely have to delete it at first
372+
minikube stop
373+
minikube delete
374+
# Create a new cluster with more resources
375+
minikube start --memory 8192 --cpus 4
376+
```
377+
392378
</details>

0 commit comments

Comments
 (0)