Skip to content

Commit 6412536

Browse files
committed
Updated documentation
1 parent c29fd64 commit 6412536

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# Sugarizer School Portal Chart
22
[Helm](https://helm.sh/) Chart for setting up [Sugarizer School Portal Server](https://github.com/nikhilm98/sugarizer-school-portal-server) deployment on a [Kubernetes](https://kubernetes.io/) cluster.
33

4-
**Sugarizer School Portal** is a Kubernetes cluster that is able to create/manage on-demand new Sugarizer Server instances.
4+
[Sugarizer School Portal](https://github.com/nikhilm98/sugarizer-school-portal) is a Kubernetes cluster that is able to create/manage on-demand new Sugarizer Server instances.
55

66
## Usage
77
You can deploy **Sugarizer School Portal Server** instance by editing the values of the Values YAML file and running simple `helm install` command. The Sugarizer School Portal Server instance can be accessed by the browser by opening the hostName URL.
88

9-
## Environment Setup
9+
## Setup Script (Automatic Setup)
10+
You can use Sugarizer School Portal setup script to install dependencies, set-up the cluster environment and install the Sugarizer School Portal Chart on your GKE Cluster. You can find the script [here](https://github.com/NikhilM98/sugarizer-school-portal/tree/master/scripts).
11+
12+
Simply navigate into the scripts directory and run `sh setup.sh` to set up your cluster. You can read more about the setup process in the [documentation](https://github.com/NikhilM98/sugarizer-school-portal/blob/master/scripts/README.md).
13+
14+
## Environment Setup (Manual Setup)
1015
If you don't have a [GKE](https://cloud.google.com/kubernetes-engine) cluster set-up, you can follow these steps to set-up a working environment.
1116

1217
### Install MongoDB-Replicaset
@@ -78,7 +83,7 @@ helm install cert-manager jetstack/cert-manager --namespace cert-manager --versi
7883
### Create Service Account
7984
You need to create a GCP service account key from the API & Services page. Save the service account key. It will be required in the values.yaml file while chart installation. It'll also be required if you set-up backup and restore using MGOB and intend to use gcloud bucket.
8085

81-
## Chart Installation
86+
## Chart Installation (Manual Setup)
8287
If you have Kubernetes set-up, then Sugarizer School Portal Chart can be installed by following these steps:
8388

8489
### Clone Sugarizer School Portal Chart

0 commit comments

Comments
 (0)