You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**What it is**| Freeself-hosted edition. Server is licensed under **BSL 1.1**; Agents are **Apache 2.0**. Fully functional. | Self-hosted with a commercial license. Adds enterprise features and SLA support. | Fully managed SaaS, hosted and operated by NudgeBee. |
13
+
|**What it is**| Free, source-available self-hosted edition. The Server is licensed under **BSL 1.1** (converting to Apache 2.0 on change date); Agents are **Apache 2.0**. | Self-hosted with a commercial license. Adds enterprise features, SAML SSO, and SLA support. | Fully managed SaaS, hosted and operated by NudgeBee. |
14
14
|**Where it runs**| Your own Kubernetes cluster | Your own Kubernetes cluster |[app.nudgebee.com](https://app.nudgebee.com)|
15
15
|**Container images**| Public — `ghcr.io/nudgebee` (no authentication) | Licensed — `registry.nudgebee.com`| Managed for you |
16
16
|**License key**| Not required | Required | Managed in cloud account |
@@ -19,16 +19,12 @@ documentation — this page is the source of truth for what each one includes.
19
19
|**Support**| Community ([GitHub Issues & Discussions](https://github.com/nudgebee)) | Commercial support (SLA) | Commercial support (SLA) |
20
20
21
21
:::tip
22
-
Not sure where to start? The **Community** edition is fully functional and free
23
-
— monitoring, the Semantic Knowledge Graph, cost optimizations, troubleshooting,
24
-
the Workflow Builder, and Autopilot all work out of the box. You can move to
25
-
Enterprise or Cloud later without losing your configuration.
22
+
Not sure where to start? The **Community** edition is a production-capable self-hosted edition containing the complete core monitoring, troubleshooting, optimization, workflow, and BYOM experience — the Semantic Knowledge Graph, cost optimizations, alerting, the Workflow Builder, and Autopilot all work out of the box. You can move to Enterprise or Cloud later without losing your configuration.
26
23
:::
27
24
28
25
## What's in the Community edition
29
26
30
-
The Community edition is **fully functional** for self-hosted Kubernetes
31
-
operations. It includes:
27
+
The Community edition provides a comprehensive foundation for self-hosted Kubernetes operations. It includes:
32
28
33
29
- The NudgeBee **Server** (control plane, UI, API) and **Agent**
Copy file name to clipboardExpand all lines: doc-server/docs/index.md
+59-15Lines changed: 59 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ NudgeBee is an **AI Agents & Agentic Workflow Platform for SRE, CloudOps, and Su
11
11
NudgeBee's Semantic Knowledge Graph correlates logs, metrics, traces, and code to give your team Cloud-Ops Intelligence that reduces MTTR from hours to minutes. Pre-packaged but not a black box — every agent and workflow is fully extensible, modular, and controllable.
12
12
13
13
:::tip[Open Architecture & Licensing]
14
-
The **Community** edition is free and fully functional for internal production and operations — server licensed under **BSL 1.1** and agents under **Apache 2.0**. See [Editions & Capabilities](./editions.md) for the Community / Enterprise / Cloud comparison.
14
+
The **Community** edition is a free, source-available self-hosted edition containing the complete core monitoring, troubleshooting, optimization, workflow, and BYOM experience. The Server is licensed under **BSL 1.1**(converting to Apache 2.0 on its stated change date), and Agents are licensed under **Apache 2.0**. See [Editions & Capabilities](./editions.md) for the Community / Enterprise / Cloud comparison.
@@ -82,13 +82,13 @@ Select the path that matches your evaluation and security requirements:
82
82
83
83
## Deployment Models
84
84
85
-
NudgeBee is available in two deployment models — and self-hosted comes in two **editions** (free Community and licensed Enterprise — see [Editions](./editions.md)). Choose what fits your organization's requirements:
85
+
NudgeBee is available in two deployment models — and self-hosted comes in two **editions** (free Community and licensed Enterprise — see [Editions & Capabilities](./editions.md)). Choose what fits your organization's requirements:
86
86
87
87
||**Cloud SaaS**|**Self-Hosted (On-Prem)**|
88
88
|---|---|---|
89
-
|**How it works**| NudgeBee hosts and manages the server for you. You connect your infrastructure to the NudgeBee cloud. | You install the NudgeBee server on your own Kubernetes cluster. Available as the free open-source **Community** edition or the licensed **Enterprise** edition. |
89
+
|**How it works**| NudgeBee hosts and manages the server for you. You connect your infrastructure to the NudgeBee cloud. | You install the NudgeBee server on your own Kubernetes cluster. Available as the free Community edition (BSL 1.1) or the licensed Enterprise edition. |
90
90
|**Best for**| SRE, CloudOps, and Support teams that want to get started quickly without managing additional infrastructure. | Organizations with strict data residency, compliance, or air-gapped environment requirements — or anyone who wants a free, fully-functional self-hosted deployment. |
91
-
|**Security**| SOC 2 Type II and ISO 27001 certified. |Full data control within your own infrastructure. No telemetry — see[Telemetry & Privacy](./telemetry.md). |
91
+
|**Security & Telemetry**| SOC 2 Type II and ISO 27001 certified. |No product analytics or phone-home telemetry is sent to NudgeBee. Operational telemetry collected from your workloads remains strictly within your self-hosted environment. See[Telemetry & Privacy](./telemetry.md). |
92
92
|**Get started**| Sign up at [app.nudgebee.com](https://app.nudgebee.com)| Follow the [Server Installation Guide](./installation/server/)|
93
93
94
94
---
@@ -105,7 +105,7 @@ NudgeBee has two components, both packaged as Helm charts that deploy natively o
105
105
|**[NudgeBee Agent](./installation/agent/installation/index.md)**| Lightweight collector that runs inside each cluster you want to monitor. Collects workload data and sends it to the server. |**Everyone** — both SaaS and self-hosted users. |
106
106
107
107
:::info Infrastructure Prerequisite
108
-
**Self-hosted users**: You need a dedicated Kubernetes cluster (or namespace) to run the NudgeBee Server before connecting your monitored clusters. Sizing typically requires a 2-node cluster with 16 GB RAM and 4 cores per node. If you do not have Kubernetes clusters to run the server on, choose **Cloud SaaS**.
108
+
**Self-hosted users**: You need a Kubernetes cluster (or namespace) to run the NudgeBee Server. Sizing requires **~4 CPU cores and 8–12 GB RAM total**with bundled dependencies (PostgreSQL, RabbitMQ, Redis), or **~2–4 CPU cores and 4–8 GB RAM** with externally managed databases. See the [Server Installation Sizing Table](./installation/server/index.md#system--sizing-requirements) for details.
109
109
:::
110
110
111
111
### Architecture at a Glance
@@ -207,16 +207,60 @@ After installation or sign-up, access the NudgeBee UI:
NudgeBee supports multiple authentication methods depending on your deployment:
211
211
212
-
-**SSO (Single Sign-On)**: Log in with Google, Azure, Okta, or Auth0. Available when [authentication integration](./integrations/Authentication/) is configured.
213
-
-**Magic Link**: Enter your email address and receive a one-time login link — no password needed. This is the default method when SSO is not configured.
214
-
-**Admin Invite**: If your team admin has added you, you will receive an email invitation with a login link.
212
+
-**Bootstrap Administrator Credentials**: For initial self-hosted installation, retrieve the auto-generated password from the `nudgebee` Kubernetes secret. Disable this in production after configuring SSO.
213
+
-**SSO (Single Sign-On)**: Log in with Google, Microsoft/Azure AD, Okta, or Auth0 (all editions). SAML 2.0 with IdP group mapping is supported on Enterprise and Cloud.
214
+
-**Magic Link**: Enter your email address and receive a one-time login link — no password needed (Cloud SaaS default).
215
+
-**Admin Invite**: Accept an email invitation link sent by your organization administrator.
215
216
216
-
:::info
217
-
NudgeBee does not store passwords. Authentication is handled through SSO providers or magic email links, keeping your login secure and simple.
217
+
:::info Authentication Privacy
218
+
NudgeBee Cloud uses passwordless authentication. Self-hosted installations initially create a bootstrap administrator credential, which should be disabled after configuring production authentication.
218
219
:::
219
220
221
+
---
222
+
223
+
## Progressive Capability Matrix
224
+
225
+
NudgeBee delivers value in stages as you connect components of your stack:
226
+
227
+
| Stage | Connected Component | What It Unlocks |
228
+
|:---:|---|---|
229
+
|**1**|**Server Only**| Control plane UI, admin settings, user management, and API access |
230
+
|**2**|**K8s Agent Connected**| Real-time cluster inventory, pod health, node statuses, and Kubernetes event stream |
Copy file name to clipboardExpand all lines: doc-server/docs/installation/agent/installation/index.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -187,15 +187,17 @@ Look for log confirmation: `Connected to NudgeBee Relay successfully` and `Regis
187
187
188
188
### 4. Run Your First Investigation with NuBi (First Successful Outcome)
189
189
1. In the NudgeBee dashboard, click the **NuBi AI drawer** on the right side of the screen.
190
-
2.Run a concrete diagnostic prompt:
190
+
2.**Deterministic Cluster Overview Prompt** (verifies live telemetry on any cluster):
191
191
```text
192
-
Which workloads in this cluster have restarted or experienced OOMKills in the last 24 hours?
192
+
List the namespaces, nodes, and visible workloads in this cluster with their health status and latest telemetry timestamp.
193
193
```
194
-
3.**Expected Result**: NuBi queries live telemetry from the connected agent, correlates the Kubernetes event stream and Prometheus metrics, and returns:
195
-
- A ranked list of affected workloads, namespaces, and pod names.
196
-
- Specific failure reasons (e.g. `OOMKilled exit code 137` or failed readiness probes).
197
-
- Recommended rightsizing actions or direct links to inspect pod logs.
198
-
4.**Success Verification**: When you receive a structured response grounded in your cluster's live workloads, your agent telemetry pipeline is verified and fully operational.
194
+
**Expected Result**: NuBi inspects live cluster state and returns a structured summary table listing detected namespaces, node capacities, active workload counts, and recent telemetry heartbeat timestamps.
Which workloads in this cluster have restarted, entered CrashLoopBackOff, or experienced OOMKills in the last 24 hours?
198
+
```
199
+
**Expected Result**: On a healthy cluster, NuBi confirms 0 active restart anomalies. On clusters with issues, it provides a ranked list with exit codes and remediation suggestions.
200
+
4.**Success Verification**: When you receive structured responses grounded in your cluster's live workloads, your agent telemetry pipeline is verified and fully operational.
Copy file name to clipboardExpand all lines: doc-server/docs/installation/server/index.md
+17-19Lines changed: 17 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,10 +17,10 @@ The NudgeBee Server is the central control plane of the NudgeBee platform. It ho
17
17
:::
18
18
19
19
:::tip[Choosing an edition]
20
-
The self-hosted server comes in two editions (see [Editions](../../editions.md) for the full comparison):
20
+
The self-hosted server comes in two editions (see [Editions & Capabilities](../../editions.md) for the full comparison):
21
21
22
-
-**Community** <Community/> — free and open source (Apache 2.0), fully functional. Images are pulled from the public `ghcr.io/nudgebee` registry. **No license key required.** OAuth SSO (Google, Okta, OneLogin, Azure AD / B2C, Auth0), magic-link email, and credentials login are all included.
23
-
-**Enterprise** <Enterprise/> — adds **SAML 2.0** SSO, NudgeBee's managed models (`nb-llm`, `nb-slm`), and commercial support. Images are pulled from `registry.nudgebee.com` and require a license key.
22
+
-**Community** <Community/> — free, source-available self-hosted edition. The Server is licensed under **BSL 1.1** (converting to Apache 2.0 on its stated change date); Agents are **Apache 2.0**. Images are pulled from the public `ghcr.io/nudgebee` registry. **No license key required.** OAuth SSO (Google, Okta, OneLogin, Azure AD / B2C, Auth0), magic-link email, and credentials login are all included.
23
+
-**Enterprise** <Enterprise/> — adds **SAML 2.0** SSO, NudgeBee's managed models (`nb-llm`, `nb-slm`), and commercial SLA support. Images are pulled from `registry.nudgebee.com` and require a license key.
24
24
25
25
The installation steps below use tabs — pick your edition in each step.
26
26
:::
@@ -262,13 +262,17 @@ Replace `<your-license-key>` with your NudgeBee license key and generate
262
262
### Step 3: Run the Helm Install
263
263
264
264
```shell
265
+
# 1. Set your target Kubernetes context (or omit --kube-context if already using current context):
To install a specific version, add `--version $CHART_VERSION` to the command. See the [Server Releases](../../releases/server/) page for available versions.
@@ -335,7 +339,7 @@ You should receive an `HTTP/1.1 200 OK` (or `307 Temporary Redirect` to `/auth/s
@@ -359,20 +362,15 @@ Use your admin email (e.g. `admin@nudgebee.local` or the email provided during i
359
362
360
363
---
361
364
362
-
## 5. Verify Your First Successful Outcome with NuBi
365
+
## 5. Verify Control Plane Health & Next Steps
366
+
367
+
Once logged into the dashboard, complete your initial control plane verification:
363
368
364
-
Once logged into the dashboard, verify end-to-end intelligence by running your first AI-SRE investigation:
369
+
1. **Verify UI & Dashboard Navigation**: Navigate through **Kubernetes**, **Troubleshoot**, and **Optimizations** to confirm all views load without errors.
370
+
2. **Connect an LLM Provider (BYOM)**: Navigate to **Settings → AI / LLM** and configure your API key ([OpenAI, AWS Bedrock, or Ollama](../../integrations/LLM/)) to enable NuBi AI investigations and automated RCA.
371
+
3. **Next Step: Install the K8s Agent**: The NudgeBee Server is the control plane. To begin ingesting real-time pod telemetry, logs, and metrics from your target clusters, proceed to:
365
372
366
-
1. **Open the NuBi AI Drawer**: Click the **NuBi** icon in the right-hand sidebar or navigation bar.
367
-
2. **Run a Concrete Diagnostic Prompt**:
368
-
```text
369
-
What workloads in this cluster have experienced restarts or OOMKills in the last 24 hours?
370
-
```
371
-
3. **Expected Result**: NuBi inspects live telemetry, queries the Kubernetes event stream, and responds with:
372
-
- A structured list of affected workloads, namespaces, and pod names.
373
-
- Exact exit codes (e.g. `137 OOMKilled` or `CrashLoopBackOff`).
374
-
- Root cause hypothesis and recommended next steps (e.g. memory request adjustments or inspecting application stack traces).
375
-
4. **Success Verification**: When you receive a structured response with direct links to the relevant workloads, your NudgeBee Control Plane and AI engine are verified and healthy!
373
+
👉 **[Install the NudgeBee Agent on Your Cluster](../agent/installation/index.md)**
0 commit comments