mirror of
https://github.com/DependencyTrack/dependency-track.git
synced 2025-10-19 07:53:18 +00:00
Advertise official Helm chart in docs
Signed-off-by: nscuro <nscuro@protonmail.com>
This commit is contained in:
nscuro
parent
757a9664d6
commit
0c7a548f51
12 changed files with 44 additions and 24 deletions
15
README.md
15
README.md
|
|
@ -171,21 +171,8 @@ The Traditional variant combines the API Server and the Frontend user interface
|
|||
container. This variant is not supported, deprecated, and will be discontinued in a future release.
|
||||
|
||||
## Deploying on Kubernetes with Helm
|
||||
You can install on Kubernetes using the [community-maintained chart](https://github.com/evryfs/helm-charts/tree/master/charts/dependency-track) like this:
|
||||
|
||||
Helm v3:
|
||||
```shell
|
||||
helm repo add evryfs-oss https://evryfs.github.io/helm-charts/
|
||||
helm install dependency-track evryfs-oss/dependency-track --namespace dependency-track --create-namespace
|
||||
```
|
||||
|
||||
Helm v2:
|
||||
```shell
|
||||
helm repo add evryfs-oss https://evryfs.github.io/helm-charts/
|
||||
helm install evryfs-oss/dependency-track --name dependency-track --namespace dependency-track --create-namespace
|
||||
```
|
||||
|
||||
by default, it will install PostgreSQL and use persistent volume claims for the data-directory used for vulnerability feeds.
|
||||
Refer to https://github.com/DependencyTrack/helm-charts.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Configuration
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 5
|
||||
order: 6
|
||||
---
|
||||
|
||||
### API server
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Data Directory
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 7
|
||||
order: 8
|
||||
---
|
||||
|
||||
Dependency-Track uses `~/.dependency-track` on UNIX/Linux systems and `.dependency-track` in the current users
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Database Support
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 6
|
||||
order: 7
|
||||
---
|
||||
|
||||
Dependency-Track includes an embedded H2 database enabled by default. The intended purpose of this
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Deploying the Executable WAR
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 2
|
||||
order: 3
|
||||
---
|
||||
|
||||
An executable WAR is a traditional Java Web Archive (WAR) that is packaged in a way where it can executed from
|
||||
|
|
|
|||
33
docs/_docs/getting-started/deploy-kubernetes.md
Normal file
33
docs/_docs/getting-started/deploy-kubernetes.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: Deploying on Kubernetes
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 2
|
||||
---
|
||||
|
||||
Kubernetes deployment is supported via [Helm]. Charts are maintained in the [helm-charts] repository.
|
||||
|
||||
To add the Helm repository:
|
||||
|
||||
```shell
|
||||
helm repo add dependency-track https://dependencytrack.github.io/helm-charts
|
||||
```
|
||||
|
||||
The following will deploy Dependency-Track as [release](https://helm.sh/docs/intro/cheatsheet/) `dtrack`
|
||||
into the `dtrack` namespace, creating the namespace if it doesn't exist already:
|
||||
|
||||
```shell
|
||||
helm install dtrack dependency-track/dependency-track \
|
||||
--namespace dtrack --create-namespace
|
||||
```
|
||||
|
||||
For more details, such as available configuration options, please refer to [the chart's documentation].
|
||||
|
||||
Note that the chart does not include an external database such as PostgreSQL,
|
||||
and instead defaults to an embedded H2 database. H2 is not intended for production
|
||||
usage, please refer to the [database support] page for further information.
|
||||
|
||||
[the chart's documentation]: https://github.com/DependencyTrack/helm-charts/tree/main/charts/dependency-track
|
||||
[database support]: {{ site.baseurl }}{% link _docs/getting-started/database-support.md %}
|
||||
[Helm]: https://helm.sh/
|
||||
[helm-charts]: https://github.com/DependencyTrack/helm-charts
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: Initial Startup
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 4
|
||||
order: 5
|
||||
---
|
||||
|
||||
Upon starting Dependency-Track for the first time, multiple tasks occur including:
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Internal Certificate Authorities
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 11
|
||||
order: 12
|
||||
---
|
||||
|
||||
Many organizations use their own [certificate authority](https://en.wikipedia.org/wiki/Certificate_authority) (CA) to
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: LDAP Configuration
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 9
|
||||
order: 10
|
||||
---
|
||||
|
||||
Dependency-Track has been tested with multiple LDAP servers. The following are
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Monitoring
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 12
|
||||
order: 13
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: OpenID Connect Configuration
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 10
|
||||
order: 11
|
||||
---
|
||||
|
||||
> OpenID Connect is supported in Dependency-Track 4.0.0 and above
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Recurring Tasks
|
||||
category: Getting Started
|
||||
chapter: 1
|
||||
order: 8
|
||||
order: 9
|
||||
---
|
||||
|
||||
Dependency-Track heavily relies on asynchronous recurring tasks to perform various forms of analyses, calculations,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue