Skip to content

Commit 4b16bc4

Browse files
docs: hide docs for experimental feature (backport k248) (#17295)
Co-authored-by: J Stickler <julie.stickler@grafana.com>
1 parent d52b2fc commit 4b16bc4

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

docs/sources/operations/loki-ui/_index.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,57 @@
11
---
2-
title: Loki Deployment UI
2+
title: Loki deployment user interface
33
menuTitle: Loki UI
4-
description: Describes how to setup and use the Loki Deployment UI
4+
description: Describes how to setup and use the Loki Deployment UI.
5+
draft: true
56
weight: 100
67
---
7-
# Loki Deployment UI
8+
9+
# Loki deployment user interface
810

911
{{< admonition type="warning" >}}
10-
The Loki Deployment UI is experimental and subject to change. Before attempting to deploy the Loki make sure to consult the [Considerations](#considerations) section.
12+
The Loki Deployment UI is experimental and subject to change. Before attempting to deploy the Loki UI, make sure to consult the [Considerations](#considerations) section.
1113
{{< /admonition >}}
1214

1315
The Loki Deployment UI is a web-based user interface that allows you to manage and monitor a Loki deployment in [microservice mode](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#microservices-mode) or [single binary mode](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#monolithic-mode).
1416

1517
{{< figure max-width="100%" src="/media/docs/loki/loki-ui.png" caption="Loki UI Home Page" >}}
1618

17-
## Accessing the Loki Deployment UI
18-
19-
The Loki Deployment UI is available at the following URL:
20-
21-
```
22-
http://<LOKI_HOST>:<LOKI_PORT>/ui
23-
```
19+
## Considerations
2420

25-
Where `<LOKI_HOST>` is the hostname or IP address of the Loki server and `<LOKI_PORT>` is the port number that Loki is running on. By default, Loki runs on port `3100`. If you are running Loki in Kubernetes the UI is made accessible via the `loki-gateway` service. Either by port-forwarding or by exposing the service via a LoadBalancer.
21+
The Loki Deployment UI is experimental and subject to change. Before attempting to deploy the Loki make sure to consult the following considerations:
2622

27-
{{< admonition type="caution" >}}
28-
`/ui` currently cannot be changed to another path. This would require further contribution.
29-
{{< /admonition >}}
23+
1. Not all features are available in the Loki Deployment UI. Some features are still in development.
24+
1. There is no authentication or authorization in the Loki Deployment UI. This means that anyone with access to the UI can make make delete requests, change log levels, etc.
25+
1. This UI is not intended to replace meta-monitoring for Loki.
3026

3127
## Deployment
3228

33-
Each Loki component now includes the UI service. When running Loki as a docker container, the UI service is enabled by default. No additional configuration is required.
29+
Each Loki component now includes the UI service.
3430

35-
For Loki helm users discoverability of the UI service needs to be enabled in the Loki configuration. To enable the UI discoverability, add the following paramter to the `loki` section of the `values.yaml` file:
31+
When running Loki as a docker container, the UI service is enabled by default. No additional configuration is required.
32+
33+
For Loki Helm users discoverability of the UI service needs to be enabled in the Loki configuration. To enable the UI discoverability, add the following paramter to the `loki` section of the `values.yaml` file:
3634

3735
```yaml
3836
loki:
3937
ui:
4038
enabled: true
4139
```
4240
41+
## Accessing the Loki Deployment UI
42+
43+
The Loki Deployment UI is available at the following URL:
44+
45+
```
46+
http://<LOKI_HOST>:<LOKI_PORT>/ui
47+
```
48+
49+
Where `<LOKI_HOST>` is the hostname or IP address of the Loki server and `<LOKI_PORT>` is the port number that Loki is running on. By default, Loki runs on port `3100`. If you are running Loki in Kubernetes the UI is made accessible via the `loki-gateway` service. Either by port-forwarding or by exposing the service via a LoadBalancer.
50+
51+
{{< admonition type="caution" >}}
52+
Currently `/ui` cannot be changed to another path. This would require further contributions to the code base.
53+
{{< /admonition >}}
54+
4355
## Features
4456

4557
The Loki Deployment UI provides the following features to manage and monitor a Loki deployment:
@@ -56,7 +68,6 @@ The Loki Deployment UI provides the following features to manage and monitor a L
5668
| [Labels](#labels) | View Label stats | Coming Soon |
5769
| [Rules](#rules) | View and manage rules | Coming Soon |
5870

59-
6071
### Nodes
6172

6273
The Nodes page displays the status of each Loki component deployed. Depending on the deployment mode, each component will either be considered a node or a service. Below is a screenshot of the Nodes table for a microservices deployment:
@@ -99,7 +110,6 @@ This feature is coming soon.
99110

100111
{{< /admonition >}}
101112

102-
103113
### Rings
104114

105115
Rings section of the Loki UI provides a view of the status of the ring members. There can be a total of 5 rings in a Loki deployment. Each ring is responsible for a specific task. Note that not all rings will be present in a deployment, this is dependent on how you have configured your Loki deployment. For example Index Gateway and Query Scheduler both require explicit configuration to be enabled.
@@ -194,11 +204,4 @@ This feature is coming soon.
194204

195205
This feature is coming soon.
196206

197-
{{< /admonition >}}
198-
199-
## Considerations
200-
201-
The Loki Deployment UI is experimental and subject to change. Before attempting to deploy the Loki make sure to consult the following considerations:
202-
1. Not all features are available in the Loki Deployment UI. Some features are still in development.
203-
2. There is no authentication or authorization in the Loki Deployment UI. This means that anyone with access to the UI can make make delete requests, change log levels, etc.
204-
3. This UI is not intended to replace meta monitoring for Loki.
207+
{{< /admonition >}}

0 commit comments

Comments
 (0)