Skip to content

Commit 19326a2

Browse files
KorayErkanKorayErkan
authored
Merge pull request #377 from VirtualMetric:DT-552-onboarding-documentation
DT-552-onboarding-documentation
2 parents 415e3f0 + 17f1484 commit 19326a2

File tree

8 files changed

+91
-12
lines changed

8 files changed

+91
-12
lines changed

‎docs/configuration/devices/agents.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ For agentless configuration details, see the <Topic id="devices-windows">Windows
9191

9292
### Director vs Cluster Connection
9393

94-
Agents can connect to either a standalone Director or a Cluster. For Cluster configuration and management, see <Topic id="directors-management-clusters">Directors: Clusters</Topic>.
94+
Agents can connect to either a standalone Director or a Cluster. For Cluster configuration and management, see <Topic id="directors-clusters">Directors: Clusters</Topic>.
9595

9696
**Director Connection:** The Agent connects to a single Director instance. If the Director fails, the Agent buffers data locally until the connection is restored. This simpler configuration suits single-site deployments.
9797

‎docs/configuration/directors/deployment.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ For data processing efficiency, optimize YAML pipeline configurations for perfor
255255

256256
Maintain regular configuration backups and version control. Document recovery procedures and test them regularly. Implement monitoring and alerting for service health and plan for disaster recovery scenarios.
257257

258-
For redundancy, group **Directors** into clusters for automatic failover and load balancing. Clusters require a minimum of 3 Directors (odd number for quorum) and provide continuous operation when individual Directors fail. See <Topic id="directors-management-clusters">Clusters</Topic> for configuration details. Consider geographic distribution for disaster recovery and plan for seamless failover procedures.
258+
For redundancy, group **Directors** into clusters for automatic failover and load balancing. Clusters require a minimum of 3 Directors (odd number for quorum) and provide continuous operation when individual Directors fail. See <Topic id="directors-clusters">Clusters</Topic> for configuration details. Consider geographic distribution for disaster recovery and plan for seamless failover procedures.
259259

260260
## Troubleshooting
261261

‎docs/configuration/directors/management.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The Director creation process guides you through a 3-step wizard with validation
5252
{/* <Demo id="directors-create" aspectRatio="16/9" /> */}
5353

5454
:::info
55-
Directors are always created as standalone instances. To create a clustered deployment for high availability, first create Directors using this wizard, then group them using the **Clusters** tab. See <Topic id="directors-management-clusters">Clusters</Topic> for configuration details.
55+
Directors are always created as standalone instances. To create a clustered deployment for high availability, first create Directors using this wizard, then group them using the **Clusters** tab. See <Topic id="directors-clusters">Clusters</Topic> for configuration details.
5656
:::
5757

5858
### Step 1: Director Setup

docs/configuration/directors/introduction.mdx renamed to docs/configuration/directors/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
pagination_prev: null
3-
sidebar_label: Introduction
3+
sidebar_label: Overview
44
---
55

6-
# Directors: Introduction
6+
# Directors: Overview
77

88
Directors are the core data processing engines within the **DataStream** platform, responsible for collecting, processing, transforming, and routing security telemetry data from various sources to target destinations. They serve as the central orchestration layer that maintains data sovereignty by keeping sensitive information within your environment while providing centralized cloud-based management.
99

‎docs/getting-started/next-steps.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,10 @@ Move beyond basic routes to sophisticated data flow management:
267267
- Monitor Director health and performance
268268

269269
**Learn More**:
270+
- **<Topic id="directors-deployment">Director Deployment</Topic>** - Infrastructure planning and scaling strategies
271+
- **<Topic id="directors-clusters">Cluster Deployment</Topic>** - Multi-Director load balancing setup
272+
- **<Topic id="routes-overview">Route Configuration</Topic>** - Complete filtering syntax and expressions
270273
- **<Topic id="routes-config">Advanced Routes Management</Topic>** - Detailed UI operations and configuration
271-
- **<Topic id="routes">Route Configuration</Topic>** - Complete filtering syntax and expressions
272-
- **<Topic id="directors-deployment">Cluster Deployment</Topic>** - Multi-Director load balancing setup
273-
- **<Topic id="directors-deployment">Deployment Overview</Topic>** - Infrastructure planning and scaling strategies
274274

275275
## Manage Your Organization
276276

