diff --git a/docs/guides/administration/.pages b/docs/guides/administration/.pages index e7b5ca4..59ed98f 100644 --- a/docs/guides/administration/.pages +++ b/docs/guides/administration/.pages @@ -2,6 +2,7 @@ title: Administration guides nav: - index.md - deploying-to-production.md + - deploying-to-kubernetes.md - scaling.md - configuring-database.md - configuring-secret-management.md diff --git a/docs/guides/administration/deploying-to-kubernetes.md b/docs/guides/administration/deploying-to-kubernetes.md new file mode 100644 index 0000000..6384948 --- /dev/null +++ b/docs/guides/administration/deploying-to-kubernetes.md @@ -0,0 +1,18 @@ +# Deploying to Kubernetes + +The community maintains Helm charts for running Dependency-Track on Kubernetes at the +[helm-charts repository](https://github.com/DependencyTrack/helm-charts). The sizing, database, and +operational guidance in [Deploying to production](deploying-to-production.md) applies regardless of +platform, and you should read it alongside the chart documentation. + +!!! warning "v5 Helm chart not yet available" + The `dependency-track` chart is not yet compatible with v5. As a safety mechanism against silent + misconfiguration, the chart fails during rendering when it detects a v5 image tag. A v5-compatible + release is in progress and ships soon. Until then, you can either wait for the chart, or roll your + own manifests based on the v5 container images. + +!!! warning "The `hyades` chart goes away soon" + A separate `hyades` chart exists from the period when the project developed v5 under the Hyades + name. The maintainers archive it once the v5-compatible `dependency-track` chart ships. New users + should not adopt it. If you already run the `hyades` chart, plan to migrate to the + `dependency-track` chart once it becomes available. diff --git a/docs/guides/administration/deploying-to-production.md b/docs/guides/administration/deploying-to-production.md index 12bd177..a3df012 100644 --- a/docs/guides/administration/deploying-to-production.md +++ b/docs/guides/administration/deploying-to-production.md @@ -3,7 +3,8 @@ This guide covers the baseline posture for running Dependency-Track against real workloads. For an overview of how the components fit together, see [Deployment topology](../../concepts/architecture/deployment.md). For tuning a deployment under load, see -[Scaling](scaling.md). +[Scaling](scaling.md). For Kubernetes-specific guidance, see +[Deploying to Kubernetes](deploying-to-kubernetes.md). ## Provision compute and database