Skip to content

Commit

Permalink
Adjust documentation (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrproliu authored Mar 19, 2024
1 parent d3a0f87 commit c91e179
Show file tree
Hide file tree
Showing 14 changed files with 39 additions and 141 deletions.
3 changes: 3 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file added docs/en/concepts-and-designs/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 0 additions & 38 deletions docs/en/concepts-and-designs/module_design.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/en/concepts-and-designs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and upload them to the SkyWalking backend for analysis, aggregate, and visualize

## Architecture

![architecture.png](https://skywalking.apache.org/doc-graph/skywalking-rover/v0.1.0/architecture.png)
![architecture](architecture.png)

- **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.
Expand Down
49 changes: 0 additions & 49 deletions docs/en/concepts-and-designs/project_structue.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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 |
|-----------------------------------|-----------------|------------------------------------|-----------------------------------------------------------------------------------------------------|
Expand Down
9 changes: 0 additions & 9 deletions docs/en/setup/configuration/logger.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/en/setup/configuration/profiling.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
19 changes: 6 additions & 13 deletions docs/en/setup/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
30 changes: 10 additions & 20 deletions docs/menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c91e179

Please sign in to comment.