This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-rover.git
The following commit(s) were added to refs/heads/main by this push:
new c91e179 Adjust documentation (#119)
c91e179 is described below
commit c91e1793488d6275d0af939ffe40e8b1ef01e3ae
Author: mrproliu <[email protected]>
AuthorDate: Tue Mar 19 12:24:11 2024 +0000
Adjust documentation (#119)
---
CHANGES.md | 3 ++
docs/en/concepts-and-designs/architecture.png | Bin 0 -> 28427 bytes
docs/en/concepts-and-designs/module_design.md | 38 ----------------
docs/en/concepts-and-designs/overview.md | 2 +-
docs/en/concepts-and-designs/project_structue.md | 49 ---------------------
docs/en/setup/configuration/{core.md => common.md} | 16 +++++--
docs/en/setup/configuration/logger.md | 9 ----
docs/en/setup/configuration/profiling.md | 4 +-
.../{process-discovery.md => service-discovery.md} | 4 +-
.../configuration/{accesslog.md => traffic.md} | 4 +-
.../deploy => deployment}/kubernetes/readme.md | 2 +-
.../kubernetes/rover-daemonset.yml | 0
docs/en/setup/overview.md | 19 +++-----
docs/menu.yml | 30 +++++--------
14 files changed, 39 insertions(+), 141 deletions(-)
diff --git a/CHANGES.md b/CHANGES.md
index f9de66b..fd58b82 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -18,6 +18,9 @@ Release Notes.
#### Bug Fixes
#### Documentation
+* Update architecture diagram.
+* Delete module design and project structure document.
+* Adjust configuration modules during setup.
#### Issues and PR
- All issues are
[here](https://github.com/apache/skywalking/milestone/185?closed=1)
diff --git a/docs/en/concepts-and-designs/architecture.png
b/docs/en/concepts-and-designs/architecture.png
new file mode 100644
index 0000000..218c0fe
Binary files /dev/null and b/docs/en/concepts-and-designs/architecture.png
differ
diff --git a/docs/en/concepts-and-designs/module_design.md
b/docs/en/concepts-and-designs/module_design.md
deleted file mode 100644
index e2c752f..0000000
--- a/docs/en/concepts-and-designs/module_design.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Module Design
-## Overview
-
-The module is an isolation concept in Rover. Each module completes an
independent feature.
-
-## Life Cycle
-
-Each concept has a complete life cycle.
-
-- Start: Start phase is to start the current module.
-- NotifyStartSuccess: Execute when all modules have finished starting without
any errors.
-- Shutdown: The shutdown phase is to close all the used resources.
-
-## Config
-
-Each module has its corresponding configurations and only when they're set in
the configuration file, the module would be enabled.
-
-The config data support various data structures, and it could use
`${ENV_NAME:DEFAULT}` to read the value from the environment variables.
-
-## Dependency
-
-There may have dependencies between modules.
-
-For example, process and profiling are two separate modules, the profiling
module needs to read all registered processes from the processing module. So,
we could say the profiling module is dependent on the process module.
-
-### Module API
-
-Modules can communicate by calling APIs from dependent modules.
-
-### Start Sequence
-
-When Rover starts, it would analyze the dependency order of all enabled
modules to a startup module list.
-
-The startup sequence is following these steps:
-1. Modules have the fewest dependent modules.
-2. The position of the module declaration in the configuration file.
-
-After parsing the list of startup modules, it would be started sequentially in
a single-threaded manner.
\ No newline at end of file
diff --git a/docs/en/concepts-and-designs/overview.md
b/docs/en/concepts-and-designs/overview.md
index cb111ef..3f4e7c8 100644
--- a/docs/en/concepts-and-designs/overview.md
+++ b/docs/en/concepts-and-designs/overview.md
@@ -14,7 +14,7 @@ and upload them to the SkyWalking backend for analysis,
aggregate, and visualize
## Architecture
-
+
- **Process** represents the data monitored by Rover.
- **Rover** is deployed in the VM instance, collects data in VM and Process,
and reports it to the OAP cluster.
diff --git a/docs/en/concepts-and-designs/project_structue.md
b/docs/en/concepts-and-designs/project_structue.md
deleted file mode 100644
index 44890cf..0000000
--- a/docs/en/concepts-and-designs/project_structue.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# Project Structure
-- cmd: The starter of Rover.
-- configs: Rover configs.
-- bpf: All the BPF programs with C code.
-- docker: Docker files for build Rover image.
-- docs: The documentation of Rover.
-- pkg: Contains all modules and basic framework.
- - logger: Manage the log.
- - config: Read config for start.
- - module: The interface of each module.
- - boot: Manage all enabled module life cycle.
- - core: Manage the connection with OAP.
- - process: Manage the process detect and upload them to the OAP.
- - profiling: Manage the profiling tasks and upload data to the OAP.
- - tools: Sharing tools for each module.
-- internal/cmd: Command lines for execute the Rover.
-- script: The rover related shell scripts.
- - build: For `make` command use.
- - check: Check the rover features is supported for the system.
- - debug: Generate the debug information for the programs.
- - release: Fot release the rover.
-- test/e2e: E2E test to verify the Rover future.
-```
-.
-├── CHANGES.md
-├── cmd
-├── configs
-├── bpf
-├── docker
-├── docs
-├── script
-│ ├── build
-│ ├── check
-│ ├── debug
-│ ├── release
-├── pkg
-│ ├── logger
-│ ├── config
-│ ├── module
-│ ├── boot
-│ ├── core
-│ ├── process
-│ ├── profiling
-│ ├── tools
-├── test
-│ ├── e2e
-├── internal
-│ ├── cmd
-```
\ No newline at end of file
diff --git a/docs/en/setup/configuration/core.md
b/docs/en/setup/configuration/common.md
similarity index 84%
rename from docs/en/setup/configuration/core.md
rename to docs/en/setup/configuration/common.md
index 0ef922e..c859485 100644
--- a/docs/en/setup/configuration/core.md
+++ b/docs/en/setup/configuration/common.md
@@ -1,9 +1,17 @@
-# Core Module
+# Common configuration
-Core Module is used to communicate with the backend server.
-It provides APIs for other modules to establish connections with the backend.
+## Logger
+
+Logger is used to configure the system log.
+
+| Name | Default | Environment Key | Description
|
+|---------------|---------|---------------------|----------------------------------------|
+| logger.level | INFO | ROVER_LOGGER_LEVEL | The lowest level of printing
allowed. |
-## Configuration
+## Core
+
+Core is used to communicate with the backend server.
+It provides APIs for other modules to establish connections with the backend.
| Name | Default | Environment Key
| Description
|
|-----------------------------------|-----------------|------------------------------------|-----------------------------------------------------------------------------------------------------|
diff --git a/docs/en/setup/configuration/logger.md
b/docs/en/setup/configuration/logger.md
deleted file mode 100644
index 60a73e1..0000000
--- a/docs/en/setup/configuration/logger.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# Logger Module
-
-Logger module is used to configure the system log.
-
-## Configuration
-
-| Name | Default | Environment Key | Description
|
-|---------------|---------|---------------------|----------------------------------------|
-| logger.level | INFO | ROVER_LOGGER_LEVEL | The lowest level of printing
allowed. |
\ No newline at end of file
diff --git a/docs/en/setup/configuration/profiling.md
b/docs/en/setup/configuration/profiling.md
index 742b36a..0b7c72c 100644
--- a/docs/en/setup/configuration/profiling.md
+++ b/docs/en/setup/configuration/profiling.md
@@ -1,6 +1,6 @@
-# Profiling Module
+# Profiling
-The profiling module is used to profiling the processes from the [Process
Discovery Module](../process_discovery/overview.md),
+The profiling is used to profiling the processes from the [Service
Discovery](service-discovery.md),
and send the snapshot to the backend server.
## Configuration
diff --git a/docs/en/setup/configuration/process-discovery.md
b/docs/en/setup/configuration/service-discovery.md
similarity index 98%
rename from docs/en/setup/configuration/process-discovery.md
rename to docs/en/setup/configuration/service-discovery.md
index 60ee2b8..85560a7 100644
--- a/docs/en/setup/configuration/process-discovery.md
+++ b/docs/en/setup/configuration/service-discovery.md
@@ -1,6 +1,6 @@
-# Process Discovery Module
+# Service Discovery
-The process Discovery module is used to discover the existing processes in the
current machine and report them to the backend service.
+Service discovery is used to discover all Kubernetes services process in the
current node and report them to backend services.
After the process upload is completed, the other modules could perform more
operations with the process, such as process profiling and collecting process
metrics.
## Configuration
diff --git a/docs/en/setup/configuration/accesslog.md
b/docs/en/setup/configuration/traffic.md
similarity index 96%
rename from docs/en/setup/configuration/accesslog.md
rename to docs/en/setup/configuration/traffic.md
index 2a655fc..940ce25 100644
--- a/docs/en/setup/configuration/accesslog.md
+++ b/docs/en/setup/configuration/traffic.md
@@ -1,6 +1,6 @@
-# Access Log Module
+# Traffic
-The access log module is used to collecting the network access logs from the
[Kerbernetes Module](process_discovery/kubernetes.md),
+The traffic is used to collecting the network access logs from services
through the [Service Discovery](service-discovery.md),
and send [access
logs](https://github.com/apache/skywalking-data-collect-protocol/blob/master/ebpf/accesslog.proto)
to the backend server for analyze.
## Configuration
diff --git a/docs/en/setup/examples/deploy/kubernetes/readme.md
b/docs/en/setup/deployment/kubernetes/readme.md
similarity index 82%
rename from docs/en/setup/examples/deploy/kubernetes/readme.md
rename to docs/en/setup/deployment/kubernetes/readme.md
index c9c11ae..50fd907 100644
--- a/docs/en/setup/examples/deploy/kubernetes/readme.md
+++ b/docs/en/setup/deployment/kubernetes/readme.md
@@ -11,7 +11,7 @@ or [minikube](https://minikube.sigs.k8s.io) to create a
cluster.
## Deploy Rover
-Please follow the [rover-daemonset.yml](./rover-daemonset.yml) to deploy the
rover in your Kubernetes cluster.
+Please follow the [rover-daemonset.yml](rover-daemonset.yml) to deploy the
rover in your Kubernetes cluster.
Update the comment in the file, which includes two configs:
1. **Rover docker image**: You could use `make docker` to build an image and
upload it to your private registry, or update from the public image.
2. **OAP address**: Update the OAP address.
diff --git a/docs/en/setup/examples/deploy/kubernetes/rover-daemonset.yml
b/docs/en/setup/deployment/kubernetes/rover-daemonset.yml
similarity index 100%
rename from docs/en/setup/examples/deploy/kubernetes/rover-daemonset.yml
rename to docs/en/setup/deployment/kubernetes/rover-daemonset.yml
diff --git a/docs/en/setup/overview.md b/docs/en/setup/overview.md
index 58f7dec..1cdc7ff 100644
--- a/docs/en/setup/overview.md
+++ b/docs/en/setup/overview.md
@@ -31,26 +31,19 @@ You can quickly build your Rover according to the following
examples:
### Deploy
-1. [Deploy on Kubernetes](examples/deploy/kubernetes/readme.md)
-
-### Use Cases
-
-1. [Profiling a Golang/C/C++/Rust service on
Linux](examples/cases/profiling-process/readme.md)
-1. [Detect Process by Agent Sensor](examples/cases/agent-sensor/readme.md)
-1. [Detect Process in Kubernetes
Environemnt](examples/cases/kubernetes-process/readme.md)
+1. [Deploy on Kubernetes](deployment/kubernetes/readme.md)
## Configuration
The core concept behind this setting file is, that SkyWalking Rover is based
on pure modularization design. The end-user can switch or assemble the
collector features to their requirements.
So, in rover_configs.yaml, there contains these parts.
-1. [Logger Module](./configuration/logger.md).
-2. [Core Module](./configuration/core.md).
-3. [Process Discovery Module](configuration/process-discovery.md).
-4. [Profiling Module](./configuration/profiling.md).
-5. [Access Log Module](./configuration/accesslog.md).
+1. [Common](./configuration/common.md).
+2. [Service Discovery](configuration/service-discovery.md).
+3. [Traffic](./configuration/traffic.md).
+4. [Profiling](./configuration/profiling.md).
-Also, You could using [Overriding
Setting](./configuration/override-settings.md) feature to setup the
configuration.
+Also, You could use [Overriding Setting](./configuration/override-settings.md)
feature to adjust the configurations.
## Prerequisites
diff --git a/docs/menu.yml b/docs/menu.yml
index edc2b54..9049d99 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -23,34 +23,24 @@ catalog:
catalog:
- name: Overview and Core Concepts
path: /en/concepts-and-designs/overview
- - name: Design
- catalog:
- - name: Module Design
- path: /en/concepts-and-designs/module_design
- - name: Project Structure
- path: /en/concepts-and-designs/project_structue
- name: Setup
catalog:
- name: Overview
path: /en/setup/overview
- name: Configuration
catalog:
- - name: Logger Module
- path: /en/setup/configuration/logger
- - name: Core Module
- path: /en/setup/configuration/core
- - name: Process Discovery Module
- path: /en/setup/configuration/process-discovery
- - name: Profiling Module
+ - name: Common
+ path: /en/setup/configuration/common
+ - name: Service Discovery
+ path: /en/setup/configuration/service-discovery
+ - name: Traffic
+ path: /en/setup/configuration/traffic
+ - name: Profiling
path: /en/setup/configuration/profiling
- - name: Access Log Module
- path: /en/setup/configuration/accesslog
- - name: Examples
+ - name: Deployment
catalog:
- - name: Deploy
- catalog:
- - name: Deploy on Kubernetes
- path: /en/setup/examples/deploy/kubernetes/readme
+ - name: Deploy on K8s
+ path: /en/setup/deployment/kubernetes/readme
- name: Guides
catalog:
- name: Contribution
