Skip to content

Commit dabe462

Browse files
authored
Polish docs (#121)
1 parent ee34f43 commit dabe462

File tree

2 files changed

+11
-28
lines changed

2 files changed

+11
-28
lines changed

docs/en/setup/overview.md

+9-24
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
The first and most important thing is, that SkyWalking Rover startup behaviors are driven by configs/rover_configs.yaml. Understanding the setting file will help you to read this document.
44

5+
Follow [Deploy on Kubernetes](deployment/kubernetes/readme.md) document to run rover in your cluster.
6+
57
## Requirements and default settings
68

79
Before you start, you should know that the main purpose of quickstart is to help you obtain a basic configuration for previews/demos.
810
Usually, the process to be monitored is first declared.
911

1012
Then, you can use `bin/startup.sh` to start up the rover with their [config](../../../configs/rover_configs.yaml).
1113

12-
### SkyWalking OAP
14+
### SkyWalking OAP Compatibility
1315

1416
The SkyWalking Rover requires specialized protocols to communicate with SkyWalking OAP.
1517

@@ -19,37 +21,20 @@ The SkyWalking Rover requires specialized protocols to communicate with SkyWalki
1921
| 0.1.0+ | \> = 9.1.0 | |
2022

2123

22-
## Startup script
23-
Startup Script
24-
```shell script
25-
bin/startup.sh
26-
```
27-
28-
## Examples
29-
30-
You can quickly build your Rover according to the following examples:
31-
32-
### Deploy
33-
34-
1. [Deploy on Kubernetes](deployment/kubernetes/readme.md)
35-
3624
## Configuration
3725

38-
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.
39-
40-
So, in rover_configs.yaml, there contains these parts.
41-
1. [Common](./configuration/common.md).
42-
2. [Service Discovery](configuration/service-discovery.md).
43-
3. [Traffic](./configuration/traffic.md).
44-
4. [Profiling](./configuration/profiling.md).
26+
1. [Common configurations](./configuration/common.md) about logs, backend address, cert files, etc.
27+
2. [Service Discovery](configuration/service-discovery.md) includes advanced setups about the ways of discovering services on your Kubernetes cluster.
28+
3. [Access logs](./configuration/traffic.md) reports L2 to L4 network traffic relative information through access logs, to help OAP backend to do topology and metrics analysis.
29+
4. [Profiling](./configuration/profiling.md) is an on-demand feature to enhance general observability besides access logs. It provides eBPF powered process ON_CPU, OFF_CPU profiling and network advanced profiling to link HTTP traffic with SkyWalking and Zipkin traces.
4530

46-
Also, You could use [Overriding Setting](./configuration/override-settings.md) feature to adjust the configurations.
31+
To adjust the configurations, refer to [Overriding Setting](./configuration/override-settings.md) document for more details.
4732

4833
## Prerequisites
4934

5035
Currently, Linux operating systems are supported from version `4.9` and above, except for network profiling which requires version `4.16` or higher.
5136

52-
The following table are currently support operating systems.
37+
The following table lists currently supported/tested operating systems.
5338

5439
| System | Kernel Version | On CPU Profiling | Off CPU Profiling | Network Profiling |
5540
|------------------|----------------|------------------|-------------------|--------------------------------|

docs/menu.yml

+2-4
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ catalog:
2727
catalog:
2828
- name: Overview
2929
path: /en/setup/overview
30+
- name: Deploy on Kubernetes
31+
path: /en/setup/deployment/kubernetes/readme
3032
- name: Configuration
3133
catalog:
3234
- name: Common
@@ -37,10 +39,6 @@ catalog:
3739
path: /en/setup/configuration/traffic
3840
- name: Profiling
3941
path: /en/setup/configuration/profiling
40-
- name: Deployment
41-
catalog:
42-
- name: Deploy on K8s
43-
path: /en/setup/deployment/kubernetes/readme
4442
- name: Guides
4543
catalog:
4644
- name: Contribution

0 commit comments

Comments
 (0)