Skip to content

Commit 28d2d55

Browse files
authored
Merge pull request #53722 from xperimental/fix-lokistack-howto
logging: Fix ClusterLogging example in LokiStack howto
2 parents 3a153c8 + df7309c commit 28d2d55

File tree

4 files changed

+44
-43
lines changed

4 files changed

+44
-43
lines changed

modules/cluster-logging-forwarding-lokistack.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To configure log forwarding to the LokiStack gateway, you must create a ClusterL
99
.Prerequisites
1010

1111
* {logging-title-uc}: 5.5 and later
12-
* `LokiOperator` Operator
12+
* `Loki Operator` Operator
1313
1414
.Procedure
1515

@@ -23,10 +23,11 @@ metadata:
2323
name: instance
2424
namespace: openshift-logging
2525
spec:
26+
managementState: Managed
2627
logStore:
2728
type: lokistack
2829
lokistack:
29-
name: lokistack-dev
30+
name: logging-loki
3031
collection:
3132
type: vector
3233
----

modules/cluster-logging-loki-deploy.adoc

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ endif::[]
1818
1919
.Procedure
2020

21-
. Install the `LokiOperator` Operator:
21+
. Install the `Loki Operator` Operator:
2222

2323
ifndef::openshift-rosa,openshift-dedicated[]
2424
.. In the {product-title} web console, click *Operators* -> *OperatorHub*.
@@ -27,7 +27,7 @@ ifdef::openshift-rosa,openshift-dedicated[]
2727
.. In the {hybrid-console}, click *Operators* -> *OperatorHub*.
2828
endif::[]
2929

30-
.. Choose *LokiOperator* from the list of available Operators, and click *Install*.
30+
.. Choose *Loki Operator* from the list of available Operators, and click *Install*.
3131

3232
.. Under *Installation Mode*, select *All namespaces on the cluster*.
3333

@@ -53,9 +53,9 @@ This option sets the `openshift.io/cluster-monitoring: "true"` label in the Name
5353
5454
.. Click *Install*.
5555

56-
.. Verify that you installed the LokiOperator. Visit the *Operators* → *Installed Operators* page and look for *LokiOperator*.
56+
.. Verify that you installed the Loki Operator. Visit the *Operators* → *Installed Operators* page and look for *Loki Operator*.
5757

58-
.. Ensure that *LokiOperator* is listed with *Status* as *Succeeded* in all the projects.
58+
.. Ensure that *Loki Operator* is listed with *Status* as *Succeeded* in all the projects.
5959
+
6060
. Create a `Secret` YAML file that uses the `access_key_id` and `access_key_secret` fields to specify your AWS credentials and `bucketnames`, `endpoint` and `region` to define the object storage location. For example:
6161
+
@@ -78,23 +78,23 @@ stringData:
7878
+
7979
[source,yaml]
8080
----
81-
apiVersion: loki.grafana.com/v1
82-
kind: LokiStack
83-
metadata:
84-
name: logging-loki
85-
namespace: openshift-logging
86-
spec:
87-
size: 1x.small
88-
storage:
89-
schemas:
90-
- version: v12
91-
effectiveDate: '2022-06-01'
92-
secret:
93-
name: logging-loki-s3
94-
type: s3
95-
storageClassName: gp2
96-
tenants:
97-
mode: openshift-logging
81+
apiVersion: loki.grafana.com/v1
82+
kind: LokiStack
83+
metadata:
84+
name: logging-loki
85+
namespace: openshift-logging
86+
spec:
87+
size: 1x.small
88+
storage:
89+
schemas:
90+
- version: v12
91+
effectiveDate: "2022-06-01"
92+
secret:
93+
name: logging-loki-s3
94+
type: s3
95+
storageClassName: gp2
96+
tenants:
97+
mode: openshift-logging
9898
----
9999
+
100100
.. Apply the configuration:
@@ -108,19 +108,19 @@ oc apply -f logging-loki.yaml
108108
+
109109
[source,yaml]
110110
----
111-
apiVersion: logging.openshift.io/v1
112-
kind: ClusterLogging
113-
metadata:
114-
name: instance
115-
namespace: openshift-logging
116-
spec:
117-
managementState: Managed
118-
logStore:
119-
type: lokistack
120-
lokistack:
121-
name: logging-loki
122-
collection:
123-
type: "vector"
111+
apiVersion: logging.openshift.io/v1
112+
kind: ClusterLogging
113+
metadata:
114+
name: instance
115+
namespace: openshift-logging
116+
spec:
117+
managementState: Managed
118+
logStore:
119+
type: lokistack
120+
lokistack:
121+
name: logging-loki
122+
collection:
123+
type: vector
124124
----
125125
+
126126
.. Apply the configuration:

modules/cluster-logging-loki-tech-preview.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,20 @@ Loki is a horizontally scalable, highly available, multi-tenant log aggregation
1616
* link:https://grafana.com/docs/loki/latest/[Loki Documentation]
1717

1818
== Deploying the Lokistack
19-
You can use the {product-title} web console to install the LokiOperator.
19+
You can use the {product-title} web console to install the Loki Operator.
2020

2121
.Prerequisites
2222

2323
* {product-title}: 4.12
2424
* {logging-title-uc}: 5.4
2525

26-
To install the LokiOperator using the {product-title} web console:
26+
To install the Loki Operator using the {product-title} web console:
2727

28-
. Install the LokiOperator:
28+
. Install the Loki Operator:
2929

3030
.. In the {product-title} web console, click *Operators* -> *OperatorHub*.
3131

32-
.. Choose *LokiOperator* from the list of available Operators, and click *Install*.
32+
.. Choose *Loki Operator* from the list of available Operators, and click *Install*.
3333

3434
.. Under *Installation Mode*, select *All namespaces on the cluster*.
3535

@@ -54,6 +54,6 @@ scrapes the `openshift-operators-redhat` namespace.
5454

5555
.. Click *Install*.
5656

57-
.. Verify that you installed the LokiOperator. Visit the *Operators* → *Installed Operators* page and look for "LokiOperator."
57+
.. Verify that you installed the Loki Operator. Visit the *Operators* → *Installed Operators* page and look for "Loki Operator."
5858

59-
.. Ensure that *LokiOperator* is listed in all the projects whose *Status* is *Succeeded*.
59+
.. Ensure that *Loki Operator* is listed in all the projects whose *Status* is *Succeeded*.

modules/cluster-logging-rn-5.5.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ JSON formatting of logs varies by application. Because creating too many indices
1717

1818
* With this update, clusters with AWS Security Token Service (STS) enabled may use STS authentication to forward logs to Amazon CloudWatch. (link:https://issues.redhat.com/browse/LOG-1976[LOG-1976])
1919

20-
* With this update, the 'LokiOperator' Operator and Vector collector move from Technical Preview to General Availability. Full feature parity with prior releases are pending, and some APIs remain Technical Previews. See the *Logging with the LokiStack* section for details.
20+
* With this update, the 'Loki Operator' Operator and Vector collector move from Technical Preview to General Availability. Full feature parity with prior releases are pending, and some APIs remain Technical Previews. See the *Logging with the LokiStack* section for details.
2121

2222
[id="openshift-logging-5-5-0-bug-fixes"]
2323
== Bug fixes

0 commit comments

Comments
 (0)