Skip to content

Commit 86ee5ed

Browse files
mjpytlakmjpytlak
authored
Merge pull request #67435 from abrennan89/OBSDOCS-478
OBSDOCS-478: 1x.extra-small Loki support docs
2 parents 9a45f93 + 371f508 commit 86ee5ed

File tree

5 files changed

+105
-76
lines changed

5 files changed

+105
-76
lines changed

‎logging/cluster-logging-support.adoc

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
////
10-
Getting support - possibly add general OCP docs?
11-
ifdef::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[]
12-
13-
include::modules/support.adoc[leveloffset=+1]
14-
include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
15-
include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
16-
include::modules/support-submitting-a-case.adoc[leveloffset=+1]
17-
18-
endif::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[]
19-
////
209
include::snippets/logging-supported-config-snip.adoc[]
2110
include::snippets/logging-compatibility-snip.adoc[]
2211

@@ -30,6 +19,35 @@ The {logging-title} is not:
3019
* A guaranteed log sink
3120
* Secure storage - audit logs are not stored by default
3221
22+
[id="cluster-logging-support-CRDs"]
23+
== Supported API custom resource definitions
24+
25+
LokiStack development is ongoing. Not all APIs are currently supported.
26+
27+
.Loki API support states
28+
[cols="3",options="header"]
29+
|===
30+
|CustomResourceDefinition (CRD)
31+
|ApiVersion
32+
|Support state
33+
34+
|LokiStack
35+
|lokistack.loki.grafana.com/v1
36+
|Supported in 5.5
37+
38+
|RulerConfig
39+
|rulerconfig.loki.grafana/v1
40+
|Supported in 5.7
41+
42+
|AlertingRule
43+
|alertingrule.loki.grafana/v1
44+
|Supported in 5.7
45+
46+
|RecordingRule
47+
|recordingrule.loki.grafana/v1
48+
|Supported in 5.7
49+
|===
50+
3351
include::modules/cluster-logging-maintenance-support-list.adoc[leveloffset=+1]
3452
include::modules/unmanaged-operators.adoc[leveloffset=+1]
3553

‎logging/logging_alerts/custom-logging-alerts.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ In logging 5.7 and later versions, users can configure the LokiStack deployment
1010

1111
LokiStack log-based alerts and recorded metrics are triggered by providing link:https://grafana.com/docs/loki/latest/query/[LogQL] expressions to the ruler component. The Loki Operator manages a ruler that is optimized for the selected LokiStack size, which can be `1x.extra-small`, `1x.small`, or `1x.medium`.
1212

13-
[NOTE]
14-
====
15-
The `1x.extra-small` size is not supported. It is for demonstration purposes only.
16-
====
17-
1813
To provide these expressions, you must create an `AlertingRule` custom resource (CR) containing Prometheus-compatible link:https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/[alerting rules], or a `RecordingRule` CR containing Prometheus-compatible link:https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/[recording rules].
1914

2015
Administrators can configure log-based alerts or recorded metrics for `application`, `audit`, or `infrastructure` tenants. Users without administrator permissions can configure log-based alerts or recorded metrics for `application` tenants of the applications that they have access to.

‎modules/loki-deployment-sizing.adoc

Lines changed: 73 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,77 @@
11
// Module is included in the following assemblies:
2-
//cluster-logging-loki.adoc
2+
// * logging/cluster-logging-loki.adoc
3+
// * network_observability/installing-operators.adoc
4+
5+
ifeval::["{context}" == "cluster-logging-loki"]
6+
:restricted:
7+
endif::[]
38

