Skip to content

Commit 22e7c2b

Browse files
new docs: Kubernetes Scaling, SSO Claim Parser, and SSO Claim Samples
1 parent 9093228 commit 22e7c2b

File tree

4 files changed

+1748
-1
lines changed

4 files changed

+1748
-1
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
This page describes how OpenObserve handles Kubernetes scaling actions.
2+
!!! note "Note"
3+
This is an enterprise feature.
4+
Refer to the [Enterprise Edition Installation Guide](https://openobserve.ai/docs/openobserve-enterprise-edition-installation-guide/) for deployment steps.
5+
6+
## Overview
7+
Kubernetes manages the scaling of OpenObserve pods based on system load.
8+
OpenObserve does not make scaling decisions. It only reacts to the actions taken by Kubernetes.
9+
10+
## When Kubernetes scales up
11+
Kubernetes adds more OpenObserve pods when load increases.
12+
The new pods join the cluster and start serving traffic or ingesting data immediately.
13+
No special action is required inside OpenObserve.
14+
15+
## When Kubernetes scales down
16+
Kubernetes selects a pod to remove.
17+
Before stopping it, the Helm chart calls the OpenObserve drain API.
18+
OpenObserve starts the graceful drain workflow.
19+
20+
## Graceful drain workflow
21+
1. The ingester flushes all in-memory data into its write-ahead log on disk.
22+
2. The background file processing job switches into drain mode and continues running until all pending data files are processed and uploaded.
23+
3. OpenObserve exposes a drain status API that reports the progress of this workflow.
24+
4. When draining is complete and no pending data remains, OpenObserve reports that the node is ready for shutdown.
25+
5. Kubernetes then terminates the pod safely.

docs/user-guide/identity-and-access-management/.pages

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ nav:
55
- Single Sign-On (SSO): sso.md
66
- Organizations: organizations.md
77
- Quotas: quotas
8-
- Manage Users & Passwords: update-password.md
8+
- Manage Users & Passwords: update-password.md
9+
- SSO Claim Parser: sso-claim-parser.md
10+
- SSO Claim Samples: sso-claim-samples.md

0 commit comments

Comments
 (0)