diff --git a/README.md b/README.md index 3de54c89bcaecebb7d4a9864826a609d86cc033a..d3bcc17ac6acafa9da8946e66c2d77388dd2320e 100644 --- a/README.md +++ b/README.md @@ -5,36 +5,18 @@ Apache SkyWalking Kubernetes To install and configure skywalking in a Kubernetes cluster, follow these instructions. -## Prerequisites +## Structure of repository -Please promise the `skywalking` namespace existed in the cluster, otherwise, create a new one. +### archive -`kubectl apply -f namespace.yml` +Prior to 6.0.0-GA, only kubernetes YAMLs as examples for users and should be modified to fix real kuberentes enviroment, +for instance, resources, volume claims. -## Deploy Elasticsearch +Now, these YAMLs are archived in the repository, that means we never maintain them, but users still could use them. -Use `kubectl apply -f ` with the scripts in `elasticsearch` to deploy elasticsearch servers -in the cluster. +We recommend using __helm-chart__ as your first choice. -> `01-storageclass.yml` assume to use GKE as the kubernetes provisioner. You could fix it according -to your kubernetes environment. +### helm-chart -## Deploy OAP server - -Use `kubectl apply -f ` with the scripts in `oap` to deploy oap server -in the cluster. - -## Deploy UI server - -Use `kubectl apply -f ` with the scripts in `ui` to deploy oap server -in the cluster. - -# Setup Istio to send metric to oap - -## Prerequisites - -Istio should be installed in kubernetes cluster. - -## Setup Istio to send metric to oap - -Use `kubectl apply -f ` with the scripts in `istio` to setup. +This is recommended as the best practice to deploy SkyWalking backend stack into kubernetes cluster. You can pick a + sub folder base on version your desired version. diff --git a/6/6.0.0-GA/elasticsearch/01-storageclass.yml b/archive/6/6.0.0-GA/elasticsearch/01-storageclass.yml similarity index 100% rename from 6/6.0.0-GA/elasticsearch/01-storageclass.yml rename to archive/6/6.0.0-GA/elasticsearch/01-storageclass.yml diff --git a/6/6.0.0-GA/elasticsearch/02-service.yml b/archive/6/6.0.0-GA/elasticsearch/02-service.yml similarity index 100% rename from 6/6.0.0-GA/elasticsearch/02-service.yml rename to archive/6/6.0.0-GA/elasticsearch/02-service.yml diff --git a/6/6.0.0-GA/elasticsearch/03-statefulset.yml b/archive/6/6.0.0-GA/elasticsearch/03-statefulset.yml similarity index 100% rename from 6/6.0.0-GA/elasticsearch/03-statefulset.yml rename to archive/6/6.0.0-GA/elasticsearch/03-statefulset.yml diff --git a/6/6.0.0-GA/istio/01-metrictemplate.yml b/archive/6/6.0.0-GA/istio/01-metrictemplate.yml similarity index 100% rename from 6/6.0.0-GA/istio/01-metrictemplate.yml rename to archive/6/6.0.0-GA/istio/01-metrictemplate.yml diff --git a/6/6.0.0-GA/istio/02-skywalingadapter.yml b/archive/6/6.0.0-GA/istio/02-skywalingadapter.yml similarity index 100% rename from 6/6.0.0-GA/istio/02-skywalingadapter.yml rename to archive/6/6.0.0-GA/istio/02-skywalingadapter.yml diff --git a/6/6.0.0-GA/istio/03-operator_cfg.yml b/archive/6/6.0.0-GA/istio/03-operator_cfg.yml similarity index 100% rename from 6/6.0.0-GA/istio/03-operator_cfg.yml rename to archive/6/6.0.0-GA/istio/03-operator_cfg.yml diff --git a/6/6.0.0-GA/istio/README.md b/archive/6/6.0.0-GA/istio/README.md similarity index 100% rename from 6/6.0.0-GA/istio/README.md rename to archive/6/6.0.0-GA/istio/README.md diff --git a/6/6.0.0-GA/namespace.yml b/archive/6/6.0.0-GA/namespace.yml similarity index 100% rename from 6/6.0.0-GA/namespace.yml rename to archive/6/6.0.0-GA/namespace.yml diff --git a/6/6.0.0-GA/oap/00-rbac.yml b/archive/6/6.0.0-GA/oap/00-rbac.yml similarity index 100% rename from 6/6.0.0-GA/oap/00-rbac.yml rename to archive/6/6.0.0-GA/oap/00-rbac.yml diff --git a/6/6.0.0-GA/oap/01-config.yml b/archive/6/6.0.0-GA/oap/01-config.yml similarity index 100% rename from 6/6.0.0-GA/oap/01-config.yml rename to archive/6/6.0.0-GA/oap/01-config.yml diff --git a/6/6.0.0-GA/oap/02-service.yml b/archive/6/6.0.0-GA/oap/02-service.yml similarity index 100% rename from 6/6.0.0-GA/oap/02-service.yml rename to archive/6/6.0.0-GA/oap/02-service.yml diff --git a/6/6.0.0-GA/oap/03-deployment.yml b/archive/6/6.0.0-GA/oap/03-deployment.yml similarity index 100% rename from 6/6.0.0-GA/oap/03-deployment.yml rename to archive/6/6.0.0-GA/oap/03-deployment.yml diff --git a/6/6.0.0-GA/ui/01-service.yml b/archive/6/6.0.0-GA/ui/01-service.yml similarity index 100% rename from 6/6.0.0-GA/ui/01-service.yml rename to archive/6/6.0.0-GA/ui/01-service.yml diff --git a/6/6.0.0-GA/ui/02-deployment.yml b/archive/6/6.0.0-GA/ui/02-deployment.yml similarity index 100% rename from 6/6.0.0-GA/ui/02-deployment.yml rename to archive/6/6.0.0-GA/ui/02-deployment.yml diff --git a/6/6.0.0-alpha/elasticsearch/01-storageclass.yml b/archive/6/6.0.0-alpha/elasticsearch/01-storageclass.yml similarity index 100% rename from 6/6.0.0-alpha/elasticsearch/01-storageclass.yml rename to archive/6/6.0.0-alpha/elasticsearch/01-storageclass.yml diff --git a/6/6.0.0-alpha/elasticsearch/02-service.yml b/archive/6/6.0.0-alpha/elasticsearch/02-service.yml similarity index 100% rename from 6/6.0.0-alpha/elasticsearch/02-service.yml rename to archive/6/6.0.0-alpha/elasticsearch/02-service.yml diff --git a/6/6.0.0-alpha/elasticsearch/03-statefulset.yml b/archive/6/6.0.0-alpha/elasticsearch/03-statefulset.yml similarity index 100% rename from 6/6.0.0-alpha/elasticsearch/03-statefulset.yml rename to archive/6/6.0.0-alpha/elasticsearch/03-statefulset.yml diff --git a/6/6.0.0-alpha/istio/01-metrictemplate.yml b/archive/6/6.0.0-alpha/istio/01-metrictemplate.yml similarity index 100% rename from 6/6.0.0-alpha/istio/01-metrictemplate.yml rename to archive/6/6.0.0-alpha/istio/01-metrictemplate.yml diff --git a/6/6.0.0-alpha/istio/02-skywalingadapter.yml b/archive/6/6.0.0-alpha/istio/02-skywalingadapter.yml similarity index 100% rename from 6/6.0.0-alpha/istio/02-skywalingadapter.yml rename to archive/6/6.0.0-alpha/istio/02-skywalingadapter.yml diff --git a/6/6.0.0-alpha/istio/03-operator_cfg.yml b/archive/6/6.0.0-alpha/istio/03-operator_cfg.yml similarity index 100% rename from 6/6.0.0-alpha/istio/03-operator_cfg.yml rename to archive/6/6.0.0-alpha/istio/03-operator_cfg.yml diff --git a/6/6.0.0-alpha/namespace.yml b/archive/6/6.0.0-alpha/namespace.yml similarity index 100% rename from 6/6.0.0-alpha/namespace.yml rename to archive/6/6.0.0-alpha/namespace.yml diff --git a/6/6.0.0-alpha/oap/00-rbac.yml b/archive/6/6.0.0-alpha/oap/00-rbac.yml similarity index 100% rename from 6/6.0.0-alpha/oap/00-rbac.yml rename to archive/6/6.0.0-alpha/oap/00-rbac.yml diff --git a/6/6.0.0-alpha/oap/01-config.yml b/archive/6/6.0.0-alpha/oap/01-config.yml similarity index 100% rename from 6/6.0.0-alpha/oap/01-config.yml rename to archive/6/6.0.0-alpha/oap/01-config.yml diff --git a/6/6.0.0-alpha/oap/02-service.yml b/archive/6/6.0.0-alpha/oap/02-service.yml similarity index 100% rename from 6/6.0.0-alpha/oap/02-service.yml rename to archive/6/6.0.0-alpha/oap/02-service.yml diff --git a/6/6.0.0-alpha/oap/03-deployment.yml b/archive/6/6.0.0-alpha/oap/03-deployment.yml similarity index 100% rename from 6/6.0.0-alpha/oap/03-deployment.yml rename to archive/6/6.0.0-alpha/oap/03-deployment.yml diff --git a/6/6.0.0-alpha/ui/01-service.yml b/archive/6/6.0.0-alpha/ui/01-service.yml similarity index 100% rename from 6/6.0.0-alpha/ui/01-service.yml rename to archive/6/6.0.0-alpha/ui/01-service.yml diff --git a/6/6.0.0-alpha/ui/02-deployment.yml b/archive/6/6.0.0-alpha/ui/02-deployment.yml similarity index 100% rename from 6/6.0.0-alpha/ui/02-deployment.yml rename to archive/6/6.0.0-alpha/ui/02-deployment.yml diff --git a/6/6.0.0-beta/elasticsearch/01-storageclass.yml b/archive/6/6.0.0-beta/elasticsearch/01-storageclass.yml similarity index 100% rename from 6/6.0.0-beta/elasticsearch/01-storageclass.yml rename to archive/6/6.0.0-beta/elasticsearch/01-storageclass.yml diff --git a/6/6.0.0-beta/elasticsearch/02-service.yml b/archive/6/6.0.0-beta/elasticsearch/02-service.yml similarity index 100% rename from 6/6.0.0-beta/elasticsearch/02-service.yml rename to archive/6/6.0.0-beta/elasticsearch/02-service.yml diff --git a/6/6.0.0-beta/elasticsearch/03-statefulset.yml b/archive/6/6.0.0-beta/elasticsearch/03-statefulset.yml similarity index 100% rename from 6/6.0.0-beta/elasticsearch/03-statefulset.yml rename to archive/6/6.0.0-beta/elasticsearch/03-statefulset.yml diff --git a/6/6.0.0-beta/istio/01-metrictemplate.yml b/archive/6/6.0.0-beta/istio/01-metrictemplate.yml similarity index 100% rename from 6/6.0.0-beta/istio/01-metrictemplate.yml rename to archive/6/6.0.0-beta/istio/01-metrictemplate.yml diff --git a/6/6.0.0-beta/istio/02-skywalingadapter.yml b/archive/6/6.0.0-beta/istio/02-skywalingadapter.yml similarity index 100% rename from 6/6.0.0-beta/istio/02-skywalingadapter.yml rename to archive/6/6.0.0-beta/istio/02-skywalingadapter.yml diff --git a/6/6.0.0-beta/istio/03-operator_cfg.yml b/archive/6/6.0.0-beta/istio/03-operator_cfg.yml similarity index 100% rename from 6/6.0.0-beta/istio/03-operator_cfg.yml rename to archive/6/6.0.0-beta/istio/03-operator_cfg.yml diff --git a/6/6.0.0-beta/namespace.yml b/archive/6/6.0.0-beta/namespace.yml similarity index 100% rename from 6/6.0.0-beta/namespace.yml rename to archive/6/6.0.0-beta/namespace.yml diff --git a/6/6.0.0-beta/oap/00-rbac.yml b/archive/6/6.0.0-beta/oap/00-rbac.yml similarity index 100% rename from 6/6.0.0-beta/oap/00-rbac.yml rename to archive/6/6.0.0-beta/oap/00-rbac.yml diff --git a/6/6.0.0-beta/oap/01-config.yml b/archive/6/6.0.0-beta/oap/01-config.yml similarity index 100% rename from 6/6.0.0-beta/oap/01-config.yml rename to archive/6/6.0.0-beta/oap/01-config.yml diff --git a/6/6.0.0-beta/oap/02-service.yml b/archive/6/6.0.0-beta/oap/02-service.yml similarity index 100% rename from 6/6.0.0-beta/oap/02-service.yml rename to archive/6/6.0.0-beta/oap/02-service.yml diff --git a/6/6.0.0-beta/oap/03-deployment.yml b/archive/6/6.0.0-beta/oap/03-deployment.yml similarity index 100% rename from 6/6.0.0-beta/oap/03-deployment.yml rename to archive/6/6.0.0-beta/oap/03-deployment.yml diff --git a/6/6.0.0-beta/ui/01-service.yml b/archive/6/6.0.0-beta/ui/01-service.yml similarity index 100% rename from 6/6.0.0-beta/ui/01-service.yml rename to archive/6/6.0.0-beta/ui/01-service.yml diff --git a/6/6.0.0-beta/ui/02-deployment.yml b/archive/6/6.0.0-beta/ui/02-deployment.yml similarity index 100% rename from 6/6.0.0-beta/ui/02-deployment.yml rename to archive/6/6.0.0-beta/ui/02-deployment.yml diff --git a/archive/README.md b/archive/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3de54c89bcaecebb7d4a9864826a609d86cc033a --- /dev/null +++ b/archive/README.md @@ -0,0 +1,40 @@ +Apache SkyWalking Kubernetes +========== + +# Deploy SkyWalking backend to Kubernetes cluster + +To install and configure skywalking in a Kubernetes cluster, follow these instructions. + +## Prerequisites + +Please promise the `skywalking` namespace existed in the cluster, otherwise, create a new one. + +`kubectl apply -f namespace.yml` + +## Deploy Elasticsearch + +Use `kubectl apply -f ` with the scripts in `elasticsearch` to deploy elasticsearch servers +in the cluster. + +> `01-storageclass.yml` assume to use GKE as the kubernetes provisioner. You could fix it according +to your kubernetes environment. + +## Deploy OAP server + +Use `kubectl apply -f ` with the scripts in `oap` to deploy oap server +in the cluster. + +## Deploy UI server + +Use `kubectl apply -f ` with the scripts in `ui` to deploy oap server +in the cluster. + +# Setup Istio to send metric to oap + +## Prerequisites + +Istio should be installed in kubernetes cluster. + +## Setup Istio to send metric to oap + +Use `kubectl apply -f ` with the scripts in `istio` to setup.