Skip to content

Commit c32cd21

Browse files
authored
Merge pull request #90806 from skopacz1/OSDOCS-12900
OSDOCS#12900: Increasing rec visibility
2 parents 418695e + baded3f commit c32cd21

8 files changed

+51
-16
lines changed

modules/cert-manager-operator-update-channels.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,12 @@ Update channels are the mechanism by which you can declare the version of your {
1313
1414
[id="stable-v1-channel_{context}"]
1515
== stable-v1 channel
16+
The `stable-v1` channel installs and updates the latest release version of the {cert-manager-operator}. Select the `stable-v1` channel if you want to use the latest stable release of the {cert-manager-operator}.
1617

17-
The `stable-v1` channel is the default and suggested channel while installing the {cert-manager-operator}. The `stable-v1` channel installs and updates the latest release version of the {cert-manager-operator}. Select the `stable-v1` channel if you want to use the latest stable release of the {cert-manager-operator}.
18+
[NOTE]
19+
====
20+
The `stable-v1` channel is the default and suggested channel while installing the {cert-manager-operator}.
21+
====
1822

1923
The `stable-v1` channel offers the following update approval strategies:
2024

modules/customize-certificates-add-service-serving.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,16 @@ Because the generated certificates contain wildcard subjects for headless servic
3131
$ oc annotate service <service_name> \//<1>
3232
service.beta.openshift.io/serving-cert-secret-name=<secret_name> //<2>
3333
----
34+
+
35+
--
3436
<1> Replace `<service_name>` with the name of the service to secure.
35-
<2> `<secret_name>` will be the name of the generated secret containing the
36-
certificate and key pair. For convenience, it is recommended that this
37-
be the same as `<service_name>`.
37+
<2> `<secret_name>` will be the name of the generated secret containing the certificate and key pair.
38+
+
39+
[NOTE]
40+
====
41+
For convenience, it is recommended that this value be the same as `<service_name>`.
42+
====
43+
--
3844
+
3945
For example, use the following command to annotate the service `test1`:
4046
+

modules/network-observability-lokistack-ingestion-query.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@
55
[id="network-observability-lokistack-configuring-ingestion{context}"]
66

77
= LokiStack ingestion limits and health alerts
8-
The LokiStack instance comes with default settings according to the configured size. It is possible to override some of these settings, such as the ingestion and query limits. You might want to update them if you get Loki errors showing up in the Console plugin, or in `flowlogs-pipeline` logs. An automatic alert in the web console notifies you when these limits are reached.
8+
The LokiStack instance comes with default settings according to the configured size. It is possible to override some of these settings, such as the ingestion and query limits. An automatic alert in the web console notifies you when these limits are reached.
9+
10+
[NOTE]
11+
====
12+
You might want to update the ingestion and query limits if you get Loki errors showing up in the Console plugin, or in `flowlogs-pipeline` logs.
13+
====
914

1015
Here is an example of configured limits:
1116

modules/security-container-content-universal.adoc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
// * security/container_security/security-container-content.adoc
44

55
[id="security-container-content-universal_{context}"]
6-
= Creating redistributable images with UBI
6+
= Creating redistributable images with UBI
77

88
To create containerized applications, you typically start with a trusted base
99
image that offers the components that are usually provided by the operating system.
1010
These include the libraries, utilities, and other features the application
1111
expects to see in the operating system's file system.
1212

13-
Red Hat Universal Base Images (UBI) were created to encourage anyone building their
14-
own containers to start with one that is made entirely from Red Hat Enterprise
13+
Red{nbsp}Hat Universal Base Images (UBI) were created to encourage anyone building their
14+
own containers to start with one that is made entirely from Red{nbsp}Hat Enterprise
1515
Linux rpm packages and other content. These UBI images are updated regularly
1616
to keep up with security patches and free to use and redistribute with
17-
container images built to include your own software.
17+
container images built to include your own software.
1818

1919
Search the
2020
link:https://catalog.redhat.com/software/containers/explore[Red Hat Ecosystem Catalog]
@@ -26,20 +26,24 @@ be interested in these two general types of UBI images:
2626
`ubi8/ubi`, and `ubi9/ubi`), as well as minimal images based on those systems (`ubi7/ubi-minimal`, `ubi8/ubi-mimimal`, and ubi9/ubi-minimal). All of these images are preconfigured to point to free
2727
repositories of {op-system-base} software that you can add to the container images you build,
2828
using standard `yum` and `dnf` commands.
29-
Red Hat encourages people to use these images on other distributions,
29+
+
30+
[NOTE]
31+
====
32+
Red{nbsp}Hat encourages people to use these images on other distributions,
3033
such as Fedora and Ubuntu.
34+
====
3135

