Skip to content

Commit fdd4c69

Browse files
tmaloveTami Love
authored andcommitted
port security content from ocp
1 parent 7784904 commit fdd4c69

24 files changed

+506
-35
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 264 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -377,14 +377,14 @@ Topics:
377377
Topics:
378378
# - Name: CLI and web console
379379
# File: rosa-cli-openshift-console
380-
- Name: Getting started with the ROSA CLI
381-
File: rosa-get-started-cli
382-
- Name: Managing objects with the ROSA CLI
383-
File: rosa-manage-objects-cli
384-
- Name: Checking account and version information with the ROSA CLI
385-
File: rosa-checking-acct-version-cli
386-
- Name: Checking logs with the ROSA CLI
387-
File: rosa-checking-logs-cli
380+
- Name: Getting started with the ROSA CLI
381+
File: rosa-get-started-cli
382+
- Name: Managing objects with the ROSA CLI
383+
File: rosa-manage-objects-cli
384+
- Name: Checking account and version information with the ROSA CLI
385+
File: rosa-checking-acct-version-cli
386+
- Name: Checking logs with the ROSA CLI
387+
File: rosa-checking-logs-cli
388388
---
389389
Name: Red Hat OpenShift Cluster Manager
390390
Dir: ocm
@@ -437,18 +437,256 @@ Topics:
437437
- Name: Configuring cluster memory to meet container memory and risk requirements
438438
File: nodes-cluster-resource-configure
439439
---
440+
# Ported PR #62384
440441
Name: Security and compliance
441442
Dir: security
442443
Distros: openshift-rosa
443444
Topics:
444-
- Name: Audit logs
445-
File: audit-log-view
446-
- Name: Adding additional constraints for IP-based AWS role assumption
447-
File: rosa-adding-additional-constraints-for-ip-based-aws-role-assumption
448-
#- Name: Security
449-
# File: rosa-security
450-
#- Name: Application and cluster compliance
451-
# File: rosa-app-security-compliance
445+
- Name: Security and compliance overview
446+
File: index
447+
- Name: Container security
448+
Dir: container_security
449+
Topics:
450+
- Name: Understanding container security
451+
File: security-understanding
452+
- Name: Understanding host and VM security
453+
File: security-hosts-vms
454+
# - Name: Hardening Red Hat Enterprise Linux CoreOS
455+
# File: security-hardening
456+
# Distros: openshift-rosa
457+
#- Name: Container image signatures
458+
# File: security-container-signature
459+
# - Name: Hardening Fedora CoreOS
460+
# File: security-hardening
461+
# Distros: openshift-rosa
462+
# - Name: Understanding compliance
463+
# File: security-compliance
464+
# - Name: Securing container content
465+
# File: security-container-content
466+
# - Name: Using container registries securely
467+
# File: security-registries
468+
# - Name: Securing the build process
469+
# File: security-build
470+
# - Name: Deploying containers
471+
# File: security-deploy
472+
# - Name: Securing the container platform
473+
# File: security-platform
474+
# - Name: Securing networks
475+
# File: security-network
476+
# - Name: Securing attached storage
477+
# File: security-storage
478+
#- Name: Monitoring cluster events and logs
479+
# File: security-monitoring
480+
- Name: Configuring certificates
481+
Dir: certificates
482+
Distros: openshift-rosa
483+
Topics:
484+
- Name: Replacing the default ingress certificate
485+
File: replacing-default-ingress-certificate
486+
- Name: Adding API server certificates
487+
File: api-server
488+
- Name: Securing service traffic using service serving certificates
489+
File: service-serving-certificate
490+
- Name: Updating the CA bundle
491+
File: updating-ca-bundle
492+
# - Name: Certificate types and descriptions
493+
# Dir: certificate_types_descriptions
494+
# Distros: openshift-rosa
495+
# Topics:
496+
# - Name: User-provided certificates for the API server
497+
# File: user-provided-certificates-for-api-server
498+
# - Name: Proxy certificates
499+
# File: proxy-certificates
500+
# - Name: Service CA certificates
501+
# File: service-ca-certificates
502+
# - Name: Node certificates
503+
# File: node-certificates
504+
# - Name: Bootstrap certificates
505+
# File: bootstrap-certificates
506+
# - Name: etcd certificates
507+
# File: etcd-certificates
508+
# - Name: OLM certificates
509+
# File: olm-certificates
510+
# - Name: Aggregated API client certificates
511+
# File: aggregated-api-client-certificates
512+
# - Name: Machine Config Operator certificates
513+
# File: machine-config-operator-certificates
514+
# - Name: User-provided certificates for default ingress
515+
# File: user-provided-certificates-for-default-ingress
516+
# - Name: Ingress certificates
517+
# File: ingress-certificates
518+
# - Name: Monitoring and cluster logging Operator component certificates
519+
# File: monitoring-and-cluster-logging-operator-component-certificates
520+
# - Name: Control plane certificates
521+
# File: control-plane-certificates
522+
# The commented topics in the Compliance Operator section are as a result of a realignment for OCP docs. They are now in subdirectories. (10/2023)
523+
# - Name: Supported compliance profiles
524+
# File: compliance-operator-supported-profiles
525+
# - Name: Installing the Compliance Operator
526+
# File: compliance-operator-installation
527+
# - Name: Updating the Compliance Operator
528+
# File: compliance-operator-updating
529+
# - Name: Compliance Operator scans
530+
# File: compliance-scans
531+
# - Name: Managing the Compliance Operator
532+
# File: compliance-operator-manage
533+
# - Name: Compliance Operator scans
534+
# File: compliance-scans
535+
# - Name: Tailoring the Compliance Operator
536+
# File: compliance-operator-tailor
537+
# - Name: Retrieving Compliance Operator raw results
538+
# File: compliance-operator-raw-results
539+
# - Name: Managing Compliance Operator remediation
540+
# File: compliance-operator-remediation
541+
# - Name: Performing advanced Compliance Operator tasks
542+
# File: compliance-operator-advanced
543+
# - Name: Troubleshooting the Compliance Operator
544+
# File: compliance-operator-troubleshooting
545+
# - Name: Uninstalling the Compliance Operator
546+
# File: compliance-operator-uninstallation
547+
# - Name: Using the oc-compliance plugin
548+
# File: oc-compliance-plug-in-using
549+
# - Name: Understanding the Custom Resource Definitions
550+
# File: compliance-operator-crd
551+
- Name: Compliance Operator
552+
Dir: compliance_operator
553+
Distros: openshift-rosa
554+
Topics:
555+
- Name: Compliance Operator overview
556+
File: co-overview
557+
- Name: Compliance Operator release notes
558+
File: compliance-operator-release-notes
559+
- Name: Compliance Operator concepts
560+
Dir: co-concepts
561+
Topics:
562+
- Name: Understanding the Compliance Operator
563+
File: compliance-operator-understanding
564+
- Name: Understanding the Custom Resource Definitions
565+
File: compliance-operator-crd
566+
- Name: Compliance Operator management
567+
Dir: co-management
568+
Distros: openshift-rosa
569+
Topics:
570+
- Name: Installing the Compliance Operator
571+
File: compliance-operator-installation
572+
- Name: Updating the Compliance Operator
573+
File: compliance-operator-updating
574+
- Name: Managing the Compliance Operator
575+
File: compliance-operator-manage
576+
- Name: Uninstalling the Compliance Operator
577+
File: compliance-operator-uninstallation
578+
- Name: Compliance Operator scan management
579+
Dir: co-scans
580+
Distros: openshift-rosa
581+
Topics:
582+
- Name: Supported compliance profiles
583+
File: compliance-operator-supported-profiles
584+
- Name: Compliance Operator scans
585+
File: compliance-scans
586+
- Name: Tailoring the Compliance Operator
587+
File: compliance-operator-tailor
588+
- Name: Retrieving Compliance Operator raw results
589+
File: compliance-operator-raw-results
590+
- Name: Managing Compliance Operator remediation
591+
File: compliance-operator-remediation
592+
- Name: Performing advanced Compliance Operator tasks
593+
File: compliance-operator-advanced
594+
- Name: Troubleshooting the Compliance Operator
595+
File: compliance-operator-troubleshooting
596+
- Name: Using the oc-compliance plugin
597+
File: oc-compliance-plug-in-using
598+
- Name: File Integrity Operator
599+
Dir: file_integrity_operator
600+
Distros: openshift-rosa
601+
Topics:
602+
- Name: File Integrity Operator release notes
603+
File: file-integrity-operator-release-notes
604+
- Name: Installing the File Integrity Operator
605+
File: file-integrity-operator-installation
606+
- Name: Updating the File Integrity Operator
607+
File: file-integrity-operator-updating
608+
- Name: Understanding the File Integrity Operator
609+
File: file-integrity-operator-understanding
610+
- Name: Configuring the File Integrity Operator
611+
File: file-integrity-operator-configuring
612+
- Name: Performing advanced File Integrity Operator tasks
613+
File: file-integrity-operator-advanced-usage
614+
- Name: Troubleshooting the File Integrity Operator
615+
File: file-integrity-operator-troubleshooting
616+
#- Name: Security Profiles Operator
617+
# Dir: security_profiles_operator
618+
# Topics:
619+
# - Name: Security Profiles Operator overview
620+
# File: spo-overview
621+
# - Name: Security Profiles Operator release notes
622+
# File: spo-release-notes
623+
# - Name: Understanding the Security Profiles Operator
624+
# File: spo-understanding
625+
# - Name: Enabling the Security Profiles Operator
626+
# File: spo-enabling
627+
# - Name: Managing seccomp profiles
628+
# File: spo-seccomp
629+
# - Name: Managing SELinux profiles
630+
# File: spo-selinux
631+
# - Name: Advanced Security Profiles Operator tasks
632+
# File: spo-advanced
633+
# - Name: Troubleshooting the Security Profiles Operator
634+
# File: spo-troubleshooting
635+
# - Name: Uninstalling the Security Profiles Operator
636+
# File: spo-uninstalling
637+
# - Name: cert-manager Operator for Red Hat OpenShift
638+
# Dir: cert_manager_operator
639+
# Distros: openshift-rosa
640+
# Topics:
641+
# - Name: cert-manager Operator for Red Hat OpenShift overview
642+
# File: index
643+
# - Name: cert-manager Operator for Red Hat OpenShift release notes
644+
# File: cert-manager-operator-release-notes
645+
# - Name: Installing the cert-manager Operator for Red Hat OpenShift
646+
# File: cert-manager-operator-install
647+
# - Name: Enabling monitoring for the cert-manager Operator for Red Hat OpenShift
648+
# File: cert-manager-monitoring
649+
# - Name: Configuring the egress proxy for the cert-manager Operator for Red Hat OpenShift
650+
# File: cert-manager-operator-proxy
651+
# - Name: Customizing cert-manager by using the cert-manager Operator API fields
652+
# File: cert-manager-customizing-api-fields
653+
# - Name: Authenticating the cert-manager Operator with AWS Security Token Service
654+
# File: cert-manager-authenticate-aws
655+
# - Name: Configuring log levels for cert-manager and the cert-manager Operator for Red Hat OpenShift
656+
# File: cert-manager-log-levels
657+
# - Name: Authenticating the cert-manager Operator for Red Hat OpenShift on AWS
658+
# File: cert-manager-authentication-non-sts
659+
# - Name: Uninstalling the cert-manager Operator for Red Hat OpenShift
660+
# File: cert-manager-operator-uninstall
661+
# - Name: Viewing audit logs
662+
# File: audit-log-view
663+
# - Name: Configuring the audit log policy
664+
# File: audit-log-policy-config
665+
# - Name: Configuring TLS security profiles
666+
# File: tls-security-profiles
667+
# - Name: Configuring seccomp profiles
668+
# File: seccomp-profiles
669+
# - Name: Allowing JavaScript-based access to the API server from additional hosts
670+
# File: allowing-javascript-access-api-server
671+
# Distros: openshift-rosa
672+
# - Name: Encrypting etcd data
673+
# File: encrypting-etcd
674+
# Distros: openshift-rosa
675+
# - Name: Scanning pods for vulnerabilities
676+
# File: pod-vulnerability-scan
677+
# Distros: openshift-rosa
678+
# - Name: Network-Bound Disk Encryption (NBDE)
679+
# Dir: network_bound_disk_encryption
680+
# Topics:
681+
# - Name: About disk encryption technology
682+
# File: nbde-about-disk-encryption-technology
683+
# - Name: Tang server installation considerations
684+
# File: nbde-tang-server-installation-considerations
685+
# - Name: Tang server encryption key management
686+
# File: nbde-managing-encryption-keys
687+
# - Name: Disaster recovery considerations
688+
# File: nbde-disaster-recovery-considerations
689+
# Distros: openshift-rosa
452690
---
453691
Name: Authentication and authorization
454692
Dir: authentication
@@ -537,15 +775,14 @@ Topics:
537775
File: using-s21-images
538776
- Name: Customizing source-to-image images
539777
File: customizing-s2i-images
540-
---
541-
Name: Add-on services
542-
Dir: adding_service_cluster
543-
Distros: openshift-rosa
544-
Topics:
545-
- Name: Adding services to a cluster
546-
File: adding-service
547-
- Name: Available services
548-
File: rosa-available-services
778+
- Name: Add-on services
779+
Dir: adding_service_cluster
780+
Distros: openshift-rosa
781+
Topics:
782+
- Name: Adding services to a cluster
783+
File: adding-service
784+
- Name: Available services
785+
File: rosa-available-services
549786
---
550787
Name: Storage
551788
Dir: storage
@@ -811,9 +1048,8 @@ Topics:
8111048
- Name: Deployments
8121049
Dir: deployments
8131050
Distros: openshift-rosa
814-
Topics:
815-
- Name: Custom domains for applications
816-
File: osd-config-custom-domains-applications
1051+
- Name: Custom domains for applications
1052+
File: osd-config-custom-domains-applications
8171053
# - Name: Application GitOps workflows
8181054
# File: rosa-app-gitops-workflows
8191055
# - Name: Application logging

