Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish docs #121

Merged
merged 2 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 9 additions & 24 deletions docs/en/setup/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

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.

Follow [Deploy on Kubernetes](deployment/kubernetes/readme.md) document to run rover in your cluster.

## Requirements and default settings

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

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

### SkyWalking OAP
### SkyWalking OAP Compatibility

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

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


## Startup script
Startup Script
```shell script
bin/startup.sh
```

## Examples

You can quickly build your Rover according to the following examples:

### Deploy

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. [Common](./configuration/common.md).
2. [Service Discovery](configuration/service-discovery.md).
3. [Traffic](./configuration/traffic.md).
4. [Profiling](./configuration/profiling.md).
1. [Common configurations](./configuration/common.md) about logs, backend address, cert files, etc.
2. [Service Discovery](configuration/service-discovery.md) includes advanced setups about the ways of discovering services on your Kubernetes cluster.
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.
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.

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

## Prerequisites

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

The following table are currently support operating systems.
The following table lists currently supported/tested operating systems.

| System | Kernel Version | On CPU Profiling | Off CPU Profiling | Network Profiling |
|------------------|----------------|------------------|-------------------|--------------------------------|
Expand Down
6 changes: 2 additions & 4 deletions docs/menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ catalog:
catalog:
- name: Overview
path: /en/setup/overview
- name: Deploy on Kubernetes
path: /en/setup/deployment/kubernetes/readme
- name: Configuration
catalog:
- name: Common
Expand All @@ -37,10 +39,6 @@ catalog:
path: /en/setup/configuration/traffic
- name: Profiling
path: /en/setup/configuration/profiling
- name: Deployment
catalog:
- name: Deploy on K8s
path: /en/setup/deployment/kubernetes/readme
- name: Guides
catalog:
- name: Contribution
Expand Down
Loading