diff --git a/README.md b/README.md index 30c329b..aa33259 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Helm charts for the StackRox Kubernetes Security Platform This repository contains Helm charts for the [StackRox Kubernetes Security -Platform](https://www.stackrox.io/) as well as [Red Hat Advanced Cluster Security](https://www.redhat.com/en/technologies/cloud-computing/openshift/advanced-cluster-security-kubernetes) (ACS). StackRox is the Open Source upstream project of ACS. +Platform](https://www.stackrox.io/) as well as [Red Hat Advanced Cluster Security](https://www.redhat.com/en/technologies/cloud-computing/openshift/advanced-cluster-security-kubernetes) (ACS). StackRox is the Open Source upstream project of ACS. To use the StackRox charts, add https://raw.githubusercontent.com/stackrox/helm-charts/main/opensource/ as a repository: @@ -14,15 +14,13 @@ $ helm repo add stackrox https://raw.githubusercontent.com/stackrox/helm-charts/ Afterwards, you can update, download, and install the available charts. For example: - Use the `helm repo update` command to get the latest version of the charts. -- Use the `helm install stackrox/stackrox-central-services` command to install the `central-services` chart. -- Use the `helm pull stackrox/stackrox-secured-cluster-services` command to download the `secured-cluster-services` chart. +- Use the `helm install stackrox/stackrox-operator` command to install the `stackrox-operator` chart. ## Installation -For instructions on how to install the StackRox Kubernetes Security Platform with these Helm charts, -see [Quick Start (Helm)](https://github.com/stackrox/stackrox#quick-installation-via-helm). - +For instructions on how to install the StackRox Kubernetes Security Platform using the operator Helm chart, +see [operator/install](https://github.com/stackrox/stackrox/tree/master/operator/install) in the main repository. To install ACS, follow the [OpenShift docs Helm quick Install Guide](https://docs.openshift.com/acs/installing/installing_helm/install-helm-quick.html). @@ -30,17 +28,30 @@ To install ACS, follow the [OpenShift docs Helm quick Install Guide](https://doc The StackRox Kubernetes Security Platform Helm charts repository includes the following charts: -1. [`central-services`](#central-services-chart) -2. [`secured-cluster-services`](#secured-cluster-services-chart) +1. [`stackrox-operator`](#operator-chart) - installs the StackRox operator (available since 4.11) +2. [`central-services`](#central-services-chart) (deprecated) +3. [`secured-cluster-services`](#secured-cluster-services-chart) (deprecated) + +### Operator chart + +The recommended way to install the StackRox Kubernetes Security Platform via Helm is by using the +`stackrox-operator` chart. This chart installs the StackRox operator, which manages the platform +components via `Central` and `SecuredCluster` custom resources. -### Central services chart +### Central services chart (deprecated) + +> **Deprecated:** The `stackrox-central-services` chart is deprecated and will cease to be updated +> after version 5.1. Use the [`stackrox-operator`](#operator-chart) chart instead. The Helm chart to install StackRox Central is called `stackrox-central-services`. The installation can be customized to your needs. Please consult the documentation at OpenShift docs for detailed configuration options: [Configure the central-services Helm chart](https://docs.openshift.com/acs/installing/installing_helm/install-helm-customization.html#configure-central-services-helm-chart) -### Secured cluster services chart +### Secured cluster services chart (deprecated) + +> **Deprecated:** The `stackrox-secured-cluster-services` chart is deprecated and will cease to be +> updated after version 5.1. Use the [`stackrox-operator`](#operator-chart) chart instead. The chart to install per-cluster and per-node components of StackRox is called `stackrox-secured-cluster-services`.