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
docs: prepare documentation for the open-source launch (#807)
Aligns docs.nudgebee.com with the public OSS release of nudgebee/nudgebee
(server), nudgebee/k8s-agent (cluster agent), and nudgebee/forager
(proxy agent). The OSS/EE boundary was verified against the source repos'
chart values, NextAuth providers, and the EE .oss-exclude file.
New top-level pages
- editions.md — source of truth for the Community / Enterprise / Cloud
split, with the feature matrix and what's gated where.
- telemetry.md — explicit "self-hosted sends no telemetry" statement,
data-flow table, and an air-gapped note.
- Edition badges (<Community/>, <Enterprise/>, <Cloud/>) registered
globally via a swizzled MDXComponents and styled in custom.css, so
any page can mark a feature without an explicit import.
Server (nudgebee/nudgebee)
- Edition-aware install: Community pulls public images from
oci://ghcr.io/nudgebee/charts/nudgebee with no helm registry login
and no license key; Enterprise uses oci://registry.nudgebee.com/nudgebee
with the license-key login. Same treatment applied to the upgrade guide.
- NUDGEBEE_ENCRYPTION_KEY now documented as REQUIRED (chart fails install
if empty), with the openssl rand -hex 32 generation command and the
"lose this and previously-encrypted DB rows are unreadable" warning.
Both Community and Enterprise values.yaml examples updated.
- NEXTAUTH_SECRET / ACTION_API_SERVER_TOKEN clarified as auto-generated
by the chart, with the GitOps offline-render caveat (Argo / Flux must
set them explicitly).
- LICENSE_PUBLIC_KEY documented as empty for Community.
- Bundled-deps list corrected: Postgres + RabbitMQ + Redis + Temporal +
Qdrant (ClickHouse defaults off, not on).
- helm_values.md got a note explaining the auto-generated table reflects
the Enterprise overlay and listing the Community deltas.
k8s-agent (nudgebee/k8s-agent)
- The chart already defaults every image to ghcr.io/nudgebee/*, so no
edition split is needed at install time. Network-access prereq updated
to say so.
- helm_values.md got a note that the auto-generated table here may lag
behind the upstream chart, with a pointer at the canonical
charts/nudgebee-agent/values.yaml.
Forager / proxy agent (nudgebee/forager)
- Install scripts: registry.nudgebee.com/downloads/forager/* swapped for
github.com/nudgebee/forager/releases/{latest/download,download/<tag>}/
install.{sh,ps1}.
- Docker image: registry.nudgebee.com/nudgebee-forager:* swapped for
ghcr.io/nudgebee/forager:*.
- Helm OCI chart: oci://registry.nudgebee.com/nudgebee-forager-chart
swapped for oci://ghcr.io/nudgebee/charts/forager (per forager README).
- Chart was renamed (nudgebee-forager-chart -> forager), so deployment-
name examples and the kubectl label selector were updated.
- Tag rollback now uses gh release list / the GitHub releases page
instead of a registry v2 API call.
- Support hand-off: OSS users go to github.com/nudgebee/forager/issues;
Enterprise / Cloud users still get the support channel.
SSO scope correction
- The auth boundary was previously over-claimed as "SSO/SAML/LDAP are
Enterprise/Cloud." OSS NextAuth wires Google, Okta, OneLogin, Azure AD
(and B2C), and Auth0, plus magic-link email, dummy credentials, LDAP,
and Teleport — only SAML 2.0 (with IdP-driven user provisioning and
group-to-role mapping) is Enterprise/Cloud. Corrected in editions.md,
features/index.md, features/security.md, integrations/Authentication/
{index,SAML}.md, the server install guide, and the landing-page
integration table.
Sanitization, polish, and structural cleanup
- Scrubbed real-looking NEXTAUTH_SECRET, internal email, and GCP API key
to clear placeholders; fixed an invalid Bedrock model ID.
- Scoped SOC 2 / ISO 27001 claims to NudgeBee Cloud (the hosted offering)
rather than the product as a whole.
- Rewrote FAQ entries that contained unfinished internal / sales notes;
updated "What are different NudgeBee distributions?" to reflect the
three editions.
- Removed a 44 MB orphan api-docs/index.html and Docusaurus starter
cruft (HomepageFeatures, markdown-page.md, default social images).
- Fixed two broken doc anchors, added missing Dynatrace / SolarWinds
rows to the webhook index, and de-duplicated a sidebar position.
- Normalized "Nudgebee" -> "NudgeBee" prose casing (intentionally
excluding historical release archives and the auto-generated GraphQL
docs).
- Fixed the social-card image reference (case mismatch — Nudgebee.png
vs NudgeBee.png) and added editUrl + a tagline to the Docusaurus
config.
Build passes (no broken links / anchors), eslint exit 0.
https://claude.ai/code/session_01R2nUH5wjcN6vqkv7DCa5Vj
Copy file name to clipboardExpand all lines: doc-server/docs/FAQ.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,17 +53,23 @@ GitOps Way Of Configuring NudgeBee Optimizations -
53
53
### Can NudgeBee work on K3s/Kind/Minikube?
54
54
Yes, please refer to the Installation Guide for local testing.
55
55
56
-
### Does NudgeBee Docker images have any security vulnerabilities?
57
-
No, NudgeBee uses Alpine-based images to reduce overall size and security issues. We use AWS ECR and NudgeBee for scanning images maintained by us. We can share a security report for that as per request.
56
+
### How are NudgeBee Docker images secured?
57
+
NudgeBee uses minimal Alpine-based images to reduce attack surface and image size. Images are scanned for known vulnerabilities as part of the release pipeline. To report a suspected vulnerability, see the [security policy](https://github.com/nudgebee/nudgebee-docs/blob/main/SECURITY.md).
58
58
59
-
### Does NudgeBee have VAPT reports?
60
-
Yes, we use ZAP/manual pen testing for our security testing and can share reports based on request.
59
+
### Is NudgeBee penetration tested?
60
+
Yes. NudgeBee undergoes regular security testing, including automated and manual penetration testing, as part of its release process.
61
61
62
62
### Can I configure multiple clusters within a single NudgeBee server?
63
63
Yes, configure agents on each targeted cluster.
64
64
65
-
### What are different NudgeBee distributions?
66
-
NudgeBee has both SaaS and self-hosted solutions. As an end-user, you can use the SaaS solution to quickly validate/test the product and the self-hosted solution for long-term deployment (if there are compliance constraints which don't allow any kind of data movement).
65
+
### What are the different NudgeBee distributions / editions?
66
+
NudgeBee is available in three editions — see the [Editions page](./editions.md) for the full side-by-side comparison.
67
+
68
+
-**Community** — free, open-source (Apache 2.0), fully functional self-hosted. Pull public images from `ghcr.io/nudgebee`; no license key.
69
+
-**Enterprise** — self-hosted with a commercial license. Adds SAML 2.0 SSO, NudgeBee's managed models (`nb-llm` / `nb-slm`), and commercial support.
70
+
-**Cloud** (SaaS) — fully managed at [app.nudgebee.com](https://app.nudgebee.com). Fastest way to evaluate.
71
+
72
+
Use Cloud for fastest evaluation; Community for a free, self-hosted deployment; Enterprise when you need SAML, managed models, or a commercial SLA while staying on-prem.
67
73
68
74
### What is the NudgeBee release cycle?
69
75
We target to have a weekly release cycle with hotfixes as per requirements. We follow SemVer for our versioning.
@@ -81,9 +87,9 @@ Logs - We integrate with existing log services like Loki/ELK, so again, it depen
81
87
82
88
#### Servers store the following data:
83
89
84
-
Aggregated Metrics - We do aggregation on a daily basis. No retention policy yet. Would like to understand the use case.
85
-
Events - Troubleshooting pages. Current retention is 60 days. You can make it configurable.
86
-
Deleted Pods/Workloads etc. - We store deleted workloads/pods etc. No retention policy yet. Will share once that is there, maybe by next week.
90
+
Aggregated Metrics - Aggregated on a daily basis and retained for long-term trend analysis.
91
+
Events - Troubleshooting pages. Default retention is 60 days, and is configurable.
92
+
Deleted Pods/Workloads etc. - Records of deleted workloads/pods are retained to support historical analysis.
Copy file name to clipboardExpand all lines: doc-server/docs/api-docs/api-tokens.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
4
4
5
5
# API Tokens
6
6
7
-
API Tokens allow you to authenticate with Nudgebee APIs programmatically. You can use them to automate workflows, integrate with external tools, or build custom scripts that interact with Nudgebee.
7
+
API Tokens allow you to authenticate with NudgeBee APIs programmatically. You can use them to automate workflows, integrate with external tools, or build custom scripts that interact with NudgeBee.
|**What it is**| Free, open-source (Apache 2.0), self-hosted. Fully functional. | Self-hosted with a commercial license. Adds enterprise features and support. | Fully managed SaaS, hosted and operated by NudgeBee. |
14
+
|**Where it runs**| Your own Kubernetes cluster | Your own Kubernetes cluster |[app.nudgebee.com](https://app.nudgebee.com)|
15
+
|**Container images**| Public — `ghcr.io/nudgebee` (no authentication) | Licensed — `registry.nudgebee.com`| Managed for you |
16
+
|**License key**| Not required | Required | Not applicable |
|**Best for**| Teams that want full control and a zero-cost, self-hosted deployment. | Organizations that need SAML SSO, NudgeBee's managed models, and commercial support while self-hosting. | Teams that want to start in minutes without managing infrastructure. |
19
+
|**Support**| Community ([GitHub Issues & Discussions](https://github.com/nudgebee)) | Commercial support (SLA) | Commercial support (SLA) |
20
+
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.
26
+
:::
27
+
28
+
## What's in the open-source (Community) edition
29
+
30
+
The Community edition is **fully functional** for self-hosted Kubernetes
31
+
operations. It includes:
32
+
33
+
- The NudgeBee **Server** (control plane, UI, API) and **Agent**
34
+
- The **Semantic Knowledge Graph**
35
+
-**Cost optimizations** and FinOps recommendations
36
+
-**Troubleshooting**, alerting, and the playbook catalog
37
+
- The **Workflow Builder** and **Autopilot** auto-runbooks
38
+
-**Notifications** (Slack, Teams, Google Chat) and **ticketing** integrations
39
+
-**BYOM (Bring Your Own Model)** LLM connectivity — OpenAI, Azure OpenAI,
40
+
AWS Bedrock, Google Vertex AI / Gemini, Ollama, Hugging Face, and SageMaker
41
+
-**OAuth SSO** — Google, Okta, OneLogin, Azure AD (and B2C), Auth0 — plus
42
+
magic-link email and built-in credentials login
43
+
-**Role-based access control**, approval workflows, and audit trails
44
+
45
+
The Community edition is **single-tenant by design** — one organization per
46
+
install. The chart provisions the tenant at install time and users are invited
47
+
into it from the UI.
48
+
49
+
## What requires Enterprise or Cloud
50
+
51
+
A small set of capabilities are not part of the free Community edition. Pages
52
+
documenting these features are marked with an <Enterprise/> or <Cloud/> badge.
53
+
54
+
| Feature | Edition | Notes |
55
+
|---|---|---|
56
+
|**SAML 2.0 SSO**| <Enterprise/> <Cloud/> | Community supports OAuth SSO (Google, Okta, OneLogin, Azure AD / B2C, Auth0), magic-link email, and credentials login — but the SAML 2.0 flow (with IdP-driven user provisioning and group-to-role mapping) is Enterprise-only. See [Authentication](./integrations/Authentication/index.md). |
57
+
|**NudgeBee-managed & proprietary LLM/SLM models** (`nb-llm`, `nb-slm`, `nb-text-embeddings`) | <Enterprise/> <Cloud/> | Community users connect their own model via [BYOM](./integrations/LLM/index.md). |
58
+
|**Multi-tenant self-signup**| <Cloud/> | Community and Enterprise installs are single-tenant. The self-serve signup flow (creates a new tenant per signup) is exclusive to NudgeBee Cloud. |
59
+
|**Cloud-marketplace billing** (AWS / Azure subscriptions) | <Cloud/> | Marketplace purchase callbacks and billing are SaaS-only. |
60
+
61
+
:::note
62
+
This boundary may evolve as the project grows. When it does, this page and the
63
+
per-feature badges are updated together so the docs always reflect what's
64
+
actually gated.
65
+
:::
66
+
67
+
## Trademarks
68
+
69
+
NudgeBee is open source under the Apache 2.0 license, but the **NudgeBee name
70
+
and logo are trademarks**. The Apache license does not grant trademark rights —
71
+
in particular, modified builds and forks must be renamed. See the
Copy file name to clipboardExpand all lines: doc-server/docs/features/api-tokens.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ sidebar_position: 10
3
3
---
4
4
# API Tokens
5
5
6
-
API Tokens allow you to authenticate with Nudgebee APIs programmatically. You can use them to automate workflows, integrate with external tools, or build custom scripts that interact with Nudgebee.
6
+
API Tokens allow you to authenticate with NudgeBee APIs programmatically. You can use them to automate workflows, integrate with external tools, or build custom scripts that interact with NudgeBee.
-**[SLO](./slo.md)** — Define and track Service Level Objectives to ensure your services meet reliability targets. Get alerted when SLOs are at risk and use historical data to make informed capacity decisions.
30
30
31
-
-**[Security](./security.md)** — Enterprise-grade security with SOC 2 Type II and ISO 27001 certification. Includes SSO authentication, role-based access control, approval workflows, and full audit trails for every action.
31
+
-**[Security](./security.md)** — Role-based access control, approval workflows, and full audit trails for every action. OAuth SSO (Google, Okta, Azure AD, Auth0) and magic-link login are in every edition; **SAML 2.0 SSO** is available in the Enterprise and Cloud editions. NudgeBee Cloud is SOC 2 Type II and ISO 27001 certified.
32
32
33
33
-**[User Management](./user-management.md)** — Invite team members, assign admin or read-only roles, and control access at both tenant and account level. New users get started instantly via email invite — no password setup needed.
Copy file name to clipboardExpand all lines: doc-server/docs/features/security.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ sidebar_position: 11
3
3
---
4
4
# Security
5
5
6
-
NudgeBee is designed with security at its core. The platform is **SOC 2 Type II certified** and **ISO 27001 certified**, providing enterprise-grade security for your cloud operations.
6
+
NudgeBee is designed with security at its core. [NudgeBee Cloud](https://app.nudgebee.com) (the managed SaaS offering) is **SOC 2 Type II certified** and **ISO 27001 certified**. These certifications cover the hosted service; self-hosted (Community and Enterprise) deployments run entirely within your own infrastructure, under your own controls.
7
7
8
8
This page covers NudgeBee's **Enterprise Guardrails** — authentication, authorization, approval workflows, and audit trails — that keep your operations secure and compliant.
9
9
@@ -12,9 +12,10 @@ NudgeBee does not store passwords. All authentication is handled through SSO pro
12
12
:::
13
13
14
14
## Authentication
15
-
- Supports Google, Azure, Okta, and Auth0 for Single Sign-On (SSO). To configure SSO for on-prem, see [Authentication Integration](../integrations/Authentication/index.md).
15
+
-**OAuth SSO** with Google, Okta, OneLogin, Azure AD (and B2C), and Auth0 is available in **all editions** (Community, Enterprise, Cloud). See [Authentication Integration](../integrations/Authentication/index.md) for setup.
16
+
-**SAML 2.0 SSO** (with IdP-driven user provisioning and group-to-role mapping) is available in the **Enterprise** and **Cloud** editions.
16
17
- Users without SSO can use **magic email links** — enter your email and receive a one-time login link. No password required.
17
-
- Credentials for external integrations are stored encrypted using AES with GCM.
18
+
- Credentials for external integrations are stored encrypted (AES-GCM) at rest using the `NUDGEBEE_ENCRYPTION_KEY` set at install time.
Copy file name to clipboardExpand all lines: doc-server/docs/features/troubleshooting/alerting.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ sidebar_position: 3
4
4
5
5
# Alerting & Auto-Investigation
6
6
7
-
When an alert fires, Nudgebee can run a small list of "actions" automatically — gathering logs, fetching cloud metrics, snapshotting database queries, hitting an internal API — and attach the results to the alert as evidence. The LLM then writes the root cause analysis with all of that context already in hand.
7
+
When an alert fires, NudgeBee can run a small list of "actions" automatically — gathering logs, fetching cloud metrics, snapshotting database queries, hitting an internal API — and attach the results to the alert as evidence. The LLM then writes the root cause analysis with all of that context already in hand.
8
8
9
9
You set this up once, on the alert. After that, every time the alert fires, the same investigation happens automatically.
10
10
@@ -19,7 +19,7 @@ A few real examples:
19
19
None of these require any custom code or workflow. Each is two or three clicks in the alert editor.
20
20
21
21
:::tip Works for any alert source
22
-
This works for alerts you create in Nudgebee (Prometheus rules) **and** for alerts forwarded from any of the integrations Nudgebee accepts via webhook: **Datadog**, **New Relic**, **Dynatrace**, **Splunk**, **SolarWinds**, **Grafana**, **GCP Cloud Monitoring**, **Azure Monitor**, **PagerDuty**, **Zenduty**, **ServiceNow**, or the generic webhook (used for AWS CloudWatch via SNS, or any other source). The flow is the same in every case.
22
+
This works for alerts you create in NudgeBee (Prometheus rules) **and** for alerts forwarded from any of the integrations NudgeBee accepts via webhook: **Datadog**, **New Relic**, **Dynatrace**, **Splunk**, **SolarWinds**, **Grafana**, **GCP Cloud Monitoring**, **Azure Monitor**, **PagerDuty**, **Zenduty**, **ServiceNow**, or the generic webhook (used for AWS CloudWatch via SNS, or any other source). The flow is the same in every case.
23
23
:::
24
24
25
25
---
@@ -30,7 +30,7 @@ Open the cloud or cluster account from the top-right account picker, then go to
Every alert Nudgebee knows about is listed here — Prometheus rules you authored, plus alerts forwarded from external sources. From any row you can edit the alert, attach actions to it, or pause it.
33
+
Every alert NudgeBee knows about is listed here — Prometheus rules you authored, plus alerts forwarded from external sources. From any row you can edit the alert, attach actions to it, or pause it.
34
34
35
35
---
36
36
@@ -40,15 +40,15 @@ The alert editor is a short wizard. The first two steps are about **the alert it
40
40
41
41
### 1. Alert configuration
42
42
43
-
Give the alert a name, severity, and short summary. The name is what Nudgebee uses to remember which actions belong to which alert, so pick something stable.
43
+
Give the alert a name, severity, and short summary. The name is what NudgeBee uses to remember which actions belong to which alert, so pick something stable.
44
44
45
45
If the alert came in from an external source (Datadog, New Relic, an AWS / GCP / Azure alarm forwarded via webhook, etc.), the alert entry is created automatically when it first fires — open the existing row in Alert Manager and go straight to **Add Actions**.
46
46
47
47
### 2. Triggering condition
48
48
49
-
For Prometheus rules created in Nudgebee, this is where you write the PromQL and choose how long the condition must hold (the `for:` window) before the alert fires.
49
+
For Prometheus rules created in NudgeBee, this is where you write the PromQL and choose how long the condition must hold (the `for:` window) before the alert fires.
50
50
51
-
For external alerts, the trigger condition lives in the originating system (Datadog, CloudWatch, …) — Nudgebee just records the alert when the source notifies it.
51
+
For external alerts, the trigger condition lives in the originating system (Datadog, CloudWatch, …) — NudgeBee just records the alert when the source notifies it.
52
52
53
53
### 3. Add actions
54
54
@@ -133,7 +133,7 @@ Attach three actions, in this order:
133
133
2.**Get Cloud Provider Metrics** — pulls CPU, IOPS, and connection-count history from CloudWatch.
134
134
3.**Database Query (Proxy Agent)** — runs the same `pg_stat_activity` snapshot as above, against the same instance.
135
135
136
-
When the alarm fires, the alert in Nudgebee will have all three evidence cards waiting — AWS view, metric trend, live workload — and the analysis ties them together. Notice that none of this is Kubernetes-specific.
136
+
When the alarm fires, the alert in NudgeBee will have all three evidence cards waiting — AWS view, metric trend, live workload — and the analysis ties them together. Notice that none of this is Kubernetes-specific.
137
137
138
138
### Slow Datadog monitor — pull the service graph
139
139
@@ -147,9 +147,9 @@ The LLM ends up with a clear picture of where the latency is coming from before
147
147
148
148
---
149
149
150
-
## Need data that's not in the catalog?
150
+
## Need data that's not in the catalog? {#custom-data-collection}
151
151
152
-
You don't need to write a workflow or a plugin for this. Nudgebee includes "run my command" actions for the common shapes of custom data collection:
152
+
You don't need to write a workflow or a plugin for this. NudgeBee includes "run my command" actions for the common shapes of custom data collection:
153
153
154
154
-**Run a SQL query** anywhere your proxy agent can reach — Postgres, MySQL, MSSQL, ClickHouse, Oracle.
155
155
-**Hit an internal HTTP endpoint** — Grafana, Jenkins, your own health checks.
0 commit comments