From a74f6bdfbe797b28d2cf739b5cbe6517bc86763b Mon Sep 17 00:00:00 2001 From: Rajesh Rajendran Date: Mon, 17 Jan 2022 04:39:17 +0530 Subject: [PATCH] chore(helm): removing depricated docs --- scripts/README.md | 33 ----------------------------- scripts/helm/README.md | 47 ------------------------------------------ 2 files changed, 80 deletions(-) delete mode 100644 scripts/README.md delete mode 100644 scripts/helm/README.md diff --git a/scripts/README.md b/scripts/README.md deleted file mode 100644 index be8b97b11..000000000 --- a/scripts/README.md +++ /dev/null @@ -1,33 +0,0 @@ -### Installing OpenReplay on any VM (Debian based, preferably Ubuntu 20.04) - -You can start testing OpenReplay by installing it on any VM (at least `2 vCPUs, 8 GB of RAM and 50 GB of storage`). We'll initialize a single node kubernetes cluster with [k3s](https://k3s.io) and install OpenReplay on the cluster. - -```bash -cd helm && bash install.sh -``` - -### Installing OpenReplay on Kubernetes - -OpenReplay runs 100% on kubernetes. So if you've got a kubernetes cluster, preferably, a cluster dedicated to OpenReplay (on a single node of `4 vCPUs, 8 GB of RAM and 50 GB of storage`). You can run the script, which internally uses helm to install OpenReplay. - -We hope your cluster has provision to create a [service type](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) `LoadBalancer` for exposing OpenReplay on the internet. - -```bash -cd helm && bash kube-install.sh -``` - -### OpenReplay CLI - -The CLI is helpful for managing basic aspects of your OpenReplay instance, things such as restarting or reinstalling a service, accessing a component's logs or simply checking the status of your backend services. Below the list of covered operations: - - - status: status of the running services - - logs: logs of a specific service - - stop: stop one or all services - - start: start one or all services - - restart: restart one or all services - - For more information: - - ```bash - cd helm && openreplay-cli -h - ``` diff --git a/scripts/helm/README.md b/scripts/helm/README.md deleted file mode 100644 index 2ac1a3556..000000000 --- a/scripts/helm/README.md +++ /dev/null @@ -1,47 +0,0 @@ -## Helm charts for installing OpenReplay components - -Installation components are separated by namespaces. - -**Namespace:** - -- **app:** Core OpenReplay application related components. - - alerts - - utilities - - assets - - chalice - - ender - - sink - - storage - - http - - integrations - - db - -- **db:** Contains following databases and backend components. - - kafka (ee) - - redis - - postgresql - - clickhouse (ee) - - minio - - nfs-server - -- **longhorn:** Storage solution for kubernetes PVs. - -- **nginx-ingress:** Nginx ingress for internet traffic to enter the kubernetes cluster. - -**Scripts:** -- **install.sh** - - Installs OpenReplay in a single node machine. - - This script is a wrapper around the `install.sh` with [k3s](https://k3s.io/) as kubernetes distro. - - Note: As of now this script support only Ubuntu, as we've to install some packages to enable `NFS`. - -- **kube-install.sh:** - - Installs OpenReplay on any given kubernetes cluster. Has 3 configuration types: - - small (2cores 8G RAM) - - medium (4cores 16G RAM) - - recommended (8cores 32G RAM) - - For all options, `bash kube-install.sh -h`