Skip to content

Commit 23d5279

Browse files
committed
docs: add deployment path selector, first-value outcome verification steps, resolve auth/sizing contradictions, and clean FAQ
1 parent e1a4988 commit 23d5279

6 files changed

Lines changed: 178 additions & 140 deletions

File tree

doc-server/README.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,37 @@
1-
# Website
1+
# NudgeBee Documentation
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
This repository hosts the official documentation for [NudgeBee](https://nudgebee.com), built using [Docusaurus 3](https://docusaurus.io/).
44

5-
### Installation
5+
## Prerequisites
66

7-
```
8-
$ npm install
9-
```
7+
- **Node.js**: v18.0.0 or higher
8+
- **npm**: v9.0.0 or higher
109

11-
### Local Development
10+
## Local Development
1211

13-
```
14-
$ npm start
15-
```
12+
1. **Install dependencies**:
13+
```bash
14+
npm install
15+
```
1616

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
17+
2. **Start the local dev server**:
18+
```bash
19+
npm start
20+
```
21+
This command starts the local development server at `http://localhost:3000` (or `http://localhost:4000`). Edits in `docs/` reflect live via hot-reloading.
1822

19-
### Build
20-
21-
```
22-
$ npm run build
23-
```
23+
## Production Build
2424

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
25+
To verify and generate static assets:
2626

27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true npm run deploy
27+
```bash
28+
npm run build
3329
```
3430

35-
Not using SSH:
31+
The compiled output will be generated inside the `build/` directory.
3632

37-
```
38-
$ GIT_USER=<Your GitHub username> npm run deploy
39-
```
33+
To preview the production build locally:
4034

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
35+
```bash
36+
npm run serve
37+
```

doc-server/docs/FAQ.md

Lines changed: 53 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ sidebar_position: 100
77
### What are the open-source tools that NudgeBee uses?
88

99
#### Agent
10-
- Prometheus (or VictoriaMetrics) - Metrics Collection and alerting
11-
- OpenCost for calculating cost metrics for Pods/Workloads etc.
12-
- Trivy for generating Docker image vulnerability related security recommendations
13-
- Popeye for generating best practices related recommendations
14-
- Kubewatch for K8s events collection
10+
- **Prometheus** (or VictoriaMetrics) — Metrics collection and alerting
11+
- **Logs Engine** (Loki / OpenObserve / Elasticsearch / Fluentbit) — Log querying and stream aggregation
12+
- **Distributed Tracing** (OpenTelemetry Collector / ClickHouse / Tempo) — Distributed tracing
13+
- **Trivy** — Container image vulnerability scanning
14+
- **Popeye** — Kubernetes cluster sanitizing and best practice audits
15+
- **Kubewatch** — Kubernetes event streaming and lifecycle capture
1516

1617
### What are the ML libraries that NudgeBee uses? What are the dependencies?
17-
- TensorFlow for recommendations for replicas
18-
- AWS Bedrock using LLAMA (optional) for AI-based recommendations on logs/errors
18+
- **TensorFlow & Scikit-learn** — Predictive analytics for workload replica and resource rightsizing
19+
- **Cortex & DAIR Router** — In-VPC Small Language Model serving (vLLM / Ollama) with optional routing to AWS Bedrock, OpenAI, Anthropic, or Google Gemini
1920

2021
### What are the hard dependencies for the NudgeBee Server?
2122
- **PostgreSQL**: Hard requirement. Stores cluster configurations, user metadata, alert rules, and workflow states. Queries and services fail without it.
@@ -27,128 +28,109 @@ sidebar_position: 100
2728
- **The Agent** is required inside each cluster to collect real-time workload metrics, stream pod logs, capture eBPF network telemetry, and perform automated AI root cause analysis.
2829
- For full AI troubleshooting and cost optimizations on a cluster, installing the Agent is required.
2930

30-
### What are the pre-conditions(software/hardware) for installing NudgeBee on my cluster?
31+
### What are the pre-conditions (software/hardware) for installing NudgeBee on my cluster?
3132

3233
#### For Agent:
33-
- Helm chart for installation
34-
- Prometheus, if already configured, else NudgeBee agent installs it
35-
- Currently, NudgeBee uses Loki for log queries. For log-specific features, we will require Loki running on the cluster. We don't provide Loki as part of the Agent Installer.
36-
- Permissions as specified in Helm charts
34+
- Helm 3.10+ and Kubernetes 1.24+
35+
- Existing Prometheus instance (or install bundled Prometheus via Helm)
36+
- For log-specific triage: Existing log aggregator (Loki, Elasticsearch, OpenObserve) or cluster log access
37+
- Standard cluster RBAC permissions as specified in the Helm chart
3738

38-
### What is the typical system requirement for running NB on my cluster? What is the expected cost of operations for running the base NudgeBee
39+
### What is the typical system requirement for running NudgeBee?
3940

4041
#### For Agent:
41-
Agent has multiple components. All of them combined take around 6GB memory and 3 core CPUs
42-
This also includes Prometheus(Alertmanager/KubestateMetrics)
43-
If we remove Prometheus components, then it takes around 3GB and 2 cores
42+
- **Core Agent (Runner + Collector)**: Lightweight — requests **~200m CPU** and **256 MiB RAM**.
43+
- **Optional In-Cluster Monitoring Stack (Prometheus / Alertmanager / KSM)**: **~1–2 CPU cores** and **2–4 GB RAM** depending on metric cardinality.
44+
- **Node Agent (DaemonSet)**: **~50m CPU** and **64 MiB RAM** per worker node for eBPF and node telemetry.
4445

4546
#### For Server:
46-
All server components take around 12GB RAM and 4 core CPUs
47-
This includes running postgres/rabbitmq etc. If the customer is managing these dependencies, then it will take around 8GB RAM and 2 core CPUs
47+
- **Evaluation / Small Install (Bundled Postgres & RabbitMQ)**: **~4 CPU cores** and **8–12 GB RAM** across all backend pods.
48+
- **Production Install (External Managed Databases)**: **~2–4 CPU cores** and **4–8 GB RAM** for NudgeBee application pods.
4849

4950
### How NudgeBee Optimizations Work with GitOps
5051

51-
Raise PRs from NudgeBee
52-
- We have added support for raising PRs from specific optimization screens in NudgeBee.
53-
54-
GitOps(Flux/Argo) Reconciliation
55-
- Disable reconciliation for given resources.
56-
57-
NudgeBee Autopilot Reconciliation
58-
- NudgeBee provides annotations which can be used to ignore specific resources.
59-
60-
GitOps Way Of Configuring NudgeBee Optimizations -
61-
- We want to provide this as an option using CRDs, though it's part of the roadmap.
52+
- **Raise PRs from NudgeBee**: Create automated pull requests with rightsized resource limits directly to your Git repository.
53+
- **GitOps Reconciliation (Flux / Argo CD)**: Annotate manifests or configure automated PR merges to ensure GitOps state remains the single source of truth.
54+
- **NudgeBee Autopilot Reconciliation**: Apply `nudgebee.io/ignore: "true"` annotations to exclude specific workloads from automated rightsizing.
6255

6356
### Can NudgeBee work on K3s/Kind/Minikube?
64-
Yes, please refer to the Installation Guide for local testing.
57+
Yes, please refer to the [Server Installation Guide](/docs/installation/server/) and [Agent Installation Guide](/docs/installation/agent/installation/) for local evaluation instructions.
6558

6659
### How are NudgeBee Docker images secured?
67-
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).
60+
NudgeBee uses minimal Alpine and distroless base images to minimize the attack surface. All images are signed and 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).
6861