modules/checking-file-intergrity-cr-status.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,19 @@ The `FileIntegrity` custom resource (CR) reports its status through the .`status
1212

1313
* To query the `FileIntegrity` CR status, run:
1414
+
15+
ifndef::openshift-dedicated,openshift-rosa[]
1516
[source,terminal]
1617
----
1718
$ oc get fileintegrities/worker-fileintegrity -o jsonpath="{ .status.phase }"
1819
----
20+
endif::[]
21+
22+
ifdef::openshift-dedicated,openshift-rosa[]
23+
[source,terminal]
24+
----
25+
$ oc get fileintegrities/worker-fileintegrity -o jsonpath="{ .status.phase }" -n openshift-file-integrity
26+
----
27+
endif::[]
1928
+
2029
.Example output
2130
[source,terminal]

modules/file-integrity-events.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ Transitions in the status of the `FileIntegrity` and `FileIntegrityNodeStatus` o
1010

1111
[source,terminal]
1212
----
13+
ifndef::openshift-dedicated,openshift-rosa[]
1314
$ oc get events --field-selector reason=FileIntegrityStatus
15+
endif::[]
16+
ifdef::openshift-dedicated,openshift-rosa[]
17+
$ oc get events --field-selector reason=FileIntegrityStatus -n openshift-file-integrity
18+
endif::[]
1419
----
1520

1621
.Example output
@@ -26,7 +31,12 @@ When a node scan fails, an event is created with the `add/changed/removed` and c
2631

2732
[source,terminal]
2833
----
34+
ifndef::openshift-dedicated,openshift-rosa[]
2935
$ oc get events --field-selector reason=NodeIntegrityStatus
36+
endif::[]
37+
ifdef::openshift-dedicated,openshift-rosa[]
38+
$ oc get events --field-selector reason=NodeIntegrityStatus -n openshift-file-integrity
39+
endif::[]
3040
----
3141

3242
.Example output
@@ -46,7 +56,12 @@ Changes to the number of added, changed, or removed files results in a new event
4656

4757
[source,terminal]
4858
----
59+
ifndef::openshift-dedicated,openshift-rosa[]
4960
$ oc get events --field-selector reason=NodeIntegrityStatus
61+
endif::[]
62+
ifdef::openshift-dedicated,openshift-rosa[]
63+
$ oc get events --field-selector reason=NodeIntegrityStatus -n openshift-file-integrity
64+
endif::[]
5065
----
5166

5267
.Example output

modules/file-integrity-examine-default-config.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,10 @@ the same name as the `FileIntegrity` CR.
1515
+
1616
[source,terminal]
1717
----
18+
ifndef::openshift-dedicated,openshift-rosa[]
1819
$ oc describe cm/worker-fileintegrity
20+
endif::[]
21+
ifdef::openshift-dedicated,openshift-rosa[]
22+
$ oc describe cm/worker-fileintegrity -n openshift-file-integrity
23+
endif::[]
1924
----

0 commit comments

Comments
 (0)