Skip to content

Commit 640849f

Browse files
committed
OBSDOCS-863: LokiStack size can't be modified
1 parent 4723ee3 commit 640849f

File tree

4 files changed

+37
-7
lines changed

4 files changed

+37
-7
lines changed

modules/create-lokistack-cr-cli.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can create a `LokiStack` custom resource (CR) by using the {oc-first}.
1818

1919
. Create a `LokiStack` CR:
2020
+
21+
--
2122
.Example `LokiStack` CR
2223
[source,yaml]
2324
----
@@ -40,10 +41,16 @@ spec:
4041
mode: openshift-logging # <5>
4142
----
4243
<1> 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`.
44+
+
45+
[IMPORTANT]
46+
====
47+
It is not possible to change the number `1x` for the deployment size.
48+
====
4349
<2> Specify the name of your log store secret.
4450
<3> Specify the type of your log store secret.
4551
<4> 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.
4652
<5> 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.
53+
--
4754

4855
. Apply the `LokiStack` CR by running the following command:
4956
+

modules/create-lokistack-cr-console.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ You can create a `LokiStack` custom resource (CR) by using the {product-title} w
2222

2323
. Select *YAML view*, and then use the following template to create a `LokiStack` CR:
2424
+
25+
--
2526
[source,yaml]
2627
----
2728
apiVersion: loki.grafana.com/v1
@@ -44,7 +45,15 @@ spec:
4445
----
4546
<1> Use the name `logging-loki`.
4647
<2> 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`.
48+
+
49+
[IMPORTANT]
50+
====
51+
It is not possible to change the number `1x` for the deployment size.
52+
====
4753
<3> Specify the secret used for your log storage.
4854
<4> Specify the corresponding storage type.
4955
<5> Enter 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.
5056
<6> 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.
57+
--
58+
59+
. Click *Create*.

modules/loki-deployment-sizing.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ endif::[]
1010
[id="loki-deployment-sizing_{context}"]
1111
= Loki deployment sizing
1212

13-
Sizing for Loki follows the format of `<N>x.<size>` where the value `<N>` is number of instances and `<size>` specifies performance capabilities.
13+
Sizing for Loki follows the format of `1x.<size>` where the value `1x` is number of instances and `<size>` specifies performance capabilities.
14+
15+
[IMPORTANT]
16+
====
17+
It is not possible to change the number `1x` for the deployment size.
18+
====
1419

1520
.Loki sizing
1621
[cols="1h,4*",options="header"]

modules/network-observability-lokistack-create.adoc

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="network-observability-lokistack-create_{context}"]
77
= Creating a LokiStack custom resource
88

9-
You can deploy a LokiStack using the web console or CLI to create a namespace, or new project.
9+
You can deploy a `LokiStack` custom resource (CR) by using the web console or {oc-first} to create a namespace, or new project.
1010

1111
.Procedure
1212

@@ -15,31 +15,40 @@ You can deploy a LokiStack using the web console or CLI to create a namespace, o
1515
. Click *Create LokiStack*.
1616
. Ensure the following fields are specified in either *Form View* or *YAML view*:
1717
+
18+
--
1819
[source,yaml]
1920
----
2021
apiVersion: loki.grafana.com/v1
2122
kind: LokiStack
2223
metadata:
2324
name: loki
24-
namespace: netobserv <1>
25+
namespace: netobserv # <1>
2526
spec:
26-
size: 1x.small
27+
size: 1x.small # <2>
2728
storage:
2829
schemas:
2930
- version: v12
3031
effectiveDate: '2022-06-01'
3132
secret:
3233
name: loki-s3
3334
type: s3
34-
storageClassName: gp3 <2>
35+
storageClassName: gp3 # <3>
3536
tenants:
3637
mode: openshift-network
3738
----
3839
<1> The installation examples in this documentation use the same namespace, `netobserv`, across all components. You can optionally use a different namespace.
39-
<2> Use a storage class name that is available on the cluster for `ReadWriteOnce` access mode. You can use `oc get storageclasses` to see what is available on your cluster.
40+
<2> 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`.
4041
+
4142
[IMPORTANT]
4243
====
43-
You must not reuse the same `LokiStack` that is used for cluster logging.
44+
It is not possible to change the number `1x` for the deployment size.
4445
====
46+
<3> Use a storage class name that is available on the cluster for `ReadWriteOnce` access mode. You can use `oc get storageclasses` to see what is available on your cluster.
47+
+
48+
[IMPORTANT]
49+
====
50+
You must not reuse the same `LokiStack` CR that is used for {logging}.
51+
====
52+
--
53+
4554
. Click *Create*.

0 commit comments

Comments
 (0)