Skip to content

[enterprise-4.13] [DOCS] OBSDOCS-323 Add Disclaimer to Loki Documentation #67210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2023
Merged

[enterprise-4.13] [DOCS] OBSDOCS-323 Add Disclaimer to Loki Documentation #67210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions logging/cluster-logging-loki.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ include::modules/loki-deployment-sizing.adoc[leveloffset=+1]

include::modules/cluster-logging-loki-deploy.adoc[leveloffset=+1]

include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+1]

include::modules/logging-loki-gui-install.adoc[leveloffset=+1]
////
include::modules/logging-loki-restart-hardening.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion modules/cluster-logging-loki-deploy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,4 @@ endif::[]
.. Under Console plugin, click *Disabled*.
.. Select *Enable* and then *Save*. This change restarts the `openshift-console` pods.
.. After the pods restart, you will receive a notification that a web console update is available, prompting you to refresh.
.. After refreshing the web console, click *Observe* from the left main menu. A new option for *Logs* is available.
.. After refreshing the web console, click *Observe* from the left main menu. A new option for *Logs* is available.
32 changes: 32 additions & 0 deletions modules/logging-creating-new-group-cluster-admin-user-role.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Module included in the following assemblies:

// cluster-logging-loki.adoc

:_mod-docs-content-type: PROCEDURE
[id="logging-creating-new-group-cluster-admin-user-role_{context}"]
= Creating a new group for the cluster-admin user role

include::snippets/logging-clusteradmin-access-logs-snip.adoc[]

Use the following procedure to create a new group for users with `cluster-admin` permissions.

.Procedure

. Enter the following command to create a new group:
+
[source,terminal]
----
$ oc adm groups new cluster-admin
----
. Enter the following command to add the desired user to the `cluster-admin` group:
+
[source,terminal]
----
$ oc adm groups add-users cluster-admin <username>
----
. Enter the following command to add `cluster-admin` user role to the group:
+
[source,terminal]
----
$ oc adm policy add-cluster-role-to-group cluster-admin cluster-admin
----
13 changes: 13 additions & 0 deletions snippets/logging-clusteradmin-access-logs-snip.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// Text snippet included in the following assemblies:
//
//
// Text snippet included in the following modules:
//
// * modules/logging-creating-new-group-cluster-admin-user-role.adoc
//
:_mod-docs-content-type: SNIPPET

[IMPORTANT]
====
Querying application logs for multiple namespaces as a `cluster-admin` user, where the sum total of characters of all of the namespaces in the cluster is greater than 5120, results in the error `Parse error: input size too long (XXXX > 5120)`. For better control over access to logs in LokiStack, make the `cluster-admin` user a member of the `cluster-admin` group. If the `cluster-admin` group does not exist, create it and add the desired users to it.
====