commit	9e547e1126dc758f6e75c94e4a95454bf0f50a04	[log] [tgz]
author	kezhenxu94 <kezhenxu94@apache.org>	Fri Nov 25 18:36:23 2022 +0800
committer	GitHub <noreply@github.com>	Fri Nov 25 18:36:23 2022 +0800
tree	45d4b2ef7e9698cda5dd3d93d6be2333f77a0dfb
parent	c3d04cfb1eb78f70dd245b55190ea6467fcd9283 [diff]

tree: 45d4b2ef7e9698cda5dd3d93d6be2333f77a0dfb

README.md

Apache SkyWalking Kubernetes

SkyWalking Kubernetes repository provides ways to install and configure SkyWalking in a Kubernetes cluster. The scripts are written in Helm 3.

Chart Detailed Configuration

Chart detailed configuration can be found at Chart Readme

There are required values that you must set explicitly when deploying SkyWalking.

name	description	example
`oap.image.tag`	the OAP docker image tag	`9.2.0`
`oap.storageType`	the storage type of the OAP	`elasticsearch`, `postgresql`, etc.
`ui.image.tag`	the UI docker image tag	`9.2.0`

You can set these required values via command line (e.g. --set oap.image.tag=9.2.0 --set oap.storageType=elasticsearch), or edit them in a separate file(e.g. values.yaml, values-my-es.yaml) and use -f <filename> or --values=<filename> to set them.

Install

Let's set some variables for convenient use later.

export SKYWALKING_RELEASE_VERSION=4.3.0  # change the release version according to your need
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

Install released version using Docker Helm repository (>= 4.3.0)

helm install "${SKYWALKING_RELEASE_NAME}" \
  oci://registry-1.docker.io/apache/skywalking-helm \
  --version "${SKYWALKING_RELEASE_VERSION}" \
  -n "${SKYWALKING_RELEASE_NAMESPACE}" \
  --set oap.image.tag=9.2.0 \
  --set oap.storageType=elasticsearch \
  --set ui.image.tag=9.2.0

Install released version using Apache Jfrog Helm repository (<= 4.3.0)

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=9.2.0 \
  --set oap.storageType=elasticsearch \
  --set ui.image.tag=9.2.0

Install development version using ghcr.io Helm repository

If you are willing to help testing the latest codes that are not released yet, we provided a snapshot Helm repository on ghcr.io for convenient use, replace the full commit hash in the version option to deploy the revision that you want to test.

helm -n istio-system install skywalking \
  oci://ghcr.io/apache/skywalking-kubernetes/skywalking-helm \
  --version "0.0.0-b670c41d94a82ddefcf466d54bab5c492d88d772" \
  -n "${SKYWALKING_RELEASE_NAMESPACE}" \
  --set oap.image.tag=9.2.0 \
  --set oap.storageType=elasticsearch \
  --set ui.image.tag=9.2.0

Install development version using source codes

This is needed only when you want to install source codes.

export REPO=chart
git clone https://github.com/apache/skywalking-kubernetes
cd skywalking-kubernetes
helm repo add elastic https://helm.elastic.co
helm dep up ${REPO}/skywalking

Install a specific version of SkyWalking with an existing Elasticsearch

Modify the connection information to the existing elasticsearch cluster in file values-my-es.yaml.

helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RELEASE_NAMESPACE}" \
  -f ./skywalking/values-my-es.yaml

Install SkyWalking with Satellite

Enable the satellite as gateway, and set the satellite image tag.

helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RELEASE_NAMESPACE}" \
  --set satellite.enabled=true \
  --set satellite.image.tag=v0.4.0

After satellite have been installed, you should replace the oap address to the satellite address, the address from agent or istio, such as skywalking-satellite.istio-system:11800.

Customization

Use your own configuration files

Put your own configuration files according to the overridable files under the working directory, files/conf.d, they will override the counterparts in the Docker image.

Pass environment variables to OAP

The SkyWalking OAP exposes many configurations that can be specified by environment variables, as listed in the main repo. You can set those environment variables by --set oap.env.<ENV_NAME>=<ENV_VALUE>, such as --set oap.env.SW_ENVOY_METRIC_ALS_HTTP_ANALYSIS=k8s-mesh.

The environment variables take priority over the overrode configuration files.

Contact Us

Submit an issue
Mail list: dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, follow the reply to subscribe the mail list.
Join skywalking channel at Apache Slack. If the link is not working, find the latest one at Apache INFRA WIKI.
QQ Group: 392443393(2000/2000, not available), 901167865(available)

LICENSE

Apache 2.0