Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cloud_service/getting-started-rhacs-cloud-ocp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ You can secure {osp} clusters by using the {product-title-short} Operator, Helm
* Log in to Central and use the `roxctl` CLI to xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#crs-generate-roxctl_init-bundle-cloud-ocp-generate[generate a CRS].
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply.adoc#init-bundle-cloud-ocp-apply[apply the CRS].
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/cloud-install-operator.adoc#cloud-install-operator[install the {product-title-short} Operator].
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-operator-cloud-ocp[install secured cluster resources in the `stackrox` project] by using the Operator.
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-operator-cloud-ocp_install-secured-cluster-cloud-ocp[install secured cluster resources in the `stackrox` project] by using the Operator.
. xref:../cloud_service/installing_cloud_ocp/verify-installation-cloud-ocp.adoc#verify-installation-cloud-ocp[Verify installation] by ensuring that your secured clusters can communicate with the ACS instance.

[id="overview-installing-cloud-secured-clusters-osp-helm"]
Expand All @@ -56,7 +56,7 @@ You can secure {osp} clusters by using the {product-title-short} Operator, Helm
. Generate a cluster registration secret (CRS) or an init bundle, which contains secrets that are used to establish initial trust between Central and the secured clusters. Using a CRS is the preferred method. Complete only one of the following actions to generate the CRS:
* In the ACS Console, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#portal-generate-init-bundle_init-bundle-cloud-ocp-generate[generate a CRS]. This file contains the secrets that are used to set up the initial secured communication between {product-title-managed-short} secured clusters and Central.
* Log in to Central and use the `roxctl` CLI to xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#crs-generate-roxctl_init-bundle-cloud-ocp-generate[generate a CRS].
. On each {osp} cluster, run the `helm install` command to xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp[install {product-title-short} by using Helm charts], specifying the path of the CRS.
. On each {osp} cluster, run the `helm install` command to xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp_install-secured-cluster-cloud-ocp[install {product-title-short} by using Helm charts], specifying the path of the CRS.
. xref:../cloud_service/installing_cloud_ocp/verify-installation-cloud-ocp.adoc#verify-installation-cloud-ocp[Verify installation] by ensuring that your secured clusters can communicate with the ACS instance.

[id="overview-installing-cloud-secured-clusters-osp-roxctl"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,88 +9,64 @@ toc::[]
[role="_abstract"]
You can install {product-title-managed-short} on your secured clusters by using the Operator or Helm charts. You can also use the `roxctl` CLI to install it, but do not use this method unless you have a specific installation need that requires using it.

.Prerequisites
//Prerequisites
include::modules/install-secured-cluster-cloud-ocp-prerequisites.adoc[leveloffset=+1]

* During {product-title-short} installation, you noted the *Central instance* address. You can view this information by choosing *Advanced Cluster Security* -> *ACS Instances* from the cloud console navigation menu, and then clicking the ACS instance you created.
* If you are installing by using the Operator, you created your {osp} cluster that you want to secure and installed the Operator on it.
* You generated and downloaded the cluster registration secret (CRS) or the init bundle by using the ACS Console or by using the `roxctl` CLI.
* You applied the CRS or the init bundle on the cluster that you want to secure, unless you are installing by using a Helm chart.


[id="installing-sc-operator-cloud-ocp"]
== Installing {product-title-short} on secured clusters by using the Operator

To install {product-title-short} by using the Operator, you first install the Operator and then use it to install {product-title-short} on the secured cluster.
//Installing {product-title-short} on secured clusters by using the Operator
include::modules/installing-sc-operator-cloud-ocp.adoc[leveloffset=+1]

include::modules/install-acs-operator-annotations.adoc[leveloffset=+2]

include::modules/install-secured-cluster-operator.adoc[leveloffset=+2]

[id="installing-sc-helm-cloud-ocp"]
== Installing {product-title-managed-short} on secured clusters by using Helm charts

You can install {product-title-short} on secured clusters by using Helm charts with no customization, using the default values, or with customizations of configuration parameters.

First, ensure that you add the Helm chart repository.
//Installing {product-title-managed-short} on secured clusters by using Helm charts
include::modules/installing-sc-helm-cloud-ocp.adoc[leveloffset=+1]

include::modules/adding-helm-repository.adoc[leveloffset=+2]

[id="installing-sc-helm-default-cloud-ocp"]
=== Installing {product-title-managed-short} on secured clusters by using Helm charts without customizations
//Installing {product-title-managed-short} on secured clusters by using Helm charts without customizations
include::modules/installing-sc-helm-default-cloud-ocp.adoc[leveloffset=+2]

include::modules/acs-quick-install-secured-cluster-using-helm.adoc[leveloffset=+3]

[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/RegistryAuthentication[Red{nbsp}Hat Container Registry Authentication]
* xref:../../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[Generating a cluster registration secret or an init bundle for secured clusters]
* xref:../../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply.adoc#init-bundle-cloud-ocp-apply[Applying a cluster registration secret or an init bundle for secured clusters]

[id="configure-secured-cluster-services-helm-chart-customizations-cloud-ocp"]
=== Configuring the secured-cluster-services Helm chart with customizations

You can use Helm chart configuration parameters with the `helm install` and `helm upgrade` commands.
Specify these parameters by using the `--set` option or by creating YAML configuration files.

Create the following files for configuring the Helm chart for installing {product-title}:

* Public configuration file `values-public.yaml`: Use this file to save all non-sensitive configuration options.
* Private configuration file `values-private.yaml`: Use this file to save all sensitive configuration options. Ensure that you store this file securely.

[IMPORTANT]
====
When using the `secured-cluster-services` Helm chart, do not change the `values.yaml` file that is part of the chart.
====
//Configuring the secured-cluster-services Helm chart with customizations
include::modules/configure-sc-helm-customizations-cloud-ocp.adoc[leveloffset=+2]

include::modules/secured-cluster-services-config.adoc[leveloffset=+3]

include::modules/install-secured-cluster-services-helm-chart.adoc[leveloffset=+3]

[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/RegistryAuthentication[Red{nbsp}Hat Container Registry Authentication]
* xref:../../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[Generating a cluster registration secret or an init bundle for secured clusters]
* xref:../../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply.adoc#init-bundle-cloud-ocp-apply[Applying a cluster registration secret or an init bundle for secured clusters]

include::modules/change-config-options-after-deployment.adoc[leveloffset=+2]

[id="installing-sc-roxctl-cloud-ocp"]
== Installing {product-title-short} on secured clusters by using the roxctl CLI

To install {product-title-short} on secured clusters by using the CLI, perform the following steps:

. Install the `roxctl` CLI.
. Install Sensor.
//Installing {product-title-short} on secured clusters by using the roxctl CLI
include::modules/installing-sc-roxctl-cloud-ocp.adoc[leveloffset=+1]

[id="installing-roxctl-cli-sc-cloud-ocp"]
=== Installing the roxctl CLI
//Installing the roxctl CLI
include::modules/installing-roxctl-cli-sc-cloud-ocp.adoc[leveloffset=+2]

You must first download the binary. You can install `roxctl` on Linux, Windows, or macOS.

// Installing the CLI by downloading the binary
include::modules/install-roxctl-cli-linux.adoc[leveloffset=+3]

include::modules/install-roxctl-cli-macos.adoc[leveloffset=+3]

include::modules/install-roxctl-cli-windows.adoc[leveloffset=+3]

include::modules/install-sensor-roxctl.adoc[leveloffset=+2]

[id="next-steps_install-secured-cluster-cloud-ocp"]
== Next steps
//Next steps
include::modules/install-secured-cluster-cloud-ocp-next-steps.adoc[leveloffset=+1]

* xref:../installing_cloud_ocp/verify-installation-cloud-ocp.adoc#verify-installation-cloud-ocp[Verify installation] by ensuring that your secured clusters can communicate with the ACS instance.
[role="_additional-resources"]
.Additional resources
* xref:../installing_cloud_ocp/verify-installation-cloud-ocp.adoc#verify-installation-cloud-ocp[Verify installation]
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To verify installation, access your ACS Console from the {cloud-console}. The Da

If no data appears in the ACS Console:

* Ensure that at least one secured cluster is connected to your {product-title-managed-short} instance. For more information, see xref:../installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-operator-cloud-ocp[Installing secured cluster resources from {product-title-managed-short}].
* Ensure that at least one secured cluster is connected to your {product-title-managed-short} instance. For more information, see xref:../installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-operator-cloud-ocp_install-secured-cluster-cloud-ocp[Installing secured cluster resources from {product-title-managed-short}].
* Examine your Sensor pod logs to ensure that the connection to your {product-title-managed-short} instance is successful.
* In the {osp} cluster, go to *Platform Configuration* -> *Clusters* to verify that the components are healthy and view additional operational information.
* Examine the values in the `SecuredCluster` API in the Operator on your local cluster to ensure that the *Central API Endpoint* has been entered correctly. This value should be the same value as shown in the *ACS instance* details in the {cloud-console}.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ To verify installation, access your ACS Console from the {cloud-console}. The Da

If no data appears in the ACS Console:

* Ensure that at least one secured cluster is connected to your {product-title-managed-short} instance. For more information, see instructions for installing by using xref:../installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp[Helm charts] or by using the xref:../installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-roxctl-cloud-ocp[`roxctl` CLI].
* Ensure that at least one secured cluster is connected to your {product-title-managed-short} instance. For more information, see instructions for installing by using xref:../installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp_install-secured-cluster-cloud-ocp[Helm charts] or by using the xref:../installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-roxctl-cloud-ocp_install-secured-cluster-cloud-ocp[`roxctl` CLI].
* Examine your Sensor pod logs to ensure that the connection to your {product-title-managed-short} instance is successful.
* Examine the values in the `SecuredCluster` API in the Operator on your local cluster to ensure that the *Central API Endpoint* has been entered correctly. This value should be the same value as shown in the *ACS instance* details in the {cloud-console}.
2 changes: 1 addition & 1 deletion cloud_service/upgrading-cloud/upgrade-cloudsvc-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ include::modules/upgrade-helm-chart.adoc[leveloffset=+1]

[role="_additional-resources"]
== Additional resources
* xref:../../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp[Installing {product-title-managed-short} on secured clusters by using Helm charts]
* xref:../../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp_install-secured-cluster-cloud-ocp[Installing {product-title-managed-short} on secured clusters by using Helm charts]
18 changes: 9 additions & 9 deletions modules/acs-quick-install-secured-cluster-using-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Use the following instructions to install the `secured-cluster-services` Helm ch

.Prerequisites
* You must have generated a {product-title-short} cluster registration secret (CRS) or an init bundle for your cluster.
* You must have access to the Red{nbsp}Hat Container Registry and a pull secret for authentication. For information about downloading images from `registry.redhat.io`, see link:https://access.redhat.com/RegistryAuthentication[Red{nbsp}Hat Container Registry Authentication].
* You must have access to the Red{nbsp}Hat Container Registry and a pull secret for authentication. For information about downloading images from `registry.redhat.io`, see the "Red{nbsp}Hat Container Registry Authentication".
ifndef::cloud-svc[]
* You must have the address that you are exposing the Central service on.
endif::cloud-svc[]
Expand Down Expand Up @@ -57,7 +57,7 @@ $ helm install -n stackrox --create-namespace \
where:
+
--
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS has been stored.
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS stores.
`<path_to_pull_secret.yaml>`:: Specifies the path for the pull secret for Red{nbsp}Hat Container Registry authentication. Or, you can specify `--set imagePullSecrets.username=<your redhat.com username>` and `--set imagePullSecrets.password=<your redhat.com password>` in the command.
`<endpoint_of_central_service>`:: Specifies the address and port number for Central. For example, `acs.domain.com:443`.
--
Expand Down Expand Up @@ -100,7 +100,7 @@ $ helm install -n stackrox --create-namespace \
where:
+
--
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS has been stored.
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS stores.
`<path_to_pull_secret.yaml>`:: Specifies the path for the pull secret for Red{nbsp}Hat Container Registry authentication. Or, you can specify `--set imagePullSecrets.username=<your redhat.com username>` and `--set imagePullSecrets.password=<your redhat.com password>` in the command.
`<endpoint_of_central_service>`:: Specifies the address and port number for Central. For example, `acs.domain.com:443`.
`<your redhat.com username>`:: Specifies the user name for your pull secret for Red{nbsp}Hat Container Registry authentication.
Expand Down Expand Up @@ -150,10 +150,10 @@ $ helm install -n stackrox --create-namespace \
where:
+
--
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS has been stored.
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS stores.
`<path_to_pull_secret.yaml>`:: Specifies the path for the pull secret for Red{nbsp}Hat Container Registry authentication. Or, you can specify `--set imagePullSecrets.username=<your redhat.com username>` and `--set imagePullSecrets.password=<your redhat.com password>` in the command.
`<endpoint_of_central_service>`:: Specifies specify the address and port number for Central. For example, `acs.domain.com:443`.
`--set scanner.disable=false`:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will be enabled during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
`--set scanner.disable=false`:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will enable during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
--
** If you are using an init bundle, run the following command:
+
Expand All @@ -174,7 +174,7 @@ where:
`<path_to_cluster_init_bundle.yaml>`:: Specifies the path for the init bundle.
`<path_to_pull_secret.yaml>`:: Specifies the path for the pull secret for Red{nbsp}Hat Container Registry authentication.
`<endpoint_of_central_service>`:: Specifies the address and port number for Central. For example, `acs.domain.com:443`.
`--set scanner.disable=false`:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will be enabled during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
`--set scanner.disable=false`:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will enable during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
--
endif::cloud-svc[]

Expand All @@ -198,10 +198,10 @@ $ helm install -n stackrox --create-namespace \
where:
+
--
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS has been stored.
`<crs_file_name.yaml>`:: Specifies the name of the file in which the generated CRS stores.
`<path_to_pull_secret.yaml>`:: Specifies the path for the pull secret for Red{nbsp}Hat Container Registry authentication.
`<endpoint_of_central_service>`:: Specifies the *Central API Endpoint* address. You can view this information by choosing *Advanced Cluster Security* -> *ACS Instances* from the Red{nbsp}Hat Hybrid Cloud Console navigation menu, then clicking the {product-title-short} instance you created.
`--set scanner.disable=false`:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will be enabled during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
`--set scanner.disable=false`:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will enable during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
--
** If you are using an init bundle, run the following command:
+
Expand All @@ -222,6 +222,6 @@ where:
`<path_to_cluster_init_bundle.yaml>`:: Specifies the path for the init bundle.
`<path_to_pull_secret.yaml>`:: Specifies the path for the pull secret for Red{nbsp}Hat Container Registry authentication.
`<endpoint_of_central_service>`:: Specifies the *Central API Endpoint* address. You can view this information by choosing *Advanced Cluster Security* -> *ACS Instances* from the Red{nbsp}Hat Hybrid Cloud Console navigation menu, then clicking the {product-title-short} instance you created.
`--set` scanner.disable=false:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will be enabled during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
`--set` scanner.disable=false:: Sets the value of the `scanner.disable` parameter to `false`, which means that Scanner-slim will enable during the installation. In Kubernetes, the secured cluster services now include Scanner-slim.
--
endif::cloud-svc[]
2 changes: 1 addition & 1 deletion modules/adding-helm-repository.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ ifndef::cloud-svc[]
+
[NOTE]
====
You deploy centralized components only once and you can monitor multiple separate clusters by using the same installation.
You deploy centralized components only once and you can monitor many separate clusters by using the same installation.
====
endif::[]
* Secured Cluster Services Helm chart (`secured-cluster-services`) for installing the per-cluster and per-node components (Sensor, Admission Controller, Collector, and Scanner-slim).
Expand Down
Loading