49
:_mod-docs-content-type: CONCEPT
510
[id="loki-deployment-sizing_{context}"]
6-
= Deployment Sizing
7-
8-
Sizing for Loki follows the format of `N<x>._<size>_` where the value `<N>` is number of instances and `<size>` specifies performance capabilities.
9-
10-
[NOTE]
11-
====
12-
1x.extra-small is for demo purposes only, and is not supported.
13-
====
14-
15-
.Loki Sizing
16-
[options="header"]
17-
|========================================================================================
18-
| | 1x.extra-small | 1x.small | 1x.medium
19-
| *Data transfer* | Demo use only. | 500GB/day | 2TB/day
20-
| *Queries per second (QPS)* | Demo use only. | 25-50 QPS at 200ms | 25-75 QPS at 200ms
21-
| *Replication factor* | None | 2 | 3
22-
| *Total CPU requests* | 5 vCPUs | 36 vCPUs | 54 vCPUs
23-
| *Total Memory requests* | 7.5Gi | 63Gi | 139Gi
24-
| *Total Disk requests* | 150Gi | 300Gi | 450Gi
25-
|========================================================================================
26-
27-
[id="CRD-API-support_{context}"]
28-
== Supported API Custom Resource Definitions
29-
LokiStack development is ongoing, not all APIs are supported currently supported.
30-
31-
[options="header"]
32-
|=====================================================================
33-
| CustomResourceDefinition (CRD)| ApiVersion | Support state
34-
| LokiStack | lokistack.loki.grafana.com/v1 | Supported in 5.5
35-
| RulerConfig | rulerconfig.loki.grafana/v1beta1 | Technology Preview
36-
| AlertingRule | alertingrule.loki.grafana/v1beta1 | Technology Preview
37-
| RecordingRule | recordingrule.loki.grafana/v1beta1 | Technology Preview
38-
|=====================================================================
39-
40-
:FeatureName: Usage of `RulerConfig`, `AlertingRule` and `RecordingRule` custom resource definitions (CRDs).
41-
include::snippets/technology-preview.adoc[]
11+
= Loki deployment sizing
12+
13+
Sizing for Loki follows the format of `<N>x.<size>` where the value `<N>` is number of instances and `<size>` specifies performance capabilities.
14+
15+
.Loki sizing
16+
[cols="1h,3*",options="header"]
17+
|===
18+
|
19+
|1x.extra-small
20+
|1x.small
21+
|1x.medium
22+
23+
|Data transfer
24+
|100GB/day
25+
|500GB/day
26+
|2TB/day
27+
28+
|Queries per second (QPS)
29+
|1-25 QPS at 200ms
30+
|25-50 QPS at 200ms
31+
|25-75 QPS at 200ms
32+
33+
|Replication factor
34+
|2
35+
|2
36+
|2
37+
38+
|Total CPU requests
39+
|14 vCPUs
40+
|34 vCPUs
41+
|54 vCPUs
42+
43+
ifdef::restricted[]
44+
|Total CPU requests if using the ruler
45+
|16 vCPUs
46+
|42 vCPUs
47+
|70 vCPUs
48+
endif::restricted[]
49+
50+
|Total memory requests
51+
|31Gi
52+
|67Gi
53+
|139Gi
54+
55+
ifdef::restricted[]
56+
|Total memory requests if using the ruler
57+
|35Gi
58+
|83Gi
59+
|171Gi
60+
endif::restricted[]
61+
62+
|Total disk requests
63+
|430Gi
64+
|430Gi
65+
|590Gi
66+
67+
ifdef::restricted[]
68+
|Total disk requests if using the ruler
69+
|650Gi
70+
|650Gi
71+
|910Gi
72+
endif::restricted[]
73+
|===
74+
75+
ifeval::["{context}" == "cluster-logging-loki"]
76+
:!restricted:
77+
endif::[]

‎modules/network-observability-lokistack-create.adoc

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-lokistack-create_{context}"]
77
= Creating a LokiStack custom resource
8+
89
You can deploy a LokiStack using the web console or CLI to create a namespace, or new project.
910

1011
include::snippets/logging-clusteradmin-access-logs-snip.adoc[]
@@ -45,24 +46,3 @@ For more information about creating a `cluster-admin` group, see the "Additional
4546
You must not reuse the same `LokiStack` that is used for cluster logging.
4647
====
4748
. Click *Create*.
48-
49-
[id="deployment-sizing_{context}"]
50-
== Deployment Sizing
51-
Sizing for Loki follows the format of `N<x>._<size>_` where the value `<N>` is the number of instances and `<size>` specifies performance capabilities.
52-
53-
[NOTE]
54-
====
55-
1x.extra-small is for demo purposes only, and is not supported.
56-
====
57-
58-
.Loki Sizing
59-
[options="header"]
60-
|========================================================================================
61-
| | 1x.extra-small | 1x.small | 1x.medium
62-
| *Data transfer* | Demo use only. | 500GB/day | 2TB/day
63-
| *Queries per second (QPS)* | Demo use only. | 25-50 QPS at 200ms | 25-75 QPS at 200ms
64-
| *Replication factor* | None | 2 | 3
65-
| *Total CPU requests* | 5 vCPUs | 36 vCPUs | 54 vCPUs
66-
| *Total Memory requests* | 7.5Gi | 63Gi | 139Gi
67-
| *Total Disk requests* | 150Gi | 300Gi | 450Gi
68-
|========================================================================================

‎network_observability/installing-operators.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,17 @@ include::modules/network-observability-loki-secret.adoc[leveloffset=+2]
2727
* For more information about the option to use different namespaces for the separate components, see the `spec.loki.tls.caCert.namespace` specification in the xref:../network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference] and callout number 5 in the xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource].
2828
2929
include::modules/network-observability-lokistack-create.adoc[leveloffset=+2]
30+
3031
[role="_additional-resources"]
3132
.Additional resources
3233
* xref:../logging/cluster-logging-loki.adoc#logging-creating-new-group-cluster-admin-user-role_cluster-logging-loki[Creating a new group for the cluster-admin user role]
3334
35+
include::modules/loki-deployment-sizing.adoc[leveloffset=+2]
3436
include::modules/network-observability-lokistack-ingestion-query.adoc[leveloffset=+2]
3537
include::modules/network-observability-auth-multi-tenancy.adoc[leveloffset=+2]
3638
include::modules/network-observability-multitenancy.adoc[leveloffset=+2]
3739
include::modules/network-observability-operator-install.adoc[leveloffset=+1]
3840
39-
4041
[role="_additional-resources"]
4142
[id="additional-resources_configuring-flow-collector-considerations"]
4243
== Important Flow Collector configuration considerations
@@ -66,4 +67,3 @@ include::modules/network-observability-kafka-option.adoc[leveloffset=+1]
6667
xref:../network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the FlowCollector resource with Kafka].
6768
6869
include::modules/network-observability-operator-uninstall.adoc[leveloffset=+1]
69-

0 commit comments

Comments
 (0)