Skip to content

Commit 8611452

Browse files
authored
Merge pull request #259 from VirtualMetric:DT-423-documentation-of-self-managed-director
DT-423: Documentation of Self-managed Director
2 parents b230ea8 + e6f57f7 commit 8611452

File tree

6 files changed

+16
-3
lines changed

6 files changed

+16
-3
lines changed

docs/configuration/directors/configuration.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The central table displays all Director instances with key operational informati
2424
- **Name** - Unique identifier assigned during Director creation
2525
- **Platform Type** - Management model (Self-managed by default)
2626
- **Installation Type** - Architecture type (Standalone by default)
27+
- **Mode** - Managed or Self-managed (Managed by default)
2728
- **Status** - Current operational state (Enabled/Disabled)
2829
- **Connection Status** - Real-time connectivity to cloud platform
2930
- *Connected* (green) - Director successfully communicating with cloud platform
@@ -45,6 +46,7 @@ The central table displays all Director instances with key operational informati
4546
Each Director row includes a vertical ellipsis (⋮) providing access to management operations:
4647

4748
- **Edit director** - Access Director configuration and settings
49+
- **Download config** - Appears only on rows for _Self-managed_ directors. Download Director configuration
4850
- **Enable/Disable director** - Toggle operational status
4951
- **Delete director** - Remove Director from fleet (with dependency checks)
5052

@@ -65,9 +67,12 @@ The Director creation process guides you through deployment setup and installati
6567
- Validation prevents duplicate names
6668

6769
- **Installation Type**: Select deployment architecture
68-
- **Standalone** (default): Single Director instance
69-
- Provides basic functionality without redundancy
70-
- Suitable for most standard deployments
70+
- **Standalone** (default): Single Director instance
71+
- Provides basic functionality without redundancy
72+
- Suitable for most standard deployments
73+
- **Self-managed** Local deployment.
74+
- Suitable for users that do not want to send private data to the cloud.
75+
- Configuration file must be downloaded
7176

7277
### Installation Process
7378

docs/configuration/directors/deployment.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,14 @@ The standard installation process follows a guided setup through the DataStream
133133
- Assign unique Director name for identification
134134
- Select "Standalone" installation type
135135
- Choose appropriate platform (Self-managed recommended)
136+
137+
A self-managed director is indicated under the **Mode** column as _Self-managed_, with a warning icon to its right. Hovering over the icon displays a tooltip, informing the user that the xonfiguration has changed and that the current one has to be deployed.
138+
139+
:::info
140+
The actions menu of a self-managed director contains a _Download config_ option. Clicking it downloads the `vmetric.vmf` file to the **Downloads** directory of **Windows**. This file should be placed under the `<vm_root>\Director\config` directory.
141+
:::
142+
143+
This option removes the access verification step. The user can monitor errors through the CLI or the files under the `<vm_root>\Director\storage\logs` directory.
136144

137145
3. **Generate Installation Scripts**
138146
- System generates platform-specific installation scripts
79.2 KB
Loading
226 KB
Loading
26.5 KB
Loading
138 KB
Loading

0 commit comments

Comments
 (0)