From 0c7a548f51444efa2bb7ffbf12a6781f6e02d28f Mon Sep 17 00:00:00 2001 From: nscuro Date: Sun, 7 Apr 2024 19:37:44 +0200 Subject: [PATCH] Advertise official Helm chart in docs Signed-off-by: nscuro --- README.md | 15 +-------- docs/_docs/getting-started/configuration.md | 2 +- docs/_docs/getting-started/data-directory.md | 2 +- .../_docs/getting-started/database-support.md | 2 +- docs/_docs/getting-started/deploy-exewar.md | 2 +- .../getting-started/deploy-kubernetes.md | 33 +++++++++++++++++++ docs/_docs/getting-started/initial-startup.md | 2 +- docs/_docs/getting-started/internal-ca.md | 2 +- .../getting-started/ldap-configuration.md | 2 +- docs/_docs/getting-started/monitoring.md | 2 +- .../openidconnect-configuration.md | 2 +- docs/_docs/getting-started/recurring-tasks.md | 2 +- 12 files changed, 44 insertions(+), 24 deletions(-) create mode 100644 docs/_docs/getting-started/deploy-kubernetes.md diff --git a/README.md b/README.md index 86fa53003..ad76dc11c 100644 --- a/README.md +++ b/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 diff --git a/docs/_docs/getting-started/configuration.md b/docs/_docs/getting-started/configuration.md index ddf923462..2df1f8f6d 100644 --- a/docs/_docs/getting-started/configuration.md +++ b/docs/_docs/getting-started/configuration.md @@ -2,7 +2,7 @@ title: Configuration category: Getting Started chapter: 1 -order: 5 +order: 6 --- ### API server diff --git a/docs/_docs/getting-started/data-directory.md b/docs/_docs/getting-started/data-directory.md index 9bc2343a5..3dcaed534 100644 --- a/docs/_docs/getting-started/data-directory.md +++ b/docs/_docs/getting-started/data-directory.md @@ -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 diff --git a/docs/_docs/getting-started/database-support.md b/docs/_docs/getting-started/database-support.md index 0be82cbbc..0b6105340 100644 --- a/docs/_docs/getting-started/database-support.md +++ b/docs/_docs/getting-started/database-support.md @@ -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 diff --git a/docs/_docs/getting-started/deploy-exewar.md b/docs/_docs/getting-started/deploy-exewar.md index e6685072f..4d856fef1 100755 --- a/docs/_docs/getting-started/deploy-exewar.md +++ b/docs/_docs/getting-started/deploy-exewar.md @@ -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 diff --git a/docs/_docs/getting-started/deploy-kubernetes.md b/docs/_docs/getting-started/deploy-kubernetes.md new file mode 100644 index 000000000..9777243b9 --- /dev/null +++ b/docs/_docs/getting-started/deploy-kubernetes.md @@ -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 \ No newline at end of file diff --git a/docs/_docs/getting-started/initial-startup.md b/docs/_docs/getting-started/initial-startup.md index b87f975d8..692b90b8e 100644 --- a/docs/_docs/getting-started/initial-startup.md +++ b/docs/_docs/getting-started/initial-startup.md @@ -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: diff --git a/docs/_docs/getting-started/internal-ca.md b/docs/_docs/getting-started/internal-ca.md index 698a0e682..008a7435f 100644 --- a/docs/_docs/getting-started/internal-ca.md +++ b/docs/_docs/getting-started/internal-ca.md @@ -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 diff --git a/docs/_docs/getting-started/ldap-configuration.md b/docs/_docs/getting-started/ldap-configuration.md index 1c50ed2dd..860644f8d 100644 --- a/docs/_docs/getting-started/ldap-configuration.md +++ b/docs/_docs/getting-started/ldap-configuration.md @@ -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 diff --git a/docs/_docs/getting-started/monitoring.md b/docs/_docs/getting-started/monitoring.md index fdea44c1d..7e41fa6cf 100644 --- a/docs/_docs/getting-started/monitoring.md +++ b/docs/_docs/getting-started/monitoring.md @@ -2,7 +2,7 @@ title: Monitoring category: Getting Started chapter: 1 -order: 12 +order: 13 --- diff --git a/docs/_docs/getting-started/openidconnect-configuration.md b/docs/_docs/getting-started/openidconnect-configuration.md index 7bebbb0d6..2f11148fa 100644 --- a/docs/_docs/getting-started/openidconnect-configuration.md +++ b/docs/_docs/getting-started/openidconnect-configuration.md @@ -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 diff --git a/docs/_docs/getting-started/recurring-tasks.md b/docs/_docs/getting-started/recurring-tasks.md index 7dd7c619c..50bdfb3e4 100644 --- a/docs/_docs/getting-started/recurring-tasks.md +++ b/docs/_docs/getting-started/recurring-tasks.md @@ -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,