Skip to content

Commit bcc9ad2

Browse files
Merge pull request #90340 from openshift-cherrypick-robot/cherry-pick-89252-to-rhacs-docs-4.7
[rhacs-docs-4.7] ROX:26971: Add CRS to ACS docs
2 parents c8841dd + 2131590 commit bcc9ad2

36 files changed

+742
-121
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Topics:
6060
File: cloud-create-instance-ocp
6161
- Name: Creating a project on your Red Hat OpenShift secured cluster
6262
File: cloud-ocp-create-project
63-
- Name: Generating an init bundle for secured clusters
63+
- Name: Generating an init bundle or cluster registration secret for secured clusters
6464
File: init-bundle-cloud-ocp-generate
65-
- Name: Applying an init bundle for secured clusters
65+
- Name: Applying an init bundle or cluster registration secret for secured clusters
6666
File: init-bundle-cloud-ocp-apply
6767
- Name: Installing the RHACS Operator for RHACS Cloud Service
6868
File: cloud-install-operator
@@ -125,7 +125,7 @@ Topics:
125125
File: install-central-ocp
126126
- Name: Configuring Central configuration options for RHACS using the Operator
127127
File: install-central-config-options-ocp
128-
- Name: Generating and applying an init bundle for RHACS on Red Hat OpenShift
128+
- Name: Generating and applying an init bundle or cluster registration secret for RHACS on Red Hat OpenShift
129129
File: init-bundle-ocp
130130
- Name: Installing Secured Cluster services for RHACS on Red Hat OpenShift
131131
File: install-secured-cluster-ocp
@@ -141,7 +141,7 @@ Topics:
141141
File: install-rhacs-other
142142
- Name: Installing Central services for RHACS on other platforms
143143
File: install-central-other
144-
- Name: Generating and applying an init bundle for RHACS on other platforms
144+
- Name: Generating and applying an init bundle or cluster registration secret for RHACS on other platforms
145145
File: init-bundle-other
146146
- Name: Installing Secured Cluster services for RHACS on other platforms
147147
File: install-secured-cluster-other

cli/command-reference/roxctl-central.adoc

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,29 @@ $ roxctl central [command] [flags]
2424

2525
|`cert`
2626
|Download the certificate chain for the Central service.
27-
28-
|`db`
27+
28+
|`crs`
29+
|Generate a cluster registration secret (CRS) that allows communication between Central and secured clusters for the initial setup, to retrieve a list of CRSes, or to revoke a CRS.
30+
31+
|`db`
2932
|Control the database operations.
30-
31-
|`debug`
33+
34+
|`debug`
3235
|Debug the Central service.
3336

3437
|`generate`
3538
|Generate the required YAML configuration files containing the orchestrator objects for the deployment of Central.
36-
37-
|`init-bundles`
39+
40+
|`init-bundles`
3841
|Initialize bundles for Central.
39-
42+
4043
|`login`
4144
|Log in to the Central instance to obtain a token.
42-
43-
|`userpki`
45+
46+
|`userpki`
4447
|Manage the user certificate authorization providers.
45-
46-
|`whoami`
48+
49+
|`whoami`
4750
|Display information about the current user and their authentication method.
4851
|===
4952

@@ -59,6 +62,12 @@ include::modules/roxctl-central-backup.adoc[leveloffset=+1]
5962
//roxctl central cert
6063
include::modules/roxctl-central-cert.adoc[leveloffset=+1]
6164

65+
//roxctl crs
66+
include::modules/roxctl-central-crs.adoc[leveloffset=+1]
67+
include::modules/roxctl-central-crs-generate.adoc[leveloffset=+2]
68+
include::modules/roxctl-central-crs-list.adoc[leveloffset=+2]
69+
include::modules/roxctl-central-crs-revoke.adoc[leveloffset=+2]
70+
6271
//roxctl central login
6372
include::modules/roxctl-central-login.adoc[leveloffset=+1]
6473

cloud_service/getting-started-rhacs-cloud-ocp.adoc

Lines changed: 58 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc::[]
88

99
[role="_abstract"]
1010

11-
{rh-rhacscs-first} provides security services for your {osp} and Kubernetes clusters. See the link:https://access.redhat.com/articles/7045053[Red{nbsp}Hat Advanced Cluster Security for Kubernetes Support Matrix] for more information on supported platforms for secured clusters.
11+
{rh-rhacscs-first} provides security services for your {osp} and Kubernetes clusters. See the link:https://access.redhat.com/articles/7045053[Red{nbsp}Hat Advanced Cluster Security for Kubernetes Support Matrix] for information about supported platforms for secured clusters.
1212

1313
.Prerequisites
1414

@@ -27,39 +27,82 @@ The following sections provide an overview of installation steps and links to th
2727
[id="securing-rh-cloud-clusters"]
2828
=== Securing {osp} clusters
2929

30-
To secure {osp} clusters by using the Operator, perform the following steps:
30+
You can secure {osp} clusters by using the {product-title-short} Operator, Helm charts, or the `roxctl` CLI.
3131

