mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
36bc3f1bfe
- Incorrect indentation mentioned in the step5 "namespace object for the Red Hat OpenShift Logging Operator" [2] of "Installing Logging and the Loki Operator using the CLI" documentation [1]. - Here are the documentation links: [1] https://docs.openshift.com/container-platform/4.14/observability/logging/log_storage/installing-log-storage.html#logging-loki-cli-install_installing-log-storage [2] https://docs.openshift.com/container-platform/4.14/observability/logging/log_storage/installing-log-storage.html#logging-loki-cli-install_installing-log-storage:~:text=Create%20a%20namespace%20object%20for%20the%20Red%20Hat%20OpenShift%20Logging%20Operator%3A - Here is the Step5: ~~~ apiVersion: v1 kind: Namespace metadata: name: openshift-logging annotations: <<== Incorrect Indentation openshift.io/node-selector: "" labels: <<== Incorrect Indentation openshift.io/cluster-logging: "true" openshift.io/cluster-monitoring: "true" ~~~ - `annotations`, and `labels` should be indented under the `metadata` field and inline with `name`. - Here is the correct configuration of Step5: ~~~ ~~~ - We need to perform this change under our standard documentation. - Please refer Step1 from the same documentation for reference. -------- 1. Create a Namespace object for Loki Operator: ~~~ ~~~ --------------
259 lines
9.0 KiB
Plaintext
259 lines
9.0 KiB
Plaintext
// Module is included in the following assemblies:
|
|
//
|
|
// * observability/logging/log_storage/installing-log-storage.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="logging-loki-cli-install_{context}"]
|
|
= Installing {logging-uc} and the {loki-op} using the CLI
|
|
|
|
To install and configure logging on your {product-title} cluster, an Operator such as {loki-op} for log storage must be installed first. This can be done from the {product-title} CLI.
|
|
|
|
.Prerequisites
|
|
|
|
* You have administrator permissions.
|
|
* You installed the {oc-first}.
|
|
* You have access to a supported object store. For example: AWS S3, Google Cloud Storage, Azure, Swift, Minio, or {rh-storage}.
|
|
|
|
.Procedure
|
|
|
|
--
|
|
include::snippets/logging-stable-updates-snip.adoc[leveloffset=+1]
|
|
--
|
|
|
|
. Create a `Namespace` object for {loki-op}:
|
|
+
|
|
.Example `Namespace` object
|
|
[source,yaml]
|
|
----
|
|
apiVersion: v1
|
|
kind: Namespace
|
|
metadata:
|
|
name: openshift-operators-redhat # <1>
|
|
annotations:
|
|
openshift.io/node-selector: ""
|
|
labels:
|
|
openshift.io/cluster-monitoring: "true" # <2>
|
|
----
|
|
<1> You must specify the `openshift-operators-redhat` namespace. To prevent possible conflicts with metrics, you should configure the Prometheus Cluster Monitoring stack to scrape metrics from the `openshift-operators-redhat` namespace and not the `openshift-operators` namespace. The `openshift-operators` namespace might contain community Operators, which are untrusted and could publish a metric with the same name as an {product-title} metric, which would cause conflicts.
|
|
<2> A string value that specifies the label as shown to ensure that cluster monitoring scrapes the `openshift-operators-redhat` namespace.
|
|
|
|
. Apply the `Namespace` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
. Create a `Subscription` object for {loki-op}:
|
|
+
|
|
.Example `Subscription` object
|
|
[source,yaml]
|
|
----
|
|
apiVersion: operators.coreos.com/v1alpha1
|
|
kind: Subscription
|
|
metadata:
|
|
name: loki-operator
|
|
namespace: openshift-operators-redhat # <1>
|
|
spec:
|
|
channel: stable # <2>
|
|
name: loki-operator
|
|
source: redhat-operators # <3>
|
|
sourceNamespace: openshift-marketplace
|
|
----
|
|
<1> You must specify the `openshift-operators-redhat` namespace.
|
|
<2> Specify `stable`, or `stable-5.<y>` as the channel.
|
|
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the `CatalogSource` object you created when you configured the Operator Lifecycle Manager (OLM).
|
|
|
|
. Apply the `Subscription` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
. Create a `namespace` object for the {clo}:
|
|
+
|
|
.Example `namespace` object
|
|
[source,yaml]
|
|
----
|
|
apiVersion: v1
|
|
kind: Namespace
|
|
metadata:
|
|
name: openshift-logging # <1>
|
|
annotations:
|
|
openshift.io/node-selector: ""
|
|
labels:
|
|
openshift.io/cluster-logging: "true"
|
|
openshift.io/cluster-monitoring: "true" # <2>
|
|
----
|
|
<1> The Red{nbsp}Hat OpenShift Logging Operator is only deployable to the `openshift-logging` namespace.
|
|
<2> A string value that specifies the label as shown to ensure that cluster monitoring scrapes the `openshift-operators-redhat` namespace.
|
|
|
|
. Apply the `namespace` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
. Create an `OperatorGroup` object
|
|
+
|
|
.Example `OperatorGroup` object
|
|
[source,yaml]
|
|
----
|
|
apiVersion: operators.coreos.com/v1
|
|
kind: OperatorGroup
|
|
metadata:
|
|
name: cluster-logging
|
|
namespace: openshift-logging # <1>
|
|
spec:
|
|
targetNamespaces:
|
|
- openshift-logging
|
|
----
|
|
<1> You must specify the `openshift-logging` namespace.
|
|
|
|
. Apply the `OperatorGroup` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
. Create a `Subscription` object:
|
|
+
|
|
[source,yaml]
|
|
----
|
|
apiVersion: operators.coreos.com/v1alpha1
|
|
kind: Subscription
|
|
metadata:
|
|
name: cluster-logging
|
|
namespace: openshift-logging # <1>
|
|
spec:
|
|
channel: stable # <2>
|
|
name: cluster-logging
|
|
source: redhat-operators # <3>
|
|
sourceNamespace: openshift-marketplace
|
|
----
|
|
<1> You must specify the `openshift-logging` namespace.
|
|
<2> Specify `stable`, or `stable-5.<y>` as the channel.
|
|
<3> Specify `redhat-operators`. If your {product-title} cluster is installed on a restricted network, also known as a disconnected cluster, specify the name of the CatalogSource object you created when you configured the Operator Lifecycle Manager (OLM).
|
|
|
|
. Apply the `Subscription` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
|
|
. Create a `LokiStack` CR:
|
|
+
|
|
.Example `LokiStack` CR
|
|
[source,yaml]
|
|
----
|
|
apiVersion: loki.grafana.com/v1
|
|
kind: LokiStack
|
|
metadata:
|
|
name: logging-loki # <1>
|
|
namespace: openshift-logging # <2>
|
|
spec:
|
|
size: 1x.small # <3>
|
|
storage:
|
|
schemas:
|
|
- version: v13
|
|
effectiveDate: "<yyyy>-<mm>-<dd>"
|
|
secret:
|
|
name: logging-loki-s3 # <4>
|
|
type: s3 # <5>
|
|
credentialMode: # <6>
|
|
storageClassName: <storage_class_name> # <7>
|
|
tenants:
|
|
mode: openshift-logging # <8>
|
|
----
|
|
<1> Use the name `logging-loki`.
|
|
<2> You must specify the `openshift-logging` namespace.
|
|
<3> Specify the deployment size. In the {logging} 5.8 and later versions, the supported size options for production instances of Loki are `1x.extra-small`, `1x.small`, or `1x.medium`.
|
|
<4> Specify the name of your log store secret.
|
|
<5> Specify the corresponding storage type.
|
|
<6> Optional field, logging 5.9 and later. Supported user configured values are as follows: `static` is the default authentication mode available for all supported object storage types using credentials stored in a Secret. `token` for short-lived tokens retrieved from a credential source. In this mode the static configuration does not contain credentials needed for the object storage. Instead, they are generated during runtime using a service, which allows for shorter-lived credentials and much more granular control. This authentication mode is not supported for all object storage types. `token-cco` is the default value when Loki is running on managed STS mode and using CCO on STS/WIF clusters.
|
|
<7> Specify the name of a storage class for temporary storage. For best performance, specify a storage class that allocates block storage. Available storage classes for your cluster can be listed by using the `oc get storageclasses` command.
|
|
<8> LokiStack defaults to running in multi-tenant mode, which cannot be modified. One tenant is provided for each log type: audit, infrastructure, and application logs. This enables access control for individual users and user groups to different log streams.
|
|
|
|
. Apply the `LokiStack CR` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
. Create a `ClusterLogging` CR object:
|
|
+
|
|
.Example ClusterLogging CR object
|
|
[source,yaml]
|
|
----
|
|
apiVersion: logging.openshift.io/v1
|
|
kind: ClusterLogging
|
|
metadata:
|
|
name: instance # <1>
|
|
namespace: openshift-logging # <2>
|
|
spec:
|
|
collection:
|
|
type: vector
|
|
logStore:
|
|
lokistack:
|
|
name: logging-loki
|
|
retentionPolicy:
|
|
application:
|
|
maxAge: 7d
|
|
audit:
|
|
maxAge: 7d
|
|
infra:
|
|
maxAge: 7d
|
|
type: lokistack
|
|
visualization:
|
|
type: ocp-console
|
|
ocpConsole:
|
|
logsLimit: 15
|
|
managementState: Managed
|
|
----
|
|
<1> Name must be `instance`.
|
|
<2> Namespace must be `openshift-logging`.
|
|
|
|
|
|
. Apply the `ClusterLogging CR` object by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc apply -f <filename>.yaml
|
|
----
|
|
|
|
. Verify the installation by running the following command:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc get pods -n openshift-logging
|
|
----
|
|
+
|
|
.Example output
|
|
[source,terminal]
|
|
----
|
|
$ oc get pods -n openshift-logging
|
|
NAME READY STATUS RESTARTS AGE
|
|
cluster-logging-operator-fb7f7cf69-8jsbq 1/1 Running 0 98m
|
|
collector-222js 2/2 Running 0 18m
|
|
collector-g9ddv 2/2 Running 0 18m
|
|
collector-hfqq8 2/2 Running 0 18m
|
|
collector-sphwg 2/2 Running 0 18m
|
|
collector-vv7zn 2/2 Running 0 18m
|
|
collector-wk5zz 2/2 Running 0 18m
|
|
logging-view-plugin-6f76fbb78f-n2n4n 1/1 Running 0 18m
|
|
lokistack-sample-compactor-0 1/1 Running 0 42m
|
|
lokistack-sample-distributor-7d7688bcb9-dvcj8 1/1 Running 0 42m
|
|
lokistack-sample-gateway-5f6c75f879-bl7k9 2/2 Running 0 42m
|
|
lokistack-sample-gateway-5f6c75f879-xhq98 2/2 Running 0 42m
|
|
lokistack-sample-index-gateway-0 1/1 Running 0 42m
|
|
lokistack-sample-ingester-0 1/1 Running 0 42m
|
|
lokistack-sample-querier-6b7b56bccc-2v9q4 1/1 Running 0 42m
|
|
lokistack-sample-query-frontend-84fb57c578-gq2f7 1/1 Running 0 42m
|
|
----
|