diff --git a/k8s/README.md b/k8s/README.md index 24520dd68c..5e563039aa 100644 --- a/k8s/README.md +++ b/k8s/README.md @@ -4,15 +4,15 @@ This folder containing scripts and Kubernetes resources configurations to run Th ## Prerequisites -ThingsBoard Microservices are running on Kubernetes cluster. +ThingsBoard Microservices run on the Kubernetes cluster. You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. -If you do not already have a cluster, you can create one by using [Minikube](https://kubernetes.io/docs/setup/minikube), +If you do not have a cluster already, you can create one by using [Minikube](https://kubernetes.io/docs/setup/minikube), or you can choose any other available [Kubernetes cluster deployment solutions](https://kubernetes.io/docs/setup/pick-right-solution/). ### Enable ingress addon -By default ingress addon is disable in the Minikube, and available only in cluster providers. -To enable ingress, please execute next command: +By default ingress addon is disabled in the Minikube, and available only in cluster providers. +To enable ingress, please execute the following command: ` $ minikube addons enable ingress @@ -21,21 +21,21 @@ $ minikube addons enable ingress ## Installation Before performing initial installation you can configure the type of database to be used with ThingsBoard and the type of deployment. -In order to set database type change the value of `DATABASE` variable in `.env` file to one of the following: +To set database type change the value of `DATABASE` variable in `.env` file to one of the following: - `postgres` - use PostgreSQL database; - `cassandra` - use Cassandra database; **NOTE**: According to the database type corresponding kubernetes resources will be deployed (see `postgres.yml`, `cassandra.yml` for details). -In order to set deployment type change the value of `DEPLOYMENT_TYPE` variable in `.env` file to one of the following: +To set deployment type change the value of `DEPLOYMENT_TYPE` variable in `.env` file to one of the following: -- `basic` - start up with single instance of Zookeeper, Kafka and Redis; -- `high-availability` - start up with Zookeeper, Kafka and Redis in cluster modes; +- `basic` - startup with a single instance of Zookeeper, Kafka and Redis; +- `high-availability` - startup with Zookeeper, Kafka, and Redis in cluster modes; -**NOTE**: According to the deployment type corresponding kubernetes resources will be deployed (see content of the directories `./basic` and `./high-availability` for details). +**NOTE**: According to the deployment type corresponding kubernetes resources will be deployed (see the content of the directories `./basic` and `./high-availability` for details). -Execute the following command to run installation: +Execute the following command to run the installation: ` $ ./k8s-install-tb.sh --loadDemo @@ -47,7 +47,7 @@ Where: ## Running -Execute the following command to deploy thirdparty resources: +Execute the following command to deploy third-party resources: ` $ ./k8s-deploy-thirdparty.sh @@ -61,8 +61,8 @@ Execute the following command to deploy resources: $ ./k8s-deploy-resources.sh ` -After a while when all resources will be successfully started you can open `http://{your-cluster-ip}` in you browser (for ex. `http://192.168.99.101`). -You should see ThingsBoard login page. +After a while when all resources will be successfully started you can open `http://{your-cluster-ip}` in your browser (for ex. `http://192.168.99.101`). +You should see the ThingsBoard login page. Use the following default credentials: @@ -73,16 +73,16 @@ If you installed DataBase with demo data (using `--loadDemo` flag) you can also - **Tenant Administrator**: tenant@thingsboard.org / tenant - **Customer User**: customer@thingsboard.org / customer -In case of any issues you can examine service logs for errors. +In case of any issues, you can examine service logs for errors. For example to see ThingsBoard node logs execute the following commands: -1) Get list of the running tb-node pods: +1) Get the list of the running tb-node pods: ` $ kubectl get pods -l app=tb-node ` -2) Fetch logs of tb-node pod: +2) Fetch logs of the tb-node pod: ` $ kubectl logs -f [tb-node-pod-name] @@ -103,7 +103,7 @@ Execute the following command to delete all ThingsBoard microservices: $ ./k8s-delete-resources.sh ` -Execute the following command to delete all thirdparty microservices: +Execute the following command to delete all third-party microservices: ` $ ./k8s-delete-thirdparty.sh