6962
### Is NudgeBee penetration tested?
70-
Yes. NudgeBee undergoes regular security testing, including automated and manual penetration testing, as part of its release process.
63+
Yes. NudgeBee undergoes regular security testing, including automated SAST/DAST and third-party penetration testing, as part of its release compliance.
7164

7265
### Can I configure multiple clusters within a single NudgeBee server?
73-
Yes, configure agents on each targeted cluster.
66+
Yes. A single NudgeBee Server can monitor dozens of Kubernetes clusters across multiple clouds and on-premises environments by deploying the lightweight Agent into each target cluster.
7467

7568
### What are the different NudgeBee distributions / editions?
76-
NudgeBee is available in three editions — see the [Editions page](./editions.md) for the full side-by-side comparison.
69+
NudgeBee is available in three editions — see the [Editions & Capabilities page](/docs/editions) for the full comparison:
7770

78-
- **Community** — free, open-source (Apache 2.0), fully functional self-hosted. Pull public images from `ghcr.io/nudgebee`; no license key.
79-
- **Enterprise** — self-hosted with a commercial license. Adds SAML 2.0 SSO, NudgeBee's managed models (`nb-llm` / `nb-slm`), and commercial support.
80-
- **Cloud** (SaaS) — fully managed at [app.nudgebee.com](https://app.nudgebee.com). Fastest way to evaluate.
81-
82-
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.
71+
- **Community** — Free self-hosted edition. Server is licensed under **BSL 1.1**; Agents are **Apache 2.0**. Pull public images from `ghcr.io/nudgebee` with no license key required.
72+
- **Enterprise** — Self-hosted with a commercial license. Adds SAML 2.0 SSO, NudgeBee-managed models (`nb-llm` / `nb-slm`), and commercial SLA support.
73+
- **Cloud (SaaS)** — Fully managed at [app.nudgebee.com](https://app.nudgebee.com). Passwordless signup with fastest time to evaluate.
8374

8475
### What is the NudgeBee release cycle?
85-
We target to have a weekly release cycle with hotfixes as per requirements. We follow SemVer for our versioning.
76+
We follow a weekly release cadence for server and agent enhancements, with hotfixes published as needed. All versions follow Semantic Versioning (`vMAJOR.MINOR.PATCH`).
8677

8778
### Can you provide more details on Data Retention Policies?
8879

89-
Currently, NudgeBee stores most of the data in Agents which get deployed on the cluster, so data remains within the cluster. Data retention for Agent components (traces/metrics/logs) is configurable and can be managed by the customer.
80+
Currently, NudgeBee stores most telemetry data inside your cluster or dedicated VPC storage:
9081

9182
#### Agents store the following data:
92-
93-
Traces - Using ClickHouse, you can adjust how long you want to retain ClickHouse data. The default is 7 days.
94-
Metrics - Using Prometheus, you can adjust Prometheus data retention.
95-
Logs - We integrate with existing log services like Loki/ELK, so again, it depends on their data retention.
96-
83+
- **Traces**: Stored in ClickHouse / Tempo. Configurable retention with a default of 7 days.
84+
- **Metrics**: Stored in Prometheus / VictoriaMetrics. Configurable retention based on your storage class.
85+
- **Logs**: Integrated with existing log services (Loki / Elasticsearch / OpenObserve).
9786

9887
#### Servers store the following data:
99-
100-
Aggregated Metrics - Aggregated on a daily basis and retained for long-term trend analysis.
101-
Events - Troubleshooting pages. Default retention is 60 days, and is configurable.
102-
Deleted Pods/Workloads etc. - Records of deleted workloads/pods are retained to support historical analysis.
103-
104-
### Does NudgeBee support Anomaly Detection?
105-
No, this is part of the roadmap.
88+
- **Aggregated Metrics**: Daily rollups for long-term capacity planning and FinOps cost trend analysis.
89+
- **Events & Incidents**: Troubleshooting events with default configurable retention of 60 days.
90+
- **Workload Metadata**: Historical records of deleted pods and workloads to support post-incident analysis.
10691

10792
### Does NudgeBee support Predictive Analysis?
108-
Yes, NudgeBee uses predictive analytics for replica rightsizing and continuous rightsizing.
93+
Yes, NudgeBee uses predictive analytics for workload replica rightsizing, resource trend forecasting, and continuous FinOps optimization.
10994

11095
### How does NudgeBee discover cloud resources across AWS, Azure, and GCP?
111-
NudgeBee automatically discovers cloud resources when you onboard an account. It searches for common services like VMs, load balancers, databases, and storage. The platform syncs with daily billing data and performs periodic updates for continuous resource tracking. For AWS specifically, NudgeBee uses EventBridge to receive real-time notifications for resource updates, creation, and deletion events.​
96+
NudgeBee automatically discovers cloud resources when you onboard an account. It scans common services like VMs, load balancers, managed databases, and object storage. The platform syncs with daily billing data and listens to real-time events (e.g. AWS EventBridge) to track resource creation, modification, and deletion.
11297

11398
### Does NudgeBee support Kubernetes resource discovery?
114-
Yes, NudgeBee agents automatically discover all Kubernetes resources across all namespaces in your cluster. The agent runs within your Kubernetes environment and uses the Kubernetes API to continuously track workloads.​
99+
Yes, NudgeBee agents automatically discover all Kubernetes resources across all namespaces in your cluster via the Kubernetes API.
115100

116101
### What observability tools does NudgeBee integrate with?
117-
NudgeBee provides prebuilt, out-of-the-box connectors for major observability platforms. These include Datadog, Prometheus (and all variations), Chronosphere, Signoz, OpenObserve, ELK, AWS CloudWatch, Azure Monitor, and Google Cloud Monitoring. The integrations work seamlessly with your existing stack without requiring replacements.​
102+
NudgeBee provides prebuilt connectors for Datadog, Prometheus, Chronosphere, SigNoz, OpenObserve, Elasticsearch, AWS CloudWatch, Azure Monitor, and Google Cloud Monitoring.
118103

119104
### Can I deploy NudgeBee with its own observability stack?
120-
Yes, for new deployments or greenfield environments, NudgeBee ships with a complete observability stack. This includes VictoriaMetrics for metrics collection, ClickHouse with OpenTelemetry for distributed traces, and Loki for log aggregation.
105+
Yes, for greenfield environments, NudgeBee can bundle Prometheus for metrics collection, ClickHouse with OpenTelemetry for distributed traces, and Loki for log aggregation.
121106

122107
### How does NudgeBee integrate with existing knowledge base systems?
123-
NudgeBee natively integrates with Atlassian Confluence and ServiceNow knowledge bases. You can also define custom knowledge base sources including Google Docs, Notion, and SharePoint. These sources are used by NudgeBee's AI agents during troubleshooting workflows.​
108+
NudgeBee natively integrates with Atlassian Confluence, ServiceNow, Notion, Google Docs, and SharePoint. These sources are indexed into the Semantic Knowledge Graph to ground NuBi's root cause investigations in your team's existing runbooks.
124109

125110
### Does NudgeBee learn from resolved incidents automatically?
126-
Yes, NudgeBee automatically learns from issues it has resolved. User feedback can be configured to flow directly into the knowledge base, continuously improving the AI agent's troubleshooting capabilities over time.​
111+
Yes, NudgeBee automatically learns from resolved incidents. Resolution notes and verified postmortems flow directly into the knowledge base to continually improve future triage accuracy.
127112

128113
### How does NudgeBee handle event deduplication and aggregation?
129-
NudgeBee generates unique fingerprints for each event it receives. These fingerprints form the foundation for intelligent aggregation and deduplication within the platform. This prevents alert fatigue by consolidating related events into single actionable incidents.
114+
NudgeBee generates unique fingerprints for each incoming alert. These fingerprints form the foundation for intelligent aggregation and deduplication, consolidating cascading alert storms into single, actionable incidents.
130115

131116
### What is NudgeBee's Knowledge Graph and how does it correlate events?
132-
NudgeBee uses a Knowledge Graph to establish linkages between entities like configurations, logs, metrics, traces, cloud bills, SLO/SLAs, tickets, code, and secrets. When an event occurs, the system searches for related entities and identifies recent events that may have caused the new issue. It then builds a comprehensive event timeline based on these correlations.​
117+
NudgeBee uses a live Semantic Knowledge Graph to establish topological links between workloads, pods, nodes, cloud services, metrics, traces, git commits, and tickets. When an incident occurs, the system correlates dependent entities across the timeline to identify the precise triggering change.
133118

134119
### What event sources can NudgeBee consume for incident management?
135-
NudgeBee consumes events from Prometheus Alertmanager, Kubernetes, Datadog, PagerDuty, and ServiceNow. Users can also send custom events to NudgeBee's webhook endpoints for proprietary or internal monitoring systems.​
136-
137-
### How does NudgeBee's SRE Agent prioritize and analyze incidents?
138-
For each incoming event, NudgeBee's SRE Agent performs deduplication and urgency assessment based on historical incident data. Events are then automatically analyzed for root cause using an AI-based workflow system. Users can extend the analysis by providing custom instructions tailored to their environment.​
120+
NudgeBee consumes events from Prometheus Alertmanager, Kubernetes events, Datadog, PagerDuty, ServiceNow, and custom webhooks.
139121

140122
### Where can I access NudgeBee's SRE Agent (NuBi)?
141-
NuBi, NudgeBee's SRE agent, is accessible through communication channels like Slack and Microsoft Teams, or directly through the NudgeBee UI. This enables ChatOps workflows where team members can ask questions about infrastructure, logs, and metrics.​
123+
NuBi is accessible directly through the web dashboard, Slack, and Microsoft Teams for seamless ChatOps.
142124

143125
### What are the primary capabilities of NuBi for SRE teams?
144-
NuBi handles ChatOps by responding to user questions about infrastructure, logs, and metrics. It performs live debugging of active incidents and conducts root cause analysis using AI-driven workflows. Teams can create custom agents based on specific requirements, extend existing agent instructions, and provide global context for tenant or account-level behaviors.​
126+
NuBi investigates live alerts, runs ad-hoc infrastructure queries, correlates logs and traces, hypothesizes root causes, and suggests actionable remediation commands.
145127

146128
### What types of automated resolutions does NudgeBee support?
147-
NudgeBee generates automated pull requests for code and CI/CD issues. For lower environments, it can automate configuration changes with approval workflows. The platform also handles quick fixes like pod restarts and memory/CPU adjustments automatically.​
129+
NudgeBee can generate automated pull requests for GitOps and CI/CD configurations, trigger approved runbooks (e.g. pod restarts or cache flushes), and execute policy-gated right-sizing actions.
148130

149131
### Can I customize NudgeBee's automation workflows?
150-
Yes, users can create custom resolution workflows using NudgeBee's AI-Ops Workflow Builder. You can customize existing workflows or extend them with additional components, APIs, and integrations tailored to your infrastructure.​
132+
Yes, users can compose custom automation DAGs using NudgeBee's visual AI-Ops Workflow Builder.
151133

152134
### What ITSM and ticketing systems does NudgeBee integrate with?
153-
NudgeBee provides out-of-the-box integration with GitHub Issues, Jira, and ServiceNow (available in the December 2025 release). These integrations support automated ticketing, incident management system integration for listening and responding to incidents, and CMDB/KB integration (Planned for future releases).​
135+
NudgeBee provides out-of-the-box integrations with GitHub Issues, Jira, PagerDuty, and ServiceNow. These integrations support automated ticket creation, bidirectional incident status sync, and knowledge base grounding.
154136

0 commit comments

Comments
 (0)