‎docs/getting-started/onboarding.mdx‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: Onboarding
3+
description: Complete the guided onboarding process to set up your DataStream environment
4+
---
5+
6+
# Onboarding
7+
8+
After creating your account, the onboarding process guides you through essential setup steps to create a functional data pipeline. Complete these steps to configure your **DataStream** environment with **Directors**, **Devices**, **Targets**, **Pipelines**, and **Routes**.
9+
10+
## Who Sees Onboarding
11+
12+
Onboarding appears for users with administrative privileges:
13+
14+
- **Owner role**: Users who create an organization account see onboarding on first login
15+
- **Admin role**: If the Owner does not complete onboarding, the next Admin user will see it
16+
- **New Tenants**: When a new Tenant is created, users with Owner or Admin roles for that Tenant also see onboarding
17+
18+
Once any user with the appropriate role completes the onboarding, it no longer appears for other users in that organization or Tenant.
19+
20+
## Onboarding Steps
21+
22+
The onboarding wizard presents seven steps organized into three categories. Five steps are required to complete onboarding; two are optional.
23+
24+
### Fleet Setup (Required)
25+
26+
These steps establish your data collection infrastructure:
27+
28+
| Step | Purpose | Dependency |
29+
|-----:|:--------|------------|
30+
| **Directors** | Create orchestration controllers that manage data processing | None |
31+
| **Devices** | Add data sources that receive telemetry | Requires at least one Director |
32+
| **Targets** | Configure data destinations for processed output | None |
33+
34+
### Pipelines & Routes (Required)
35+
36+
These steps define how data flows through your system:
37+
38+
| Step | Purpose | Dependency |
39+
|-----:|:--------|------------|
40+
| **Pipelines** | Define transformation and processing rules | None |
41+
| **Routes** | Connect devices to pipelines and targets | Requires at least one Device AND one Target |
42+
43+
### Organization (Optional)
44+
45+
These steps configure team access and settings:
46+
47+
| Step | Purpose |
48+
|-----:|:--------|
49+
| **Users** | Add team members to your organization |
50+
| **Settings** | Configure organization preferences |
51+
52+
## Progress Tracking
53+
54+
The onboarding interface displays a progress counter showing **5/5** for required steps only. Optional steps (Users and Settings) do not affect the completion counter and can be configured at any time after onboarding.
55+
56+
Each step shows a completion status:
57+
58+
- **Incomplete**: Step requires action
59+
- **Completed**: At least one item has been configured for this step
60+
61+
## Accessing Onboarding
62+
63+
You can access the onboarding wizard through two methods:
64+
65+
- **Onboarding page**: Navigate directly to the `/onboarding` URL
66+
- **Home page menu**: Use the collapsible sidebar on the Home dashboard, which displays your current progress
67+
68+
## Completing Onboarding
69+
70+
Click <gui>Complete Onboarding</gui> at any point to dismiss the onboarding wizard. You do not need to complete all steps before marking onboarding as complete.
71+
72+
The onboarding steps serve as guidance for initial setup. You can return to configure any components at any time through the standard navigation.
73+
74+
## Related Documentation
75+
76+
For detailed configuration information, see <Topic id="directors-overview">Directors</Topic>, <Topic id="devices-overview">Devices</Topic>, <Topic id="targets-overview">Targets</Topic>, <Topic id="pipelines-overview">Pipelines</Topic>, and <Topic id="routes-overview">Routes</Topic>.

‎sidebars.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ const sidebars: SidebarsConfig = {
2121
collapsed: false,
2222
items: [
2323
"getting-started/create-your-account",
24+
"getting-started/onboarding",
2425
{
25-
type: "category",
26+
type: "category",
2627
label: "Set Up Your First Data Collection",
2728
items: [
2829
"getting-started/create-director",
@@ -69,7 +70,7 @@ const sidebars: SidebarsConfig = {
6970
type: "category",
7071
label: "Directors",
7172
items: [
72-
"configuration/directors/introduction",
73+
"configuration/directors/overview",
7374
"configuration/directors/deployment",
7475
"configuration/directors/management",
7576
"configuration/directors/clusters",

‎topics.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
{
22
"getting-started": "/getting-started/create-your-account",
3+
"onboarding": "/getting-started/onboarding",
34

45
"about-director": "/about/applications#virtualmetric-director",
56
"about-director-proxy": "/about/applications#virtualmetric-director-proxy",
67
"about-agent": "/about/applications#virtualmetric-agent",
78

89
"organization-overview": "/organization/overview",
910

11+
"directors-overview": "/configuration/directors/overview",
1012
"directors-deployment": "/configuration/directors/deployment",
1113
"directors-management": "/configuration/directors/management",
12-
"directors-management-clusters": "/configuration/directors/clusters",
14+
"directors-clusters": "/configuration/directors/clusters",
1315
"directors-troubleshooting": "/configuration/directors/troubleshooting",
1416

1517
"devices-overview": "/configuration/devices/overview",
@@ -79,7 +81,7 @@
7981
"processors-reroute": "/configuration/pipelines/processors/reroute",
8082
"processors-discard": "/configuration/pipelines/processors/discard",
8183

82-
"routes": "/configuration/routes/overview",
84+
"routes-overview": "/configuration/routes/overview",
8385
"routes-config": "/configuration/routes/overview#configuration",
8486
"routes-implementation-strategies": "/configuration/routes/overview#implementation-strategies",
8587

0 commit comments

Comments
 (0)