- Creating a new deployment/subscription
- Changing plans
- Managing your subscriptions
- Calculating charges
- Deleting a deployment/subscription
- Frequently Asked Questions (FAQ)
Creating a new database deployment in your mLab account is a simple process after you’ve determined which plan you need. Once you’ve subscribed to a plan, you can make changes to the deployment or delete it when you do not need it any longer.
Creating a new deployment/subscription
There are two ways to create a new deployment: from scratch or from a backup previously taken by mLab’s backup system. Follow the instructions in the sections that follow to create your new deployment using one of these two methods.
To create a new deployment from scratch, follow these steps:
- Log in to the mLab management portal.
- On your account’s Home page, click the “Create new” button.
- Make all the desired selections and fill in the requested fields.
- Review your choices and when you’re ready, click the “Submit Order” button.
- Your new deployment will be listed on your account’s Home page where you can monitor provisioning progress.
- When the deployment has been completely provisioned, you will be able to navigate to its home (administrative) page.
It is not possible to change the name of a MongoDB database unless you export the data and re-import it again (see feature request for the ability to rename databases); for any sizable database, this requires significant downtime.
For this reason, we discourage decorating the name of your database with word(s) that indicate the environment in which the deployment will be used (e.g., Development, Staging, Production). As an example, let’s say you name your database, “users-production.” Later on you might create a new, Staging environment from a filesystem-level backup of this database; your Staging environment’s database would then also be called “users-production.”
For more information about managing your subscriptions, see “Managing your subscriptions” further down on this page.
Create from backup
If you used the mLab backup system to take a custom backup of an existing mLab database deployment, you can create a new deployment with data restored from one of your backups.
Restoring a backup into a brand-new deployment using our “Create from backup” feature is a convenient way to change plans. Alternatively, you can manually take a backup and then restore it to a new deployment on the desired plan. Note that both of these methods will require you to update your application’s connection URI (host, port and database name) and require downtime.
If you would like a seamless plan change and are migrating from a Shared Cluster plan to a Dedicated Cluster plan or between Dedicated Cluster plans, we can use our seamless rolling node replacement process which requires no change in connection string.
For subscriptions created via one of our Platform-as-a-Service (PaaS) partners (e.g., Heroku), refer to the documentation available on our partner’s site.
Recommended plan change methods
Using the table below, you can quickly identify our recommended method to change from your current plan to your desired plan. The two recommended methods are then described in detail below.
|Current Plan||Target Plan||Recommended Method||Requires Downtime?|
|Sandbox||Shared||Restore backup (mongodump) into new deployment||Yes|
|Sandbox||Dedicated||Restore backup (mongodump) into new deployment||Yes|
|Shared||Dedicated 1||Rolling node replacement||No|
|Shared||Sandbox||Restore backup (mongodump) into new deployment||Yes|
|Dedicated||Sandbox 2||Restore backup (mongodump) into new deployment||Yes|
|Dedicated||Shared 2||Restore backup (mongodump) into new deployment||Yes|
|Dedicated||Dedicated 1||Rolling node replacement||No|
Restore backup (mongodump) into new deployment
Taking a backup and restoring it into a deployment is a convenient way to change plans. However, it will require you to update your connection string and require downtime.
If you’re migrating from a Single-node plan to a Cluster plan, be sure to first read our documentation on making replica set connections.
Using mLab’s backup system
To use mLab’s backup system to restore a backup into a new deployment, follow these steps:
- Stop all processes running against your current deployment.
- Take a one-time backup.
- Choose mongodump as the backup method.
- Be sure to note the backup ID.
- Wait for the backup to complete.
- Create a new deployment from backup using this backup ID.
- Be sure to review backup restore considerations first.
- Note that database users will not be included as part of the restore process.
- Create database user(s) on the new deployment.
- Change your connection string and start your app again.
- Once you are no longer using the original deployment, delete it (otherwise, if it is a for-pay subscription, it will continue to incur charges).
Using mongodump and mongorestore
To manually change from one plan to another, you can use the mongodump and mongorestore commands to move your data from one deployment to another. After you have completed the migration of data and are no longer using the original deployment, delete it (otherwise, if it is a for-pay subscription, it will continue to incur charges).
Rolling node replacement
If you are migrating from a Shared Cluster plan to a Dedicated Cluster plan or changing between Dedicated Cluster plans, we can use mLab’s rolling node replacement process so that you won’t have downtime or need to change your connection string.
A Dedicated plan cannot be downgraded to a Shared plan using the rolling node replacement process because Dedicated plans include the ability to create multiple databases while Shared plans do not. However, downgrades between Dedicated plan types can leverage the rolling node replacement process.
mLab’s seamless rolling node replacement is a process that replaces each node in your cluster in turn. Each node is replaced by bringing a new node into the cluster, replicating the data to that node, removing the old node, and updating DNS records.
If the node being replaced is the primary, a failover is performed so that it will be a secondary during the replacement. In this way, the cluster remains available during the entire process.
How to initiate a rolling node replacement to change plans
To use mLab’s management console to initiate a rolling node replacement process to change plans, follow these steps:
- Log in to the mLab management portal.
- From your account’s Home page, navigate to the deployment you wish to change plan.
- Click the “Tools” tab.
- Under the “Initiate maintenance operation” header, select the “Change plan” option.
- Select the target plan in the drop-down menu that appears below “This deployment’s current plan…”
- Select the failover option in the drop-down menu that appears at the bottom of the “Failover Preference” section.
- Click the “Change to….” button to start the rolling node replacement process.
Not all plan changes are self-service via mLab’s management console (e.g., High Performance line changes). If there is a target plan that’s not available, please email firstname.lastname@example.org to request the change.
Managing your subscriptions
mLab’s management portal is a web-based user interface with rich admin tools that give you insight into your data and control over your deployment. When you log in with your mLab account user credentials, you will automatically be directed to your account’s Home page which lists all of your mLab deployments.
Home page for mLab’s management portal
From your Home page, you can navigate to the home (administrative) page for a specific deployment by clicking the appropriate row. Additionally, as you move around the portal, you’ll come across tools that help you browse your data and manage your deployment.
For example, if you click on the row for a Sandbox database, you’ll be taken directly to the home page for that database. From there you can browse the collections and documents in that database, run queries, add indexes, edit documents, compact, and so forth.
Or, if you click on the row for a for-pay deployment (Shared or Dedicated plan), you’ll be taken to the deployment’s home page from where you’ll be able to access the administrative pages for any of the servers or databases associated with that deployment. You’ll also have access to server- and cluster-specific tools that allow you to view live statistics, look for slow queries, access log files, upgrade MongoDB versions, and so forth.
Expand row for more details
As described above, information about your subscriptions is summarized on the Home page in the mLab management portal. Some information such as the deployment identifier and plan type is readily displayed up front after logging in.
However, additional information about your deployment is available by clicking the gray triangle that appears to the left of the deployment name in order to expand the row.
For example, the deployment’s cloud region and MongoDB version will appear if you expand the row. Additionally for Dedicated plans, if you expand the row you will be able to see the type and size of disk that has been allocated for your deployment.
The essentials on how we calculate charges for each of your subscriptions are documented here.
You will be billed at the start of each month for all chargeable services provided in the prior month using our secure, hassle-free credit card-based payment system.
For-pay plans are prorated on a daily basis, although prices shown on our pricing page are monthly. You will only be charged for the days your deployment exists.
Basis and determination
All plans include a specific amount of disk space to hold your data.
Sandbox plans are free but quota enforcement will be based on the
fileSize value output from MongoDB’s
dbStats command. The file size is the total size of the storage files used for your database, which represents the overall storage footprint for your database on disk. We display the
fileSize metric in our management console under the “Size on Disk” header. Read here for more information about file size vs. data size.
Shared Cluster plans automatically come with 1 GB which is included as part of the base price. The fees increase after the first 1 GB according to the
fileSize value from MongoDB’s
dbStats command. Specifically, the plan is metered by the byte on a daily basis by calculating the average value of the file size values of both the primary and secondary nodes of a Shared Cluster. For example, a cluster whose daily average file size value is 1.5GB throughout an entire month would pay $22.50 for that month based on a rate of $15/GB/month. We display the
fileSize metric in our management console under the “Size on Disk” header.
Since deletion of data does not automatically reduce the file size of a deployment, it is often necessary to compact a Shared Cluster to reclaim disk space for the primary and secondary nodes.
Dedicated plans are priced based on the specifications of your virtual machines as well as the size and type of pre-allocated block storage.
Shared plan databases run with the
--smallfiles option. The first file allocated is 16MB, the second 32MB, the third 64MB… until 512MB is reached at which point each subsequent file is 512MB. To read more about this, visit the official MongoDB manual.
Frequently asked questions
Q. What is the “local” database and does it count towards my quota and/or bill?
local database stores data used in the replication process and other node-specific data (i.e., its data does not replicate). Most importantly, this database contains the oplog (operations log).
We currently configure our Shared Cluster plans with a 2 GB oplog, and this oplog is included for free. In other words, it does not contribute to your quota or your bill.
Deleting a deployment/subscription
The process to delete a deployment is very simple:
- For Sandbox plans, click the “Delete database” button on the database’s home page.
- For Shared or Dedicated plans, click either the “Delete server” or “Delete cluster” button on the deployment’s home page.
With for-pay subscriptions, you must delete the whole deployment, not just the database(s) that are associated with the server/cluster.
If you wish to save your data before deleting your deployment, be sure to create a backup and save it to your own custom container or download it to a safe place.
Frequently Asked Questions (FAQ)
Q. Why is downtime necessary when upgrading from a Sandbox plan to a for-pay plan?
We run many Sandbox databases on the same database server process (i.e., same hostname:port), so unfortunately it’s not possible for seamless upgrades from Sandbox to for-pay plans. You will instead need to restore a backup into a brand-new deployment and change your connection string. Once your deployment is on a for-pay plan, from that point forward it will be possible to seamlessly upgrade.
Q. Can I cancel my subscription but keep the data?
It’s not possible to put a subscription on pause or temporarily deactivate your deployment without the data being deleted.
If you would like to stop incurring charges for your deployment without losing your data, you will need to safely store a backup of the deployment and then delete your deployment.
For a backup taken using mongodump, you should ensure that the backup is stored in your own S3 bucket. If you don’t have an S3 bucket and your deployment is small, you can download the mongodump to your local computer; from there, we strongly recommend making sure that it’s backed up.
For an EBS Snapshot on AWS, you must share the EBS Snapshot with your AWS account and then copy it into your AWS account. If the backup is not stored in (and owned by) your own AWS account, it will be deleted as per mLab’s backup retention policies.