You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2021/11/10 09:18:58 UTC

[skywalking-showcase] branch main updated: Polish doc

This is an automated email from the ASF dual-hosted git repository.

kezhenxu94 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git


The following commit(s) were added to refs/heads/main by this push:
     new 4f63023  Polish doc
4f63023 is described below

commit 4f630230899e92de446a4a1fae93f87672906991
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Wed Nov 10 17:18:50 2021 +0800

    Polish doc
---
 docs/readme.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/readme.md b/docs/readme.md
index b0d9fcb..b9726b7 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -18,6 +18,22 @@ graph LR;
 The showcase uses [GNU Make](https://www.gnu.org/software/make/) and Docker containers to run commands, so please make
 sure you have `make` installed and Docker daemon running.
 
+### Quick Start
+
+Make sure you have a running Kubernetes cluster and `kubectl` can access to that cluster.
+
+```shell
+git clone https://github.com/apache/skywalking-showcase.git
+cd skywalking-showcase
+make deploy.kubernetes FEATURE_FLAGS=cluster,agent,vm,so11y
+```
+
+This will install SkyWalking components, including OAP in cluster mode with 2 nodes, SkyWalking RocketBot UI,
+microservices with SkyWalking agent, 2 Pods to mimic virtual machines and export metrics to SkyWalking, and enable
+SkyWalking self observability metrics.
+
+For more advanced deployments, check [Customization](#customization) documentation below.
+
 ### Customization
 
 The variables defined in [`Makefile.in`](../Makefile.in) can be overridden to customize the showcase, by specifying an