Deploy MongoDB (Small Scale)¶

Huddo Boards requires a Mongo database.

Warning

The example below is suitable for a Small Scale Deployment, e.g. a proof of concept, staging deployment or even a production deployment for a limited number of users/data.

Tip

For Large Scale Deployments (HA) please use either MongoDB:

hosted by a compatible cloud provider (e.g. Cloud Atlas)
self hosted in a ReplicaSet architecture. For example, bitnami/mongodb offer a decent wrapper to initialise a replicaset with their Helm chart.

This documentation will deploy a MongoDB replicaSet into your Kubernetes setup.

If you already have externally hosted Mongo database please skip to the Outcomes section to determine your equivalent connection parameters.

You can also email us for support at support@huddo.com

Prerequisites¶

Config file downloaded

Update config file¶

Line	Key	Default Value	Description
21	`nfs.path`	`/pv-kudos/mongo`	Path to storage location
22	`nfs.server`	`[STORAGE_SERVER_IP]`	IP of NFS server ie `192.168.10.50`

Deploy instructions¶

Create the folder at nfs.path location on the nfs.server with access 777

Note: please ensure sufficient storage is available (ie 100GB)
Ensure each Node in your Kubernetes cluster can mount this location.

Please modify the file /etc/exports on your NFS Server to include this line
```
<NFS_PATH_FOR_MONGO> <IP_RANGE_OF_YOUR_SERVERS>/<SUBNET_MASK>(rw,no_root_squash)
```
For example:
```
/pv-kudos/mongo 192.168.0.0/255.255.0.0(rw,no_root_squash)
```
Apply new NFS storage to exports
```
exportfs -ra
```
Install Mongo
```
kubectl apply -f ./mongo.yaml
```

Outcomes¶

The following are the parameters required to connect to this database. You will need these later in the application setup. If you have your own MongoDB deployment, please substitute your values.

Key	Default Value	Description
`MONGO_PROTOCOL`	`mongo`	Protocol used in your Connections String
`MONGO_HOST`	`mongo-service:27017`	Hostname of your Mongo service
`MONGO_PARAMS`	`replicaSet=replicaset`	Request parameters (ie ?)
`MONGO_USER`	None	Username to connect. Authentication is disabled in this private deployment
`MONGO_PASSWORD`	None	Password to connect. Authentication is disabled in this private deployment

Alternatively, these parameters can be set with MONGO_URI which is built from:

[MONGO_PROTOCOL]://[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]

mongo://mongo-service:27017/database?replicaSet=replicaset

Or with optional credentials:

[MONGO_PROTOCOL]://[MONGO_USER]:[MONGO_PASSWORD]@[MONGO_HOST]/[MONGO_DB]?[MONGO_PARAMS]

mongo://user:passw0rd@mongo-service:27017/database?replicaSet=replicaset