Setting up CouchDB as a microservice in the cloud

In short

For most applications you will need to store data, and a popular service to use for that is CouchDB. In this article we'll be looking at how you easily create and set up a database in the cloud (Microsoft Azure) without having the hassle of lengthy server, network and security setup and managing a Kubernetes cluster.

Getting started

If you already have a mogenius account, proceed to the next step. Otherwise you can sign up here: mogenius sign-up

Sign up for mogenius - it's free and you can get started right away. Once you've created your account, you can create a new cloudspace that contains all your services and databases for a project, like CouchDB. The services all reside in your secure cloudspace and can communicate with each other (Kubernetes namespace isolation). This is a convenient way to build a cloud-native software project that consists of one or more interconnected microservices. Once you have confirmed your email and phone number, you can create a new cloudspace:

Choose a name for your cloudspace and select the free tier to get cloud resources at no charge, or you can also choose a subscription to upgrade your resources when you create the cloudspace or upgrade at a later stage.

Adding CouchDB to your cloudspace

Now are ready you to set up a CouchDB database! On the next overview page, you will see all your cloudspaces. Click on the name of the cloudspace where you want to set up your CouchDB database. On the next page, click "Service Library" in the left menu:

mogenius will automatically create and setup CouchDB for you and add a dockerfile in one of your Git repositories. Click on “Add Service” underneath the CouchDB logo on the next page.

If this is the first time you are deploying a service, we need to connect your cloudspace to your repository. Click on “Connect Github” which will ask you to grant permission to access your Github repositories.

You will only need to do this once, your mogenius cloudspace is now connected to your GitHub account, and can access your repositories.

Next, you can either use an existing empty repo or create a new one by clicking the “+” symbol. Select a name for the new repo and create it.

Specifiy a name for the database service, select the branch in your repo and stage in your cloudspace you want to use. Deployment strategy you can leave the re-create, or if you have a subscription plan that supports it, select rolling deployments.

Now we need to set the environment variables. Most of them are pre-filled for you, and you can adjust them optionally.

Three fields are mandatory: CouchDB_User and CouchDB_Passwor , with that other services can access CouchDB database. You can choose your passwords from your list of secrets, create a new one or simply have one generated for you. If you create a new secrent, they will be stored in your mogenius KeyVault for easy a ccess later on. To have a new secret generated automatically, click the wizard-button:

You can also change the resources like CPU cores, memory and persistent storage. By default we have pre-configured these for optimum and efficient usage of your resources.

Now, simply click "Save". Your CouchDB database will now be built, the dockerfile added to the specified Git repository, and deployed to your cloudspace at the same time so you can start using it almost immediately. Once the setup routines, build and deployment process are complete (usually a few minutes at most), you can start using your CouchDB database at the specified URL. You can find all the details on your service's overview page, where you can also customize the resources and scale by adding additional instances for your service.

That’s it! You have created your first CouchDB database service and it will be available to access by other services in your cloudspace. Please note: In order to access the admin UI, add "/_utils/" at the end of the service URL, e.g. couchdb-dev-sundaysbest-qx6r52.dev.mogenius.io/_utils/.