Skip to content

Commit f122499

Browse files
gabriel-rhgabriel-rh
committed
OBSDOCS-1972 migrate old content - add in snippets
1 parent edf949c commit f122499

20 files changed

+323
-0
lines changed

‎snippets/about-node-selectors.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Snippets included in the following assemblies and modules:
2+
//
3+
// * nodes/scheduling/nodes-scheduler-node-selectors.adoc
4+
// * observability/logging/scheduling_resources/logging-node-selection.adoc
5+
6+
:_mod-docs-content-type: SNIPPET
7+
8+
A _node selector_ specifies a map of key/value pairs that are defined using custom labels on nodes and selectors specified in pods.
9+
10+
For the pod to be eligible to run on a node, the pod must have the same key/value node selector as the label on the node.

‎snippets/audit-logs-default.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies and modules:
2+
//
3+
// * observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc
4+
//
5+
// * modules/cluster-logging-elasticsearch-audit.adoc
6+
7+
In a {logging} deployment, container and infrastructure logs are forwarded to the internal log store defined in the `ClusterLogging` custom resource (CR) by default.
8+
9+
Audit logs are not forwarded to the internal log store by default because this does not provide secure storage. You are responsible for ensuring that the system to which you forward audit logs is compliant with your organizational and governmental regulations, and is properly secured.
10+
11+
If this default configuration meets your needs, you do not need to configure a `ClusterLogForwarder` CR. If a `ClusterLogForwarder` CR exists, logs are not forwarded to the internal log store unless a pipeline is defined that contains the `default` output.

‎snippets/butane-version.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Text snippet included in the following modules:
2+
//
3+
// * modules/about-crio.adoc
4+
// * modules/nodes-containers-using.adoc
5+
// * modules/cluster-logging-systemd-scaling.adoc
6+
// * modules/containers-signature-verify-enable.adoc
7+
// * modules/machineconfig-modify-journald.adoc
8+
// * modules/nw-cluster-mtu-change.adoc
9+
// * modules/nw-ovn-ipsec-north-south-enable.adoc
10+
// * modules/rhcos-load-firmware-blobs.adoc
11+
// * modules/troubleshooting-enabling-kdump-day-one.adoc
12+
// * modules/virt-binding-devices-vfio-driver.adoc
13+
// * updating/updating_a_cluster/updating-bootloader-rhcos.adoc
14+
15+
:_mod-docs-content-type: SNIPPET
16+
17+
The link:https://coreos.github.io/butane/specs/[Butane version] you specify in the config file should match the {ocp-product-title} version and always ends in `0`. For example, `{product-version}.0`. See "Creating machine configs with Butane" for information about Butane.

‎snippets/es-pod-var-logging.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Snippet included in the following assemblies:
2+
//
3+
//
4+
// Snippet included in the following modules:
5+
//
6+
// * es-node-disk-low-watermark-reached.adoc
7+
// * es-node-disk-high-watermark-reached.adoc
8+
// * es-node-disk-flood-watermark-reached.adoc
9+
10+
:_mod-docs-content-type: SNIPPET
11+
12+
[TIP]
13+
====
14+
Some commands in this documentation reference an Elasticsearch pod by using a `$ES_POD_NAME` shell variable. If you want to copy and paste the commands directly from this documentation, you must set this variable to a value that is valid for your Elasticsearch cluster.
15+
16+
You can list the available Elasticsearch pods by running the following command:
17+
18+
[source,terminal]
19+
----
20+
$ oc -n openshift-logging get pods -l component=elasticsearch
21+
----
22+
23+
Choose one of the pods listed and set the `$ES_POD_NAME` variable, by running the following command:
24+
25+
[source,terminal]
26+
----
27+
$ export ES_POD_NAME=<elasticsearch_pod_name>
28+
----
29+
30+
You can now use the `$ES_POD_NAME` variable in commands.
31+
====

‎snippets/logging-approval-strategy-snip.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//logging-loki-gui-install.adoc
6+
//
7+
:_mod-docs-content-type: SNIPPET
8+
9+
If the approval strategy in the subscription is set to *Automatic*, the update process initiates as soon as a new Operator version is available in the selected channel. If the approval strategy is set to *Manual*, you must manually approve pending updates.

‎snippets/logging-clusteradmin-access-logs-snip.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
// * modules/logging-creating-new-group-cluster-admin-user-role.adoc
7+
//
8+
:_mod-docs-content-type: SNIPPET
9+
10+
[IMPORTANT]
11+
====
12+
Querying application logs for multiple namespaces as a `cluster-admin` user, where the sum total of characters of all of the namespaces in the cluster is greater than 5120, results in the error `Parse error: input size too long (XXXX > 5120)`. For better control over access to logs in LokiStack, make the `cluster-admin` user a member of the `cluster-admin` group. If the `cluster-admin` group does not exist, create it and add the desired users to it.
13+
====

‎snippets/logging-create-secret-snip.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
//
4+
// Text snippet included in the following modules:
5+
//
6+
//
7+
:_mod-docs-content-type: SNIPPET
8+
9+
You can create a secret in the directory that contains your certificate and key files by using the following command:
10+
[subs="+quotes"]
11+
[source,terminal]
12+
----
13+
$ oc create secret generic -n openshift-logging <my-secret> \
14+
--from-file=tls.key=<your_key_file>
15+
--from-file=tls.crt=<your_crt_file>
16+
--from-file=ca-bundle.crt=<your_bundle_file>
17+
--from-literal=username=<your_username>
18+
--from-literal=password=<your_password>
19+
----
20+
21+
[NOTE]
22+
====
23+
Use generic or opaque secrets for best results.
24+
====

‎snippets/logging-elastic-dep-snip.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
// * observability/logging/cluster-logging-deploying.adoc
4+
//
5+
// Text snippet included in the following modules:
6+
//
7+
// * configuring-log-storage-cr.adoc
8+
9+
:_mod-docs-content-type: SNIPPET
10+
11+
[NOTE]
12+
====
13+
The {logging-uc} 5.9 release does not contain an updated version of the {es-op}. If you currently use the {es-op} released with {logging-uc} 5.8, it will continue to work with {logging-uc} until the EOL of {logging-uc} 5.8. As an alternative to using the {es-op} to manage the default log storage, you can use the {loki-op}. For more information on the {logging-uc} lifecycle dates, see link:https://access.redhat.com/support/policy/updates/openshift_operators#platform-agnostic[Platform Agnostic Operators].
14+
====

‎snippets/logging-fluentd-dep-snip.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
// * observability/logging/cluster-logging-deploying.adoc
4+
//
5+
// Text snippet included in the following modules:
6+
//
7+
// * configuring-logging-collector.adoc
8+
9+
:_mod-docs-content-type: SNIPPET
10+
11+
[NOTE]
12+
====
13+
Fluentd is deprecated and is planned to be removed in a future release. Red{nbsp}Hat provides bug fixes and support for this feature during the current release lifecycle, but this feature no longer receives enhancements. As an alternative to Fluentd, you can use Vector instead.
14+
====

‎snippets/logging-get-clusterid-snip.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Text snippet included in the following modules and assemblies:
2+
//
3+
4+
:_mod-docs-content-type: SNIPPET
5+
6+
Logs from any source contain a field `openshift.cluster_id`, the unique identifier of the cluster in which the Operator is deployed.
7+
8+
.ClusterID query
9+
[source,terminal]
10+
----
11+
$ oc get clusterversion/version -o jsonpath='{.spec.clusterID}{"\n"}'
12+
----

0 commit comments

Comments
 (0)