32-
* **Red Hat Software Collections**: Search the Red Hat Ecosystem Catalog
36+
* **Red{nbsp}Hat Software Collections**: Search the Red{nbsp}Hat Ecosystem Catalog
3337
for `rhscl/` to find images created to use as base images for specific types
3438
of applications. For example, there are Apache httpd ([x-]`rhscl/httpd-*`),
3539
Python ([x-]`rhscl/python-*`), Ruby ([x-]`rhscl/ruby-*`), Node.js
3640
([x-]`rhscl/nodejs-*`) and Perl ([x-]`rhscl/perl-*`) rhscl images.
3741

3842
Keep in mind that while UBI images are freely available and redistributable,
39-
Red Hat support for these images is only available through Red Hat
43+
Red{nbsp}Hat support for these images is only available through Red{nbsp}Hat
4044
product subscriptions.
4145

4246
See
43-
link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/building_running_and_managing_containers/index#using_red_hat_universal_base_images_standard_minimal_and_runtimes[Using Red Hat Universal Base Images]
47+
link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/building_running_and_managing_containers/index#using_red_hat_universal_base_images_standard_minimal_and_runtimes[Using Red{nbsp}Hat Universal Base Images]
4448
in the Red Hat Enterprise Linux documentation for information on how to use and build on
4549
standard, minimal and init UBI images.

modules/security-hosts-vms-rhcos.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,7 @@ Disabling SELinux on {op-system} is not supported.
3131

3232
{op-system} is a version of {op-system-base-full} that is specially configured to work as control plane (master) and worker nodes on {product-title} clusters. So {op-system} is tuned to efficiently run container workloads, along with Kubernetes and {product-title} services.
3333

34+
[NOTE]
35+
====
3436
To further protect {op-system} systems in {product-title} clusters, most containers, except those managing or monitoring the host system itself, should run as a non-root user. Dropping the privilege level or creating containers with the least amount of privileges possible is recommended best practice for protecting your own {product-title} clusters.
37+
====

modules/tls-profiles-understanding.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,15 @@ For the Ingress Controller, the minimum TLS version is converted from 1.0 to 1.1
2828
====
2929

3030
|`Intermediate`
31-
|This profile is the recommended configuration for the majority of clients. It is the default TLS security profile for the Ingress Controller, kubelet, and control plane. The profile is based on the link:https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29[Intermediate compatibility] recommended configuration.
31+
|This profile is the default TLS security profile for the Ingress Controller, kubelet, and control plane. The profile is based on the link:https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29[Intermediate compatibility] recommended configuration.
3232

3333
The `Intermediate` profile requires a minimum TLS version of 1.2.
3434

35+
[NOTE]
36+
====
37+
This profile is the recommended configuration for the majority of clients.
38+
====
39+
3540
|`Modern`
3641
|This profile is intended for use with modern clients that have no need for backwards compatibility. This profile is based on the link:https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility[Modern compatibility] recommended configuration.
3742

observability/network_observability/installing-operators.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ include::_attributes/common-attributes.adoc[]
55
:context: network_observability
66

77
toc::[]
8+
89
Installing Loki is a recommended prerequisite for using the Network Observability Operator. You can choose to use xref:../../observability/network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network Observability without Loki], but there are some considerations for doing this, described in the previously linked section.
910

1011
The {loki-op} integrates a gateway that implements multi-tenancy and authentication with Loki for data flow storage. The `LokiStack` resource manages Loki, which is a scalable, highly-available, multi-tenant log aggregation system, and a web proxy with {product-title} authentication. The `LokiStack` proxy uses {product-title} authentication to enforce multi-tenancy and facilitate the saving and indexing of data in Loki log stores.

security/network_bound_disk_encryption/nbde-managing-encryption-keys.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,16 @@ include::_attributes/common-attributes.adoc[]
88
toc::[]
99

1010

11-
The cryptographic mechanism to recreate the encryption key is based on the _blinded key_ stored on the node and the private key of the involved Tang servers. To protect against the possibility of an attacker who has obtained both the Tang server private key and the node’s encrypted disk, periodic rekeying is advisable.
11+
The cryptographic mechanism to recreate the encryption key is based on the _blinded key_ stored on the node and the private key of the involved Tang servers.
1212

13-
You must perform the rekeying operation for every node before you can delete the old key from the Tang server. The following sections provide procedures for rekeying and deleting old keys.
13+
[NOTE]
14+
====
15+
To protect against the possibility of an attacker who has obtained both the Tang server private key and the node's encrypted disk, periodic rekeying is advisable.
16+
17+
You must perform the rekeying operation for every node before you can delete the old key from the Tang server.
18+
====
19+
20+
The following sections provide procedures for rekeying and deleting old keys.
1421

1522
include::modules/nbde-backing-up-server-keys.adoc[leveloffset=+1]
1623

0 commit comments

Comments
 (0)