diff --git a/CHANGES.md b/CHANGES.md index a8345175d6caff0666765d97ac25df3a870e7f00..f0f50994084706d4adf8528e6e942f7bc45ceada 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -90,6 +90,7 @@ Release Notes. 1. Remove general receiver and fetcher docs 2. Add more specific menu with docs to help users to find documents easier. * Add a guidance doc about the logic endpoint. +* Link Satellite as Load Balancer documentation and compatibility with satellite. All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/101?closed=1) diff --git a/docker/README.md b/docker/README.md index 640dec43c9838d5d2434dda1198189803cf50093..2632d2a5c69906fb6804884a8f8bee9f4a73b769 100644 --- a/docker/README.md +++ b/docker/README.md @@ -3,7 +3,7 @@ This folder contains Dockerfiles that are used to **build** our [OAP Docker images](https://hub.docker.com/r/apache/skywalking-oap-server) and [UI Docker image](https://hub.docker.com/r/apache/skywalking-ui). If you want to use the Docker images, please -check [the user guide for OAP](../docs/en/setup/backend/docker.md) +check [the user guide for OAP](../docs/en/setup/backend/backend-docker.md) and [the user guide for UI](../docs/en/setup/backend/ui-setup.md#start-with-docker-image). ## Quickstart diff --git a/docs/en/setup/backend/docker.md b/docs/en/setup/backend/backend-docker.md similarity index 100% rename from docs/en/setup/backend/docker.md rename to docs/en/setup/backend/backend-docker.md diff --git a/docs/en/setup/backend/backend-load-balancer.md b/docs/en/setup/backend/backend-load-balancer.md new file mode 100644 index 0000000000000000000000000000000000000000..8958b8e8234f3b722add1086669305eb71c4d5c5 --- /dev/null +++ b/docs/en/setup/backend/backend-load-balancer.md @@ -0,0 +1,7 @@ +# Backend Load Balancer + +When set the Agent or Envoy connecting to OAP server directly as in default, OAP server cluster would face the problem of OAP load imbalance. This issue would be very serious in high traffic load scenarios. +Satellite is recommended to be used as a native gateway proxy, to provide load balancing capabilities for data content before the data from Agent/Envoy reaches the OAP. The major difference between Satellite and other general wide used proxy(s), like Envoy, is that, Satellite would routine the data accordingly to contents rather than connection, as gRPC streaming is used widely in SkyWalking. + +Follow instructions in the [Setup SkyWalking Satellite](https://skywalking.apache.org/docs/#SkyWalkingSatellite) +to deploy Satellite and connect your application to the satellite. \ No newline at end of file diff --git a/docs/en/setup/service-agent/agent-compatibility.md b/docs/en/setup/service-agent/agent-compatibility.md index 89284d6a1d902652fb097906181541f65ff80233..b0b72f156b56932d91c5afa7f4058addd9937b64 100644 --- a/docs/en/setup/service-agent/agent-compatibility.md +++ b/docs/en/setup/service-agent/agent-compatibility.md @@ -4,11 +4,12 @@ SkyWalking 8.0+ uses v3 protocols. Agents don't have to keep the same versions a ## SkyWalking Native Agents -|OAP Server Version|Java|Python|NodeJS|LUA|Kong|Browser Agent| ------------ | ---------- | --------- | --------- |--------- |--------- |--------- | -8.0.1 - 8.1.0 | 8.0.0 - 8.3.0 | < = 0.6.0| < = 0.3.0 | All | All | No | -8.2.0 - 8.3.0 | 8.0.0 - 8.3.0 | < = 0.6.0| < = 0.3.0 | All | All | All | -8.4.0+ | \> = 8.0.0 | All | All | All | All | All | +|OAP Server Version|Java|Python|NodeJS|LUA|Kong|Browser Agent|Satellite| +----------- | ---------- | --------- | --------- |--------- |--------- |--------- |----- | +8.0.1 - 8.1.0 | 8.0.0 - 8.3.0 | < = 0.6.0| < = 0.3.0 | All | All | No | No | +8.2.0 - 8.3.0 | 8.0.0 - 8.3.0 | < = 0.6.0| < = 0.3.0 | All | All | All | No | +8.4.0 - 8.8.1 | \> = 8.0.0 | All | All | All | All | All | No | +8.9.0+ | \> = 8.0.0 | All | All | All | All | All | \> = 0.4.0 | ## Ecosystem Agents diff --git a/docs/menu.yml b/docs/menu.yml index 69528676626733d8846934e77ae1b1e442da5e70..7873289d395d12cd5f55fbf0d9964f385c7fd27a 100644 --- a/docs/menu.yml +++ b/docs/menu.yml @@ -66,9 +66,13 @@ catalog: - name: "Backend" catalog: - name: "Quick Start" - path: "/en/setup/backend/backend-setup" - - name: "Quick Start with Docker" - path: "/en/setup/backend/docker" + catalog: + - name: "Introduction" + path: "/en/setup/backend/backend-setup" + - name: "Run with Docker" + path: "/en/setup/backend/backend-docker" + - name: "Run with Kubernetes" + path: "/en/setup/backend/backend-k8s" - name: "Configuration Vocabulary" path: "/en/setup/backend/configuration-vocabulary" - name: "Advanced Setup" @@ -99,8 +103,8 @@ catalog: path: "/en/setup/backend/dynamical-logging" - name: "Security(SSL/TLS/mTLS)" path: "/en/setup/backend/grpc-security" - - name: "Deploy In Kubernetes" - path: "/en/setup/backend/backend-k8s" + - name: "Setup Native Load Balancer" + path: "/en/setup/backend/backend-load-balancer" - name: "Tracing" catalog: - name: "Trace Sampling"