Skip to content

Commit adef745

Browse files
committed
docs: resolve licensing, authentication, sizing, telemetry, and onboarding sequencing review items
1 parent 23d5279 commit adef745

4 files changed

Lines changed: 88 additions & 48 deletions

File tree

doc-server/docs/editions.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ documentation — this page is the source of truth for what each one includes.
1010

1111
| | **Community** <Community/> | **Enterprise** <Enterprise/> | **Cloud** <Cloud/> |
1212
|---|---|---|---|
13-
| **What it is** | Free self-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. |
1414
| **Where it runs** | Your own Kubernetes cluster | Your own Kubernetes cluster | [app.nudgebee.com](https://app.nudgebee.com) |
1515
| **Container images** | Public — `ghcr.io/nudgebee` (no authentication) | Licensed — `registry.nudgebee.com` | Managed for you |
1616
| **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.
1919
| **Support** | Community ([GitHub Issues & Discussions](https://github.com/nudgebee)) | Commercial support (SLA) | Commercial support (SLA) |
2020

2121
:::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.
2623
:::
2724

2825
## What's in the Community edition
2926

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:
3228

3329
- The NudgeBee **Server** (control plane, UI, API) and **Agent**
3430
- The **Semantic Knowledge Graph**

doc-server/docs/index.md

Lines changed: 59 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ NudgeBee is an **AI Agents & Agentic Workflow Platform for SRE, CloudOps, and Su
1111
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.
1212

1313
:::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.
1515
:::
1616

1717
<div style={{position: "relative", paddingBottom: "62.5%", height: 0}}><iframe src="https://www.loom.com/embed/0691f374484541468dcfb6d71fedd817?sid=970a6eb4-c0e9-40a2-b2c9-9ba145231f54" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{position: "absolute", top: 0, left: 0, width: "100%", height: "100%"}}></iframe></div>
@@ -44,8 +44,8 @@ Select the path that matches your evaluation and security requirements:
4444
<p style={{ fontSize: '0.85rem', color: '#666' }}><strong>Estimated time:</strong> 20–30 minutes</p>
4545
<ol style={{ paddingLeft: '1.2rem', fontSize: '0.9rem' }}>
4646
<li><a href="./installation/server/">Deploy NudgeBee Server</a> using the default Helm chart.</li>
47+
<li><a href="./installation/agent/installation/">Install the Agent</a> on your monitored cluster.</li>
4748
<li>Connect your <a href="./integrations/LLM/">BYOM model provider</a> (OpenAI, Bedrock, Ollama).</li>
48-
<li><a href="./installation/agent/installation/">Install the Agent</a> to start gathering cluster telemetry.</li>
4949
</ol>
5050
</div>
5151
<a href="./installation/server/" className="button button--secondary button--block" style={{ marginTop: '1rem' }}>Community Quick Start →</a>
@@ -57,9 +57,9 @@ Select the path that matches your evaluation and security requirements:
5757
<p style={{ fontSize: '0.9rem', color: '#555' }}><strong>Best for:</strong> Production-grade deployments requiring SAML SSO, high availability, and compliance.</p>
5858
<p style={{ fontSize: '0.85rem', color: '#666' }}><strong>Estimated time:</strong> 30–60+ minutes</p>
5959
<ol style={{ paddingLeft: '1.2rem', fontSize: '0.9rem' }}>
60-
<li>Provision external PostgreSQL, Redis, and RabbitMQ.</li>
61-
<li>Deploy the Server with <a href="./installation/server/">Enterprise Helm values</a> and license key.</li>
62-
<li>Configure <a href="./integrations/Authentication/SAML">SAML 2.0 SSO</a> and air-gapped SLMs.</li>
60+
<li>Choose bundled dependencies for evaluation, or external PostgreSQL & RabbitMQ for HA.</li>
61+
<li>Deploy Server with <a href="./installation/server/">Enterprise Helm values</a> and license key.</li>
62+
<li>Optionally configure <a href="./integrations/Authentication/SAML">SAML 2.0 SSO</a> and air-gapped SLMs.</li>
6363
</ol>
6464
</div>
6565
<a href="./installation/server/" className="button button--secondary button--block" style={{ marginTop: '1rem' }}>Enterprise Setup Guide →</a>
@@ -82,13 +82,13 @@ Select the path that matches your evaluation and security requirements:
8282

8383
## Deployment Models
8484

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:
8686

8787
| | **Cloud SaaS** | **Self-Hosted (On-Prem)** |
8888
|---|---|---|
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. |
9090
| **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). |
9292
| **Get started** | Sign up at [app.nudgebee.com](https://app.nudgebee.com) | Follow the [Server Installation Guide](./installation/server/) |
9393

9494
---
@@ -105,7 +105,7 @@ NudgeBee has two components, both packaged as Helm charts that deploy natively o
105105
| **[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. |
106106

107107
:::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.
109109
:::
110110

111111
### Architecture at a Glance
@@ -207,16 +207,60 @@ After installation or sign-up, access the NudgeBee UI:
207207

208208
### Login Options
209209

210-
NudgeBee supports multiple authentication methods:
210+
NudgeBee supports multiple authentication methods depending on your deployment:
211211

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.
215216

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.
218219
:::
219220

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 |
231+
| **3** | **Metrics & Observability** | CPU/memory utilization graphs, SLO tracking, rightsizing recommendations, and cost breakdown |
232+
| **4** | **LLM (BYOM) Connected** | NuBi AI Assistant, natural-language cluster queries, automated incident RCA, and runbook suggestions |
233+
| **5** | **Notifications (Slack / Teams)** | Incident alerting, interactive ChatOps triage buttons, and daily digest summaries |
234+
| **6** | **Git Repository (GitHub / GitLab)** | Automated PR generation for resource limit changes and GitOps reconciliation |
235+
236+
---
237+
238+
## Onboarding Troubleshooting Decision Tree
239+
240+
If you encounter an issue during initial setup, use this decision tree to pinpoint the cause:
241+
242+
```text
243+
1. Can you load the Web UI at http://localhost:3000 (or your ingress domain)?
244+
├── NO → Check server pods: `kubectl get pods -n nudgebee`
245+
│ See Server Troubleshooting: /docs/installation/server/#troubleshooting-installation-failures
246+
└── YES → Proceed to step 2
247+
248+
2. Does your Kubernetes cluster appear with a "Connected" badge in the UI?
249+
├── NO → Check agent runner logs: `kubectl logs -n nudgebee-agent -l app=nudgebee-runner`
250+
│ Ensure outbound TCP port 443 is permitted in your cluster NetworkPolicy.
251+
└── YES → Proceed to step 3
252+
253+
3. Are CPU and memory metric charts populating for workloads?
254+
├── NO → Verify Prometheus URL: check `globalConfig.prometheus_url` in agent values.yaml.
255+
└── YES → Proceed to step 4
256+
257+
4. Does NuBi answer natural-language cluster questions?
258+
├── NO → Verify BYOM model provider API key under Settings → AI / LLM.
259+
└── YES → Setup is healthy and complete!
260+
```
261+
262+
---
263+
220264
### What to Do After Your First Login
221265

222266
Once you are logged in, here is what to explore first:

doc-server/docs/installation/agent/installation/index.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -187,15 +187,17 @@ Look for log confirmation: `Connected to NudgeBee Relay successfully` and `Regis
187187

188188
### 4. Run Your First Investigation with NuBi (First Successful Outcome)
189189
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):
191191
```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.
193193
```
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.
195+
3. **Follow-Up Diagnostic Prompt** (for incident triage):
196+
```text
197+
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.
199201

200202
---
201203

doc-server/docs/installation/server/index.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ The NudgeBee Server is the central control plane of the NudgeBee platform. It ho
1717
:::
1818

1919
:::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):
2121

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.
2424

2525
The installation steps below use tabs — pick your edition in each step.
2626
:::
@@ -262,13 +262,17 @@ Replace `<your-license-key>` with your NudgeBee license key and generate
262262
### Step 3: Run the Helm Install
263263

264264
```shell
265+
# 1. Set your target Kubernetes context (or omit --kube-context if already using current context):
266+
export KUBE_CONTEXT="$(kubectl config current-context)"
267+
268+
# 2. Deploy NudgeBee Server:
265269
helm upgrade nudgebee $NUDGEBEE_CHART \
266270
-f values.yaml \
267271
--install \
268272
--namespace nudgebee \
269273
--create-namespace \
270274
--wait \
271-
--kube-context $KUBE_CONTEXT
275+
--kube-context "$KUBE_CONTEXT"
272276
```
273277

274278
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
335339
Forward the NudgeBee UI to your local machine:
336340

337341
```shell
338-
kubectl port-forward svc/app 3000:80 -n nudgebee --kube-context $KUBE_CONTEXT
342+
kubectl port-forward svc/app 3000:80 -n nudgebee
339343
```
340344

341345
Then open [http://localhost:3000](http://localhost:3000) in your browser to view the login screen.
@@ -346,8 +350,7 @@ Retrieve the auto-generated bootstrap password from the `nudgebee` secret:
346350

347351
```shell
348352
kubectl get secret nudgebee -n nudgebee \
349-
-o jsonpath='{.data.NEXTAUTH_DUMMY_CREDS_PASSWORD}' \
350-
--kube-context $KUBE_CONTEXT | base64 -d
353+
-o jsonpath='{.data.NEXTAUTH_DUMMY_CREDS_PASSWORD}' | base64 -d
351354
echo
352355
```
353356

@@ -359,20 +362,15 @@ Use your admin email (e.g. `admin@nudgebee.local` or the email provided during i
359362

360363
---
361364

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:
363368

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:
365372

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)**
376374

377375
---
378376

0 commit comments

Comments
 (0)