You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/setup/overview.md
+9-24
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,16 @@
2
2
3
3
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.
4
4
5
+
Follow [Deploy on Kubernetes](deployment/kubernetes/readme.md) document to run rover in your cluster.
6
+
5
7
## Requirements and default settings
6
8
7
9
Before you start, you should know that the main purpose of quickstart is to help you obtain a basic configuration for previews/demos.
8
10
Usually, the process to be monitored is first declared.
9
11
10
12
Then, you can use `bin/startup.sh` to start up the rover with their [config](../../../configs/rover_configs.yaml).
11
13
12
-
### SkyWalking OAP
14
+
### SkyWalking OAP Compatibility
13
15
14
16
The SkyWalking Rover requires specialized protocols to communicate with SkyWalking OAP.
15
17
@@ -19,37 +21,20 @@ The SkyWalking Rover requires specialized protocols to communicate with SkyWalki
19
21
| 0.1.0+ |\> = 9.1.0 ||
20
22
21
23
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
-
36
24
## Configuration
37
25
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.
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.
45
30
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.
47
32
48
33
## Prerequisites
49
34
50
35
Currently, Linux operating systems are supported from version `4.9` and above, except for network profiling which requires version `4.16` or higher.
51
36
52
-
The following table are currently support operating systems.
37
+
The following table lists currently supported/tested operating systems.
53
38
54
39
| System | Kernel Version | On CPU Profiling | Off CPU Profiling | Network Profiling |
0 commit comments