From 807820e1306271d61835ee7da8da13ec501f62d9 Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Mon, 2 Dec 2024 13:37:20 +0100 Subject: [PATCH 1/6] docs: create documentation scaffolding --- docs/.gitignore | 1 + docs/README.md | 1 + docs/SUMMARY.md | 36 ++++++++++++++++++++++++++++++++++++ docs/book.toml | 6 ++++++ docs/dev/README.md | 0 docs/dev/build.md | 0 docs/dev/guidelines.md | 0 docs/dev/setup.md | 0 docs/dev/tests.md | 0 docs/diag/README.md | 0 docs/diag/check.md | 0 docs/diag/collect.md | 0 docs/diag/frequent_logs.md | 0 docs/pkg/README.md | 0 docs/pkg/backup.md | 0 docs/pkg/build.md | 0 docs/pkg/install.md | 0 docs/pkg/uninstall.md | 0 docs/pkg/upgrade.md | 0 docs/ref/README.md | 0 docs/ref/architecture.md | 0 docs/ref/configuration.md | 0 docs/ref/performance.md | 0 docs/ref/security.md | 0 docs/ref/usage.md | 0 25 files changed, 44 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/README.md create mode 100644 docs/SUMMARY.md create mode 100644 docs/book.toml create mode 100644 docs/dev/README.md create mode 100644 docs/dev/build.md create mode 100644 docs/dev/guidelines.md create mode 100644 docs/dev/setup.md create mode 100644 docs/dev/tests.md create mode 100644 docs/diag/README.md create mode 100644 docs/diag/check.md create mode 100644 docs/diag/collect.md create mode 100644 docs/diag/frequent_logs.md create mode 100644 docs/pkg/README.md create mode 100644 docs/pkg/backup.md create mode 100644 docs/pkg/build.md create mode 100644 docs/pkg/install.md create mode 100644 docs/pkg/uninstall.md create mode 100644 docs/pkg/upgrade.md create mode 100644 docs/ref/README.md create mode 100644 docs/ref/architecture.md create mode 100644 docs/ref/configuration.md create mode 100644 docs/ref/performance.md create mode 100644 docs/ref/security.md create mode 100644 docs/ref/usage.md diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000000..7585238efe --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..e10b99d013 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +# Introduction diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000000..6a8cd951ce --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,36 @@ +# Summary + +- [Introduction](README.md) + +# Development Documentation + +- [Introduction](dev/README.md) +- [Setup environment](dev/setup.md) +- [Build](dev/build.md) +- [Testing](dev/tests.md) +- [Guidelines](dev/guidelines.md) + +# Reference Manual + +- [Introduction](ref/README.md) +- [Architecture](ref/architecture.md) +- [Configuration](ref/configuration.md) +- [Usage manual](ref/usage.md) +- [Security](ref/security.md) +- [Performance](ref/performance.md) + +# Package Documentation + +- [Introduction](pkg/README.md) +- [Build packages](pkg/build.md) +- [Install](pkg/install.md) +- [Backup](pkg/backup.md) +- [Upgrade](pkg/upgrade.md) +- [Uninstall](pkg/uninstall.md) + +# Diagnostic Documentation + +- [Introduction](diag/README.md) +- [What to Collect](diag/collect.md) +- [What to Check](diag/check.md) +- [Frequent logs](diag/frequent_logs.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000000..9c37710539 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Vikman Fernandez-Castro"] +language = "en" +multilingual = false +src = "." +title = "Wazuh Agent Documentation" diff --git a/docs/dev/README.md b/docs/dev/README.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/dev/build.md b/docs/dev/build.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/dev/guidelines.md b/docs/dev/guidelines.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/dev/setup.md b/docs/dev/setup.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/dev/tests.md b/docs/dev/tests.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/diag/README.md b/docs/diag/README.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/diag/check.md b/docs/diag/check.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/diag/collect.md b/docs/diag/collect.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/diag/frequent_logs.md b/docs/diag/frequent_logs.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/pkg/README.md b/docs/pkg/README.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/pkg/backup.md b/docs/pkg/backup.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/pkg/build.md b/docs/pkg/build.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/pkg/install.md b/docs/pkg/install.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/pkg/uninstall.md b/docs/pkg/uninstall.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/pkg/upgrade.md b/docs/pkg/upgrade.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/ref/README.md b/docs/ref/README.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/ref/architecture.md b/docs/ref/architecture.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/ref/configuration.md b/docs/ref/configuration.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/ref/performance.md b/docs/ref/performance.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/ref/security.md b/docs/ref/security.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/ref/usage.md b/docs/ref/usage.md new file mode 100644 index 0000000000..e69de29bb2 From 43c0ba8383fb94e768ed52fe4ff9a28ef3745403 Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Mon, 2 Dec 2024 13:37:56 +0100 Subject: [PATCH 2/6] docs: add documentation support scripts --- docs/build.sh | 3 +++ docs/server.sh | 3 +++ 2 files changed, 6 insertions(+) create mode 100755 docs/build.sh create mode 100755 docs/server.sh diff --git a/docs/build.sh b/docs/build.sh new file mode 100755 index 0000000000..f8281a771a --- /dev/null +++ b/docs/build.sh @@ -0,0 +1,3 @@ +#! /bin/sh + +mdbook build diff --git a/docs/server.sh b/docs/server.sh new file mode 100755 index 0000000000..f4da25e5c8 --- /dev/null +++ b/docs/server.sh @@ -0,0 +1,3 @@ +#! /bin/sh + +mdbook serve From 863178eed1f50f5955d21ac9b5559334e48219cc Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Mon, 2 Dec 2024 13:39:28 +0100 Subject: [PATCH 3/6] docs: add documentation deploy workflow --- .github/workflows/deploy-docs.yml | 42 +++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/deploy-docs.yml diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000000..7c0a746d3d --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,42 @@ +name: deploy-gh-pages + +on: + push: + branches: + - main + workflow_dispatch: +permissions: + contents: write + pages: write + id-token: write + +jobs: + build: + runs-on: ubuntu-20.04 + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + steps: + - uses: actions/checkout@v4 + - name: Setup mdBook + uses: jontze/action-mdbook@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + use-mermaid: true + - run: mdbook build + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: './book' + + deploy: + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From 1fcc26870fdba4176539b94480a14c3e18b6be39 Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Wed, 4 Dec 2024 18:13:10 +0100 Subject: [PATCH 4/6] docs: add diagnostic guide --- docs/diag/check.md | 5 ++ docs/diag/collect.md | 165 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 170 insertions(+) diff --git a/docs/diag/check.md b/docs/diag/check.md index e69de29bb2..7132694ad3 100644 --- a/docs/diag/check.md +++ b/docs/diag/check.md @@ -0,0 +1,5 @@ +# What to Check + +1. **Agent's connectivity** +2. **Folder permissions** +3. **Frequent errors** diff --git a/docs/diag/collect.md b/docs/diag/collect.md index e69de29bb2..9435a153b1 100644 --- a/docs/diag/collect.md +++ b/docs/diag/collect.md @@ -0,0 +1,165 @@ +# What to Collect + +1. **Agent version and service status** +2. **Configuration files** +3. **Logs** +4. **System resource usage** + +### Agent Version and Status + +#### Linux + +``` +/usr/share/wazuh-agent/bin/wazuh-agent -v +``` +``` +systemctl status wazuh-agent +``` + +#### macOS + +``` +/Library/Application Support/wazuh-agent/bin/wazuh-agent -v +``` + +#### Windows + +``` +"C:\\Program Files\\wazuh-agent\\wazuh-agent.exe" -v +``` +``` +Get-Service -Name wazuh-agent +``` + +### Configuration Files + +#### Linux + +To gather the configuration file, locate the following file: + +- /etc/wazuh-agent/wazuh-agent.yml + +Copy this filee for analysis. + +#### macOS + +To gather the configuration file, locate the following file: + +- /Library/Application Support/wazuh-agent/etc/wazuh-agent.yml + +Copy this filee for analysis. + +#### Windows + +To gather the configuration file, locate the following file: + +- C:\\ProgramData\\wazuh-agent\\etc\\wazuh.yml + +Copy this filee for analysis. + +### Logs + +#### Linux + +Use `journald` or `systemctl status wazuh-agent` to capture logs related to `wazuh-agent`. + +```bash +journalctl -u wazuh-agent.service +``` + +#### macOS + +Use the Unified Logging System (ULS) to extract logs related to `wazuh-agent`. + +```bash +log show --predicate 'process == "wazuh-agent"' --info +``` + +#### Windows + +Use the Event Viewer to search for logs related to `wazuh-agent`. + +### System Resources + +#### Linux & macOS + +Collect system resource usage data to understand the agent's performance impact. Fill in the table below with the relevant data: + +| Daemon | CPU usage | RAM usage | Disk usage | Network usage | +|----------------------|-----------|-----------|------------|-----------------------------| +| (Global) | | | | (Connections to port 27000) | +| `wazuh-agent` | | | | | + +#### Steps to collect system resource data + +1. **CPU and RAM usage:** + - Use the `top` or `htop` command to monitor CPU and RAM usage for `wazuh-agent`. +2. **Disk usage:** + - Use the `df -h` command to check the disk usage of the file system where Wazuh is installed. + - Use the `du -h` command to check the disk usage of the Wazuh agent installation (usually _/usr/share/wazuh-agent_). +3. **Network usage:** + - Use the `netstat` or `ss` command to monitor connections to ports 1514 and 1515. + - Alternatively, use tools like `iftop` or `nload` to measure real-time network usage. + +##### Example commands + +1. **CPU and RAM usage:** + ```bash + top -p $(pgrep -d',' wazuh-agent) + top -p $(pgrep -d',' wazuh-modulesd) + ``` +2. **Disk usage:** + ```bash + df -h /usr/share/wazuh-agent + df -h /var/lib/wazuh-agent + ``` +3. **Network usage:** + ```bash + netstat -an | grep ':1514\|:1515' + ``` + +#### Windows + +Collect system resource usage data to understand the agent's performance impact. Fill in the table below with the relevant data: + +| Daemon | CPU usage | RAM usage | Disk usage | Network usage | +|-------------------|-----------|-----------|------------|-----------------------------------| +| `wazuh-agent.exe` | | | | | + +#### Steps to collect system resource data + +1. **CPU and RAM usage:** + - Use the Task Manager or the `tasklist` command to monitor CPU and RAM usage for `wazuh-agent.exe`. +2. **Disk usage:** + - Use the `dir` command to check the disk usage of the directory where Wazuh is installed. + - Alternatively, use the Disk Management tool or the `Get-PSDrive` PowerShell cmdlet. +3. **Network usage:** + - Use the `netstat` command to monitor connections to ports 1514 and 1515. + - Alternatively, use tools like Resource Monitor or PowerShell cmdlets such as `Get-NetTCPConnection`. + +##### Example commands + +1. **CPU and RAM usage:** + - Open Task Manager, go to the "Details" tab, and find `wazuh-agent.exe`. + - Or use the command prompt: + ```cmd + tasklist /fi "imagename eq wazuh-agent.exe" + ``` +2. **Disk usage:** + - Command prompt: + ```cmd + dir "C:\\Program Files\\wazuh-agent" /s + ``` + - PowerShell: + ```powershell + Get-PSDrive -PSProvider FileSystem + ``` +3. **Network usage:** + - Command prompt: + ```cmd + netstat -an | findstr ":1514" | findstr ":1515" + ``` + - PowerShell: + ```powershell + Get-NetTCPConnection -LocalPort 1514,1515 + ``` From 1b1b4a96f061f7e03e2f9d25af66d30a82726641 Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Tue, 10 Dec 2024 16:25:12 +0100 Subject: [PATCH 5/6] docs: main README file --- docs/README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index e10b99d013..a3596913c1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,25 @@ -# Introduction +# Wazuh Agent Technical Documentation + +This folder contains the technical documentation for the Wazuh Agent. The documentation is organized into the following guides: + +- **Development Guide**: Instructions for building, testing, and packaging the agent. +- **Reference Manual**: Detailed information on the agent’s architecture, configuration, and usage. +- **Diagnostic Guide**: Steps to diagnose errors and resolve common issues. + +## Requirements + +To work with this documentation, you need **mdBook** installed. For installation instructions, refer to the [mdBook documentation](https://rust-lang.github.io/mdBook/). + +## Usage + +- To build the documentation, run: + ```bash + ./build.sh + ``` + The output will be generated in the `book` directory. + +- To serve the documentation locally for preview, run: + ```bash + ./server.sh + ``` + The documentation will be available at [http://127.0.0.1:3000](http://127.0.0.1:3000). From 5a14bc9ca1d61444a89e457168aa2b44be6ca860 Mon Sep 17 00:00:00 2001 From: Vikman Fernandez-Castro Date: Fri, 20 Dec 2024 14:11:06 +0100 Subject: [PATCH 6/6] docs: update documentation scaffolding --- docs/SUMMARY.md | 47 +++++++++++-------- docs/dev/build-image.md | 1 + docs/dev/build-packages.md | 1 + docs/dev/build-sources.md | 3 ++ docs/dev/build.md | 0 docs/dev/guidelines.md | 0 docs/dev/run-agent.md | 1 + docs/dev/run-tests.md | 1 + docs/dev/setup.md | 4 ++ docs/dev/tests.md | 0 docs/diag/README.md | 0 docs/diag/check.md | 5 -- docs/diag/{collect.md => diagnostic.md} | 2 +- docs/diag/frequent_logs.md | 0 docs/pkg/README.md | 0 docs/pkg/backup.md | 0 docs/pkg/build.md | 0 docs/pkg/install.md | 0 docs/pkg/uninstall.md | 0 docs/pkg/upgrade.md | 0 docs/ref/architecture.md | 1 + docs/ref/backup-restore.md | 1 + docs/ref/compatibility.md | 1 + docs/ref/configuration.md | 1 + docs/ref/description.md | 1 + docs/ref/getting-started/README.md | 1 + docs/ref/getting-started/installation.md | 1 + docs/ref/getting-started/packages.md | 1 + docs/ref/getting-started/requirements.md | 1 + docs/ref/glossary.md | 1 + docs/ref/modules/README.md | 1 + docs/ref/modules/fim/README.md | 1 + docs/ref/modules/fim/api-reference.md | 1 + docs/ref/modules/fim/architecture.md | 1 + docs/ref/modules/inventory/README.md | 1 + docs/ref/modules/inventory/api-reference.md | 1 + docs/ref/modules/inventory/architecture.md | 1 + docs/ref/modules/logcollector/README.md | 1 + .../ref/modules/logcollector/api-reference.md | 1 + docs/ref/modules/logcollector/architecture.md | 1 + docs/ref/performance.md | 1 + docs/ref/security.md | 1 + docs/ref/uninstall.md | 1 + docs/ref/upgrade.md | 1 + docs/ref/usage.md | 0 45 files changed, 64 insertions(+), 25 deletions(-) create mode 100644 docs/dev/build-image.md create mode 100644 docs/dev/build-packages.md create mode 100644 docs/dev/build-sources.md delete mode 100644 docs/dev/build.md delete mode 100644 docs/dev/guidelines.md create mode 100644 docs/dev/run-agent.md create mode 100644 docs/dev/run-tests.md delete mode 100644 docs/dev/tests.md delete mode 100644 docs/diag/README.md delete mode 100644 docs/diag/check.md rename docs/diag/{collect.md => diagnostic.md} (99%) delete mode 100644 docs/diag/frequent_logs.md delete mode 100644 docs/pkg/README.md delete mode 100644 docs/pkg/backup.md delete mode 100644 docs/pkg/build.md delete mode 100644 docs/pkg/install.md delete mode 100644 docs/pkg/uninstall.md delete mode 100644 docs/pkg/upgrade.md create mode 100644 docs/ref/backup-restore.md create mode 100644 docs/ref/compatibility.md create mode 100644 docs/ref/description.md create mode 100644 docs/ref/getting-started/README.md create mode 100644 docs/ref/getting-started/installation.md create mode 100644 docs/ref/getting-started/packages.md create mode 100644 docs/ref/getting-started/requirements.md create mode 100644 docs/ref/glossary.md create mode 100644 docs/ref/modules/README.md create mode 100644 docs/ref/modules/fim/README.md create mode 100644 docs/ref/modules/fim/api-reference.md create mode 100644 docs/ref/modules/fim/architecture.md create mode 100644 docs/ref/modules/inventory/README.md create mode 100644 docs/ref/modules/inventory/api-reference.md create mode 100644 docs/ref/modules/inventory/architecture.md create mode 100644 docs/ref/modules/logcollector/README.md create mode 100644 docs/ref/modules/logcollector/api-reference.md create mode 100644 docs/ref/modules/logcollector/architecture.md create mode 100644 docs/ref/uninstall.md create mode 100644 docs/ref/upgrade.md delete mode 100644 docs/ref/usage.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 6a8cd951ce..6083644195 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -5,32 +5,41 @@ # Development Documentation - [Introduction](dev/README.md) -- [Setup environment](dev/setup.md) -- [Build](dev/build.md) -- [Testing](dev/tests.md) -- [Guidelines](dev/guidelines.md) +- [Setup Environment](dev/setup.md) +- [Build Packages](dev/build-packages.md) +- [Build Image](dev/build-image.md) +- [Build from Sources](dev/build-sources.md) +- [Run from Sources](dev/run-agent.md) +- [Run Tests](dev/run-tests.md) # Reference Manual - [Introduction](ref/README.md) -- [Architecture](ref/architecture.md) + - [Description](ref/description.md) + - [Architecture](ref/architecture.md) + - [Compatibility](ref/compatibility.md) +- [Getting Started](ref/getting-started/README.md) + - [Requirements](ref/getting-started/requirements.md) + - [Packages](ref/getting-started/packages.md) + - [Installation](ref/getting-started/installation.md) - [Configuration](ref/configuration.md) -- [Usage manual](ref/usage.md) +- [Modules](ref/modules/README.md) + - [File Integrity monitoring](ref/modules/fim/README.md) + - [Architecture](ref/modules/fim/architecture.md) + - [API Reference](ref/modules/fim/api-reference.md) + - [Inventory](ref/modules/inventory/README.md) + - [Architecture](ref/modules/inventory/architecture.md) + - [API Reference](ref/modules/inventory/api-reference.md) + - [Logcollector](ref/modules/logcollector/README.md) + - [Architecture](ref/modules/logcollector/architecture.md) + - [API Reference](ref/modules/logcollector/api-reference.md) +- [Upgrade](ref/upgrade.md) +- [Uninstall](ref/uninstall.md) +- [Back Up and Restore](ref/backup-restore.md) - [Security](ref/security.md) - [Performance](ref/performance.md) - -# Package Documentation - -- [Introduction](pkg/README.md) -- [Build packages](pkg/build.md) -- [Install](pkg/install.md) -- [Backup](pkg/backup.md) -- [Upgrade](pkg/upgrade.md) -- [Uninstall](pkg/uninstall.md) +- [Glossary](ref/glossary.md) # Diagnostic Documentation -- [Introduction](diag/README.md) -- [What to Collect](diag/collect.md) -- [What to Check](diag/check.md) -- [Frequent logs](diag/frequent_logs.md) +- [Diagnostic Guide](diag/diagnostic.md) diff --git a/docs/dev/build-image.md b/docs/dev/build-image.md new file mode 100644 index 0000000000..2708f9a459 --- /dev/null +++ b/docs/dev/build-image.md @@ -0,0 +1 @@ +# Build a Container Image diff --git a/docs/dev/build-packages.md b/docs/dev/build-packages.md new file mode 100644 index 0000000000..308797fed6 --- /dev/null +++ b/docs/dev/build-packages.md @@ -0,0 +1 @@ +# Build Packages diff --git a/docs/dev/build-sources.md b/docs/dev/build-sources.md new file mode 100644 index 0000000000..3a7ed5f7aa --- /dev/null +++ b/docs/dev/build-sources.md @@ -0,0 +1,3 @@ +# Build from Sources + +## Build Scripts / Makefiles diff --git a/docs/dev/build.md b/docs/dev/build.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/dev/guidelines.md b/docs/dev/guidelines.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/dev/run-agent.md b/docs/dev/run-agent.md new file mode 100644 index 0000000000..3e6ea4ba06 --- /dev/null +++ b/docs/dev/run-agent.md @@ -0,0 +1 @@ +# Run from Sources diff --git a/docs/dev/run-tests.md b/docs/dev/run-tests.md new file mode 100644 index 0000000000..657987466d --- /dev/null +++ b/docs/dev/run-tests.md @@ -0,0 +1 @@ +# Run Tests diff --git a/docs/dev/setup.md b/docs/dev/setup.md index e69de29bb2..34725e5b6a 100644 --- a/docs/dev/setup.md +++ b/docs/dev/setup.md @@ -0,0 +1,4 @@ +# Set up the Development Environment + +## Set up the Toolchain +## Set up Editor / Debugger diff --git a/docs/dev/tests.md b/docs/dev/tests.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/diag/README.md b/docs/diag/README.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/diag/check.md b/docs/diag/check.md deleted file mode 100644 index 7132694ad3..0000000000 --- a/docs/diag/check.md +++ /dev/null @@ -1,5 +0,0 @@ -# What to Check - -1. **Agent's connectivity** -2. **Folder permissions** -3. **Frequent errors** diff --git a/docs/diag/collect.md b/docs/diag/diagnostic.md similarity index 99% rename from docs/diag/collect.md rename to docs/diag/diagnostic.md index 9435a153b1..975a4b3dd9 100644 --- a/docs/diag/collect.md +++ b/docs/diag/diagnostic.md @@ -1,4 +1,4 @@ -# What to Collect +# Diagnostic Guide 1. **Agent version and service status** 2. **Configuration files** diff --git a/docs/diag/frequent_logs.md b/docs/diag/frequent_logs.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/pkg/README.md b/docs/pkg/README.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/pkg/backup.md b/docs/pkg/backup.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/pkg/build.md b/docs/pkg/build.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/pkg/install.md b/docs/pkg/install.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/pkg/uninstall.md b/docs/pkg/uninstall.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/pkg/upgrade.md b/docs/pkg/upgrade.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/ref/architecture.md b/docs/ref/architecture.md index e69de29bb2..c79bec1ac6 100644 --- a/docs/ref/architecture.md +++ b/docs/ref/architecture.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/ref/backup-restore.md b/docs/ref/backup-restore.md new file mode 100644 index 0000000000..d2f033ad48 --- /dev/null +++ b/docs/ref/backup-restore.md @@ -0,0 +1 @@ +# Back Up and Restore diff --git a/docs/ref/compatibility.md b/docs/ref/compatibility.md new file mode 100644 index 0000000000..9ccd656b37 --- /dev/null +++ b/docs/ref/compatibility.md @@ -0,0 +1 @@ +# Compatibility diff --git a/docs/ref/configuration.md b/docs/ref/configuration.md index e69de29bb2..a025a48b1b 100644 --- a/docs/ref/configuration.md +++ b/docs/ref/configuration.md @@ -0,0 +1 @@ +# Configuration diff --git a/docs/ref/description.md b/docs/ref/description.md new file mode 100644 index 0000000000..f719117cf3 --- /dev/null +++ b/docs/ref/description.md @@ -0,0 +1 @@ +# Description diff --git a/docs/ref/getting-started/README.md b/docs/ref/getting-started/README.md new file mode 100644 index 0000000000..bad55622f9 --- /dev/null +++ b/docs/ref/getting-started/README.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docs/ref/getting-started/installation.md b/docs/ref/getting-started/installation.md new file mode 100644 index 0000000000..25267fe2b7 --- /dev/null +++ b/docs/ref/getting-started/installation.md @@ -0,0 +1 @@ +# Installation diff --git a/docs/ref/getting-started/packages.md b/docs/ref/getting-started/packages.md new file mode 100644 index 0000000000..3fbbc74f7b --- /dev/null +++ b/docs/ref/getting-started/packages.md @@ -0,0 +1 @@ +# Packages diff --git a/docs/ref/getting-started/requirements.md b/docs/ref/getting-started/requirements.md new file mode 100644 index 0000000000..1fa9034a09 --- /dev/null +++ b/docs/ref/getting-started/requirements.md @@ -0,0 +1 @@ +# Requirements diff --git a/docs/ref/glossary.md b/docs/ref/glossary.md new file mode 100644 index 0000000000..ca3c827692 --- /dev/null +++ b/docs/ref/glossary.md @@ -0,0 +1 @@ +# Glossary diff --git a/docs/ref/modules/README.md b/docs/ref/modules/README.md new file mode 100644 index 0000000000..a55ecc055e --- /dev/null +++ b/docs/ref/modules/README.md @@ -0,0 +1 @@ +# Modules diff --git a/docs/ref/modules/fim/README.md b/docs/ref/modules/fim/README.md new file mode 100644 index 0000000000..1703d0a9ec --- /dev/null +++ b/docs/ref/modules/fim/README.md @@ -0,0 +1 @@ +# File Integrity monitoring diff --git a/docs/ref/modules/fim/api-reference.md b/docs/ref/modules/fim/api-reference.md new file mode 100644 index 0000000000..b0d5c88fcb --- /dev/null +++ b/docs/ref/modules/fim/api-reference.md @@ -0,0 +1 @@ +# API Reference diff --git a/docs/ref/modules/fim/architecture.md b/docs/ref/modules/fim/architecture.md new file mode 100644 index 0000000000..c79bec1ac6 --- /dev/null +++ b/docs/ref/modules/fim/architecture.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/ref/modules/inventory/README.md b/docs/ref/modules/inventory/README.md new file mode 100644 index 0000000000..f9a97fad0a --- /dev/null +++ b/docs/ref/modules/inventory/README.md @@ -0,0 +1 @@ +# Inventory diff --git a/docs/ref/modules/inventory/api-reference.md b/docs/ref/modules/inventory/api-reference.md new file mode 100644 index 0000000000..b0d5c88fcb --- /dev/null +++ b/docs/ref/modules/inventory/api-reference.md @@ -0,0 +1 @@ +# API Reference diff --git a/docs/ref/modules/inventory/architecture.md b/docs/ref/modules/inventory/architecture.md new file mode 100644 index 0000000000..c79bec1ac6 --- /dev/null +++ b/docs/ref/modules/inventory/architecture.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/ref/modules/logcollector/README.md b/docs/ref/modules/logcollector/README.md new file mode 100644 index 0000000000..39d2a8c690 --- /dev/null +++ b/docs/ref/modules/logcollector/README.md @@ -0,0 +1 @@ +# Logcollector diff --git a/docs/ref/modules/logcollector/api-reference.md b/docs/ref/modules/logcollector/api-reference.md new file mode 100644 index 0000000000..b0d5c88fcb --- /dev/null +++ b/docs/ref/modules/logcollector/api-reference.md @@ -0,0 +1 @@ +# API Reference diff --git a/docs/ref/modules/logcollector/architecture.md b/docs/ref/modules/logcollector/architecture.md new file mode 100644 index 0000000000..c79bec1ac6 --- /dev/null +++ b/docs/ref/modules/logcollector/architecture.md @@ -0,0 +1 @@ +# Architecture diff --git a/docs/ref/performance.md b/docs/ref/performance.md index e69de29bb2..6babb314a5 100644 --- a/docs/ref/performance.md +++ b/docs/ref/performance.md @@ -0,0 +1 @@ +# Performance diff --git a/docs/ref/security.md b/docs/ref/security.md index e69de29bb2..8dbb2f9bce 100644 --- a/docs/ref/security.md +++ b/docs/ref/security.md @@ -0,0 +1 @@ +# Security diff --git a/docs/ref/uninstall.md b/docs/ref/uninstall.md new file mode 100644 index 0000000000..316df2650a --- /dev/null +++ b/docs/ref/uninstall.md @@ -0,0 +1 @@ +# Uninstall diff --git a/docs/ref/upgrade.md b/docs/ref/upgrade.md new file mode 100644 index 0000000000..dab017fb82 --- /dev/null +++ b/docs/ref/upgrade.md @@ -0,0 +1 @@ +# Upgrade diff --git a/docs/ref/usage.md b/docs/ref/usage.md deleted file mode 100644 index e69de29bb2..0000000000