32-
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[requirements].
32+
[id="overview-installing-cloud-secured-clusters-osp-operator"]
33+
==== Securing {osp} clusters by using the Operator
34+
35+
.Procedure
36+
37+
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[default requirements].
3338
. In the {cloud-console}, xref:../cloud_service/installing_cloud_ocp/cloud-create-instance-ocp.adoc#cloud-create-instance-ocp[create an *ACS Instance*].
3439
. On each {osp} cluster you want to secure, xref:../cloud_service/installing_cloud_ocp/cloud-ocp-create-project.adoc#cloud-ocp-create-project[create a project named `stackrox`]. This project will contain the resources for {product-title-managed-short} secured clusters.
35-
. In the ACS Console, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[create an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and the ACS Console.
36-
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply#init-bundle-cloud-ocp-apply[apply the init bundle] by using it to create resources.
40+
. Create the mechanism that the Central instance, also called Central, uses to set up communication with the secured clusters. You can either create an init bundle or a cluster registration secret (CRS). Perform one of these actions:
41+
* In the ACS Console, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[generate an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and Central.
42+
* Log in to Central and use the `roxctl` CLI to xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#roxctl-generate-init-bundle_init-bundle-cloud-ocp-generate[generate an init bundle].
43+
* 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].
44+
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply#init-bundle-cloud-ocp-apply[apply the init bundle or CRS].
3745
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/cloud-install-operator#cloud-install-operator[install the {product-title-short} Operator].
3846
. 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.
3947
. 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.
4048

41-
To secure {osp} clusters by using Helm charts or the `roxctl` CLI, perform the following steps:
49+
[id="overview-installing-cloud-secured-clusters-osp-helm"]
50+
==== Securing {osp} clusters by using Helm charts
4251

43-
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[requirements].
52+
.Procedure
53+
54+
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[default requirements].
4455
. In the {cloud-console}, xref:../cloud_service/installing_cloud_ocp/cloud-create-instance-ocp.adoc#cloud-create-instance-ocp[create an *ACS Instance*].
4556
. On each {osp} cluster you want to secure, xref:../cloud_service/installing_cloud_ocp/cloud-ocp-create-project.adoc#cloud-ocp-create-project[create a project named `stackrox`]. This project will contain the resources for {product-title-managed-short} secured clusters.
46-
. In the ACS Console, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[create an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and the ACS Console.
47-
. On each {osp} cluster, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply#init-bundle-cloud-ocp-apply[apply the init bundle] by using it to create resources.
48-
. On each {osp} cluster, install secured cluster resources in the `stackrox` project by using xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-helm-cloud-ocp[Helm charts] or by using the xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-sc-roxctl-cloud-ocp[`roxctl` CLI].
57+
. Create the mechanism that the Central instance, also called Central, uses to set up communication with the secured clusters. You can either generate an init bundle or a cluster registration secret (CRS). Perform only one of these actions:
58+
* In the ACS Console, xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[generate an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and Central.
59+
* Log in to Central and use the `roxctl` CLI to xref:../cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#roxctl-generate-init-bundle_init-bundle-cloud-ocp-generate[generate an init bundle].
60+
* 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].
61+
. 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 init bundle or CRS.
62+
. 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.
63+
64+
[id="overview-installing-cloud-secured-clusters-osp-roxctl"]
65+
==== Securing {osp} clusters by using the roxctl CLI, also called the manifest method
66+
67+
.Procedure
68+
69+
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[default requirements].
70+
. In the {cloud-console}, xref:../cloud_service/installing_cloud_ocp/cloud-create-instance-ocp.adoc#cloud-create-instance-ocp[create an *ACS Instance*].
71+
. On each {osp} cluster you want to secure, xref:../cloud_service/installing_cloud_ocp/cloud-ocp-create-project.adoc#cloud-ocp-create-project[create a project named `stackrox`]. This project will contain the resources for {product-title-managed-short} secured clusters.
72+
. Perform one of the following actions:
73+
* In the ACS console, use the xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#installing-manifest-web-portal_install-secured-cluster-cloud-ocp[legacy installation method] to create a cluster bundle.
74+
* From a system that has access to the monitored cluster, xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#manifest-roxctl_install-secured-cluster-cloud-ocp[generate the configuration and extract and run the sensor script from the cluster bundle].
4975
. 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.
5076

5177
[id="securing-kubernetes-clusters"]
5278
=== Securing Kubernetes clusters
5379

54-
To secure Kubernetes clusters, perform the following steps:
80+
You can secure Kubernetes clusters by using Helm charts or the `roxctl` CLI.
81+
82+
[id="overview-installing-cloud-secured-clusters-kube-helm"]
83+
==== Securing Kubernetes clusters by using Helm charts
5584

56-
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[requirements].
85+
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[default requirements].
5786
. In the {cloud-console}, xref:../cloud_service/installing_cloud_other/cloud-create-instance-other.adoc#cloud-create-instance-other[create an *ACS Instance*].
58-
. In the ACS Console, xref:../cloud_service/installing_cloud_other/init-bundle-cloud-other-generate.adoc#init-bundle-cloud-other-generate[create an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and the ACS Console.
59-
. On each Kubernetes cluster, xref:../cloud_service/installing_cloud_other/init-bundle-cloud-other-apply.adoc#init-bundle-cloud-other-apply[apply the init bundle] by using it to create resources.
60-
. On each Kubernetes cluster, xref:../cloud_service/installing_cloud_other/install-secured-cluster-cloud-other.adoc#install-secured-cluster-cloud-other[install secured cluster resources] by using Helm charts or the `roxctl` CLI.
87+
. Create the mechanism that the Central instance, also called Central, uses to set up communication with the secured clusters. You can either create an init bundle or a cluster registration secret (CRS). Perform only one of these actions:
88+
* In the ACS Console, xref:../cloud_service/installing_cloud_other/init-bundle-cloud-other-generate.adoc#portal-generate-init-bundle_init-bundle-cloud-other-generate[generate an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and Central.
89+
* Log in to Central and xref:../cloud_service/installing_cloud_other/init-bundle-cloud-other-generate#roxctl-generate-init-bundle_init-bundle-cloud-other-generate[use the `roxctl` CLI to generate an init bundle].
90+
* Log in to Central and use the `roxctl` CLI to xref:../cloud_service/installing_cloud_other/init-bundle-cloud-other-generate#crs-generate-roxctl_init-bundle-cloud-other-generate[generate a CRS].
91+
. On each Kubernetes cluster, run the `helm install` command to xref:../cloud_service/installing_cloud_other/install-secured-cluster-cloud-other.adoc#install-secured-cluster-cloud-other[install by using Helm charts], specifying the path of the init bundle or CRS.
6192
. xref:../cloud_service/installing_cloud_other/verify-installation-cloud-other.adoc#verify-installation-cloud-other[Verify installation] by ensuring that your secured clusters can communicate with the ACS instance.
6293

94+
[id="overview-installing-cloud-secured-clusters-kube-roxctl"]
95+
==== Securing Kubernetes clusters by using the roxctl CLI, also called the manifest method
96+
97+
. Verify that the clusters you want to secure meet the xref:../cloud_service/acscs-default-requirements.adoc#acscs-default-requirements[default requirements].
98+
. In the {cloud-console}, xref:../cloud_service/installing_cloud_other/cloud-create-instance-other.adoc#cloud-create-instance-other[create an *ACS Instance*].
99+
. On each cluster you want to secure, create a namespace named `stackrox`. This namespace will contain the resources for {product-title-managed-short} secured clusters.
100+
. Perform one of the following steps:
101+
* In the ACS console, use the xref:../cloud_service/installing_cloud_other/install-secured-cluster-cloud-other.adoc#installing-manifest-web-portal_install-secured-cluster-cloud-other[legacy installation method] to create a cluster bundle.
102+
* From a system that has access to the monitored cluster, xref:../cloud_service/installing_cloud_ocp/install-secured-cluster-cloud-ocp.adoc#manifest-roxctl_install-secured-cluster-cloud-ocp[generate the configuration and extract and run the sensor script from the cluster bundle].
103+
. 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.
104+
105+
63106
[id="default-access-acs-console"]
64107
== Default access to the ACS Console
65108

cloud_service/installing_cloud_ocp/cloud-ocp-create-project.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ include::modules/cloud-ocp-create-stackrox-project.adoc[leveloffset=+1]
1414
[id="next-steps_cloud-ocp-create-project"]
1515
== Next steps
1616

17-
* In the ACS Console, xref:../installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[create an init bundle]. The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and the ACS Console.
17+
* In the ACS Console, xref:../installing_cloud_ocp/init-bundle-cloud-ocp-generate.adoc#init-bundle-cloud-ocp-generate[create an init bundle] or cluster registration secret (CRS). The init bundle contains secrets that allow communication between {product-title-managed-short} secured clusters and Central. The CRS can also be used to set up this initial communication and is more flexible and secure.

cloud_service/installing_cloud_ocp/init-bundle-cloud-ocp-apply.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="init-bundle-cloud-ocp-apply"]
3-
= Applying an init bundle for secured clusters
3+
= Applying an init bundle or cluster registration secret for secured clusters
44
include::modules/common-attributes.adoc[]
55
:context: init-bundle-cloud-ocp-apply
66

77
toc::[]
88

99
[role="_abstract"]
10-
Apply the init bundle by using it to create resources.
10+
Apply the init bundle or cluster registration secret (CRS) by using it to create resources.
1111

1212
[NOTE]
1313
====
14-
You must have the `Admin` user role to apply an init bundle.
14+
You must have the `Admin` user role to apply an init bundle or CRS.
1515
====
1616

1717
include::modules/create-resource-init-bundle.adoc[leveloffset=+1]
18-
18+
include::modules/crs-apply-secured-cluster.adoc[leveloffset=+1]
1919

2020
[id="next-steps_init-bundle-cloud-ocp-apply"]
2121
== Next steps

0 commit comments

Comments
 (0)