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/14 07:23:43 UTC
[skywalking-showcase] branch d/prerequisites created (now e045aff)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a change to branch d/prerequisites
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git.
at e045aff Enable all features by default and add prerequisites in doc
This branch includes the following new commits:
new e045aff Enable all features by default and add prerequisites in doc
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[skywalking-showcase] 01/01: Enable all features by default and add prerequisites in doc
Posted by ke...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch d/prerequisites
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git
commit e045aff84cfb155073fda93610be5ccc2d22763b
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Sun Nov 14 15:23:28 2021 +0800
Enable all features by default and add prerequisites in doc
---
Makefile.in | 2 --
deploy/platform/docker/Makefile | 1 +
deploy/platform/{kubernetes => docker}/Makefile.in | 4 +---
deploy/platform/kubernetes/Makefile.in | 2 ++
docs/readme.md | 9 ++++++++-
5 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/Makefile.in b/Makefile.in
index 4aafddf..4eb6db3 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -34,5 +34,3 @@ SW_AGENT_NODEJS_FRONTEND_VERSION ?= af0565a67d382b683c1dbd94c379b7080db61449
# ALL variables should be listed above ^^
EXPORTED_VARS := $(filter-out <%,$(.VARIABLES))
-
-FEATURE_FLAGS ?= single-node,agent,so11y,vm
diff --git a/deploy/platform/docker/Makefile b/deploy/platform/docker/Makefile
index 63cce31..f1197f3 100644
--- a/deploy/platform/docker/Makefile
+++ b/deploy/platform/docker/Makefile
@@ -17,6 +17,7 @@
#
include ../../../Makefile.in
+include Makefile.in
features := $(subst $(comma), ,$(FEATURE_FLAGS))
features := $(foreach f,$(features),-f docker-compose.$(f).yaml)
diff --git a/deploy/platform/kubernetes/Makefile.in b/deploy/platform/docker/Makefile.in
similarity index 95%
copy from deploy/platform/kubernetes/Makefile.in
copy to deploy/platform/docker/Makefile.in
index c88cd28..2c80d2b 100644
--- a/deploy/platform/kubernetes/Makefile.in
+++ b/deploy/platform/docker/Makefile.in
@@ -17,6 +17,4 @@
#
.EXPORT_ALL_VARIABLES:
-
-NAMESPACE ?= default
-AGENTLESS ?= false
+FEATURE_FLAGS ?= agent,cluster,so11y,vm
diff --git a/deploy/platform/kubernetes/Makefile.in b/deploy/platform/kubernetes/Makefile.in
index c88cd28..3e955ba 100644
--- a/deploy/platform/kubernetes/Makefile.in
+++ b/deploy/platform/kubernetes/Makefile.in
@@ -20,3 +20,5 @@
NAMESPACE ?= default
AGENTLESS ?= false
+
+FEATURE_FLAGS ?= agent,cluster,kubernetes-monitor,so11y,vm,als
diff --git a/docs/readme.md b/docs/readme.md
index 567cd7f..a5563b7 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -18,6 +18,13 @@ 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.
+### Prerequisites
+
+To deploy the full features of this showcase application, you may need up to 4 CPU cores and 4 GB memory, please
+increase the Docker daemon resources or Kubernetes cluster resources if you find containers / Pods failed to start up.
+Alternatively, you can also only deploy part of the features that interest you if you don't want to increase the
+resources, via the guide in [Customization](#customization).
+
### Quick Start
Make sure you have a running Kubernetes cluster and `kubectl` can access to that cluster.
@@ -70,7 +77,7 @@ Currently, the features supported are:
| `single-node` | Deploy only one single node of SkyWalking OAP, and SkyWalking RocketBot UI, ElasticSearch as storage. | Only one of `cluster` or `single-node` can be enabled. |
| `so11y` | Enable SkyWalking self observability. | This is enabled by default for platform [Docker Compose](#docker-compose). |
| `vm` | Start 2 virtual machines and export their metrics to SkyWalking. | The "virtual machines" are mimicked by Docker containers or Pods. |
-| `als` | Start microservices **WITHOUT** SkyWalking agent enabled, and configure SkyWalking to analyze the topology and metrics from their access logs. | Command `istioctl` is required to run this feature. The agentless microservices will be running at namespace `${NAMESPACE}-agentless` |
+| `als` | Start microservices WITHOUT SkyWalking agent enabled, and configure SkyWalking to analyze the topology and metrics from their access logs. | Command `istioctl` is required to run this feature. The agentless microservices will be running at namespace `${NAMESPACE}-agentless` |
| `kubernetes-monitor` | Deploy OpenTelemetry and export Kubernetes monitoring metrics to SkyWalking for analysis and display on UI. | |
### Kubernetes