You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2021/12/01 03:50:09 UTC
[GitHub] [skywalking-satellite] wu-sheng commented on a change in pull request #90: Add documentation for help user deploy the Satellite as Gateway
wu-sheng commented on a change in pull request #90:
URL: https://github.com/apache/skywalking-satellite/pull/90#discussion_r759830787
##########
File path: docs/en/setup/README.md
##########
@@ -19,10 +19,15 @@ bin/startup.sh
## Examples
You can quickly build your satellite according to the following examples:
-1. [Forward Agent Data to OAP Server](examples/forward-agent-data-to-oap-server/README.md)
-2. [Transmit Log to Kafka](examples/transmit-log-to-kafka/README.md)
-3. [GRPC Load Balance Client](examples/grpc-load-balance-client/README.md)
-3. [High Throughput Queue](examples/high-throughput-queue/README.md)
+### Deploy
+
+1. [VM Deploy](examples/deploy/vm/README.md)
Review comment:
```suggestion
1. [Deploy on Linux](examples/deploy/vm/README.md)
```
##########
File path: docs/en/setup/examples/deploy/kubernetes/README.md
##########
@@ -0,0 +1,28 @@
+# Kubernetes Deploy
Review comment:
Please revert the sequence as above suggested.
##########
File path: docs/en/setup/README.md
##########
@@ -19,10 +19,15 @@ bin/startup.sh
## Examples
You can quickly build your satellite according to the following examples:
-1. [Forward Agent Data to OAP Server](examples/forward-agent-data-to-oap-server/README.md)
-2. [Transmit Log to Kafka](examples/transmit-log-to-kafka/README.md)
-3. [GRPC Load Balance Client](examples/grpc-load-balance-client/README.md)
-3. [High Throughput Queue](examples/high-throughput-queue/README.md)
+### Deploy
+
+1. [VM Deploy](examples/deploy/vm/README.md)
+2. [Kubernetes Deploy](examples/deploy/kubernetes/README.md)
Review comment:
```suggestion
2. [Deploy on Kubernetes](examples/deploy/kubernetes/README.md)
```
##########
File path: docs/en/setup/examples/deploy/kubernetes/README.md
##########
@@ -0,0 +1,28 @@
+# Kubernetes Deploy
+
+It could help you run the Satellite as a gateway in Kubernetes environment.
+
+## Install
+
+We recommend install the Satellite by `helm`, follow command below, it could start the latest release version of SkyWalking Backend, UI and Satellite.
+
+```shell
+export SKYWALKING_RELEASE_NAME=skywalking # change the release name according to your scenario
+export SKYWALKING_RELEASE_NAMESPACE=default # change the namespace to where you want to install SkyWalking
+export REPO=skywalking
+
+helm repo add ${REPO} https://apache.jfrog.io/artifactory/skywalking-helm
+helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RELEASE_NAMESPACE}" \
+ --set oap.image.tag=8.8.1 \
+ --set oap.storageType=elasticsearch \
+ --set ui.image.tag=8.8.1 \
+ --set elasticsearch.imageTag=6.8.6 \
+ --set satellite.enabled=true \
+ --set satellite.image.tag=v0.3.0
Review comment:
Is 0.3.0 correct?
##########
File path: docs/en/setup/examples/deploy/vm/README.md
##########
@@ -1,14 +1,22 @@
-# GRPC Load Balance Client
+# VM Deploy
Review comment:
Indicate Linux or Windows, instead of VM, which is too general.
##########
File path: docs/en/setup/README.md
##########
@@ -19,10 +19,15 @@ bin/startup.sh
## Examples
You can quickly build your satellite according to the following examples:
-1. [Forward Agent Data to OAP Server](examples/forward-agent-data-to-oap-server/README.md)
-2. [Transmit Log to Kafka](examples/transmit-log-to-kafka/README.md)
-3. [GRPC Load Balance Client](examples/grpc-load-balance-client/README.md)
-3. [High Throughput Queue](examples/high-throughput-queue/README.md)
+### Deploy
+
+1. [VM Deploy](examples/deploy/vm/README.md)
+2. [Kubernetes Deploy](examples/deploy/kubernetes/README.md)
+
+### Feature
Review comment:
```suggestion
### More Use Cases
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org