Skip to content

Commit 6a47d7f

Browse files
prithvipatil97openshift-cherrypick-robot
authored andcommitted
Update LokiStack configuration with global limits for retention and managementState
Doc Reference: https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/installing_logging/installing-logging#install-loki-operator-cli_installing-logging By default, the retention config is not mentioned in standard installation YAML because of which end users use the exact same config for deployment and then object storage get flooded with a lot of logs. This breaks ODF and impacts the applications consuming storage from ODF. It is required to add retention config in standard installation YAML in the documentation. If there is no retention, then the logs will not be remove / cleaned up from object storage until retention is configured or until lifecycle policy is configured on the object bucket. [new commit] Update LokiStack configuration with global limits for retention and managementState Doc Reference: https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/installing_logging/installing-logging#install-loki-operator-cli_installing-logging By default, the retention config is not mentioned in standard installation YAML because of which end users use the exact same config for deployment and then object storage get flooded with a lot of logs. This breaks ODF and impacts the applications consuming storage from ODF. It is required to add retention config in standard installation YAML in the documentation. If there is no retention, then the logs will not be remove / cleaned up from object storage until retention is configured or until lifecycle policy is configured on the object bucket. Here is the updated config: ~~~ apiVersion: loki.grafana.com/v1 kind: LokiStack metadata: name: logging-loki 1 namespace: openshift-logging 2 spec: managementState: Managed limits: global: 3 retention: 4 days: 20 # Set the value as per requirement. size: 1x.small 5 storage: schemas: - version: v13 effectiveDate: "<yyyy>-<mm>-<dd>" 6 secret: name: logging-loki-s3 7 type: s3 8 storageClassName: <storage_class_name> 9 tenants: mode: openshift-logging 10 ~~~
1 parent 8afa5a7 commit 6a47d7f

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

modules/installing-loki-operator-cli.adoc

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -149,26 +149,33 @@ metadata:
149149
name: logging-loki # <1>
150150
namespace: openshift-logging # <2>
151151
spec:
152-
size: 1x.small # <3>
152+
managementState: Managed
153+
limits:
154+
global: # <3>
155+
retention: # <4>
156+
days: 20 # Set the value as per requirement
157+
size: 1x.small # <5>
153158
storage:
154159
schemas:
155160
- version: v13
156-
effectiveDate: "<yyyy>-<mm>-<dd>" # <4>
161+
effectiveDate: "<yyyy>-<mm>-<dd>" # <6>
157162
secret:
158-
name: logging-loki-s3 # <5>
159-
type: s3 # <6>
160-
storageClassName: <storage_class_name> # <7>
163+
name: logging-loki-s3 # <7>
164+
type: s3 # <8>
165+
storageClassName: <storage_class_name> # <9>
161166
tenants:
162-
mode: openshift-logging # <8>
167+
mode: openshift-logging # <10>
163168
----
164169
<1> Use the name `logging-loki`.
165170
<2> You must specify `openshift-logging` as the namespace.
166-
<3> Specify the deployment size. Supported size options for production instances of Loki are `1x.extra-small`, `1x.small`, or `1x.medium`. Additionally, `1x.pico` is supported starting with {logging} 6.1.
167-
<4> For new installations this date should be set to the equivalent of "yesterday", as this will be the date from when the schema takes effect.
168-
<5> Specify the name of your log store secret.
169-
<6> Specify the corresponding storage type.
170-
<7> Specify the name of a storage class for temporary storage. For best performance, specify a storage class that allocates block storage. You can list the available storage classes for your cluster by using the `oc get storageclasses` command.
171-
<8> The `openshift-logging` mode is the default tenancy mode where a tenant is created for log types, such as audit, infrastructure, and application. This enables access control for individual users and user groups to different log streams.
171+
<3> Define global limits that apply to the LokiStack instance. For information about setting stream-based retention, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/configuring_logging/configuring-lokistack-storage#logging-loki-retention_configuring-the-log-store[Enabling stream-based retention with Loki]. This field does not impact the retention period for stored logs in object storage.
172+
<4> Retention is enabled in the cluster when this block is added to the CR.
173+
<5> Specify the deployment size. Supported size options for production instances of Loki are `1x.extra-small`, `1x.small`, or `1x.medium`. Additionally, `1x.pico` is supported starting with {logging} 6.1.
174+
<6> For new installations this date should be set to the equivalent of "yesterday", as this will be the date from when the schema takes effect.
175+
<7> Specify the name of your log store secret.
176+
<8> Specify the corresponding storage type.
177+
<9> Specify the name of a storage class for temporary storage. For best performance, specify a storage class that allocates block storage. You can list the available storage classes for your cluster by using the `oc get storageclasses` command.
178+
<10> The `openshift-logging` mode is the default tenancy mode where a tenant is created for log types, such as audit, infrastructure, and application. This enables access control for individual users and user groups to different log streams.
172179

173180

174181
. Apply the `LokiStack` CR object by running the following command:

0 commit comments

Comments
 (0)