diff --git a/scripts/README.md b/scripts/README.md index 1c0d831c8..5c3d75a2b 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,35 +1,34 @@ -### Installing Asayer on any VM(Debian based, preferably Ubuntu 20.04) +### Installing OpenReplay on any VM (Debian based, preferably Ubuntu 20.04) -You can start testing Asayer by installing it on any VM ( ideally, 4core 16G ) machine. -We'll initialize a single node kubernetes cluster with [k3s](https://k3s.io) and install Asayer on the cluster. - -```bash -cd helm && bash minimal-install.sh -``` - -### Installing Asayer on kubernetes cluster - -Asayer runs 100% on kubernetes. So if you've got a kubernetes cluster, preferably, a cluster dedicated to asayer(even a single node 4core 16G node), -You can run the script, which internally uses helm to install Asayer. - -We hope your cluster has provision to create a [service type](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) `LoadBalancer` for exposing Asayer on internet. +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 ``` -### Management of Asayer apps +### Installing OpenReplay on Kubernetes -- **asayer-cli:** +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. - This script will help to manage asayer applications. Basic opeations covered are +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 +``` + +### Management of OpenReplay apps + +- **openreplay-cli:** + + This script will help to manage OpenReplay applications. Basic operations covered are - status: status of the applications - - logs: logs of a specific application. - - stop: stop one or all services. - - start: start one or all services. - - restart: restart one or all services. - - For more information, + - logs: logs of a specific application + - stop: stop one or all services + - start: start one or all services + - restart: restart one or all services + + For more information: + ```bash - cd helm && asayer-cli -h + cd helm && openreplay-cli -h ```