Manage S3-Compatible Snapshot Storage
On this page
- Considerations
- Requires a Dedicated Bucket
- Can't Move the S3-Compatible Snapshot Store
- Supports the Storage API
- Prerequisites
- Metadata Storage Prerequisites
- AWS S3 Storage Prerequisites
- Other S3-Compatible Storage
- Procedures
- Add One S3-Compatible Snapshot Store
- Edit One Existing S3-Compatible Snapshot Store
- Delete One S3-Compatible Snapshot Store
Ops Manager can back up MongoDB databases as snapshots to one or more of the following storage options:
Another MongoDB database, called a blockstore,
As files stored on a local or network-attached file system, and/or
An S3-compatible bucket.
This tutorial covers backing up your MongoDB databases as snapshots stored in S3-compatible storage and S3-compatible storage-compatible buckets. Ops Manager stores the metadata for S3 snapshot stores in a MongoDB database.
Note
You might have issues that require you to use more than one snapshot store. These issues could include needing more capacity, localizing data, or meeting privacy regulations.
To learn how to assign snapshot stores to different data centers, see Assign Snapshot Stores to Specific Data Centers.
Considerations
Requires a Dedicated Bucket
Ops Manager must be the only manager on the S3-compatible storage bucket that you use for snapshots. You also need to configure the S3-compatible storage bucket to avoid using features that Ops Manager does not support.
When configuring the S3-compatible storage bucket:
Do not create subfolders in the S3-compatible storage buckets that you use with Ops Manager. Ops Manager only supports using entire S3-compatible storage buckets.
Disable S3-compatible storage bucket versioning. Versioning is not supported in Ops Manager for the S3-compatible storage buckets used for snapshots.
Do not create S3-compatible storage lifecycle rules. Lifecycle rules that expire or transition current versions of Ops Manager snapshot objects to archives results in incomplete snapshots that you can't use to restore the configuration.
Can't Move the S3-Compatible Snapshot Store
After you create an S3-compatible snapshot store, you cannot move it to another S3-compatible storage bucket. If you need to use a different S3-compatible storage bucket to host your S3-compatible snapshot store, you must create a new S3-compatible snapshot store in that S3-compatible storage bucket.
Supports the Storage API
MongoDB supports endpoints that are compatible with AWS S3 APIs from any vendor. Ops Manager attempts to validate these endpoints when you save the S3-compatible snapshot store setup. If validation passes, Ops Manager saves the configuration. If validation fails, Ops Manager displays an error and doesn't save the configuration.
Prerequisites
Metadata Storage Prerequisites
Deploy the dedicated MongoDB instance(s) to serve the S3 snapshot store metadata and Oplog Store. Serve these instances on separate hosts from the Ops Manager host and the application database to avoid performance and backup issues. Attach one or more storage volumes with enough capacity to store the databases these instances manage.
Ensure the host serving the Ops Manager Backup Daemon service has enough capacity to store the head database.
Secure the instance that stores your S3 snapshot store metadata database using authentication and TLS. S3-compatible snapshot store metadata databases support
all authentication mechanisms.
AWS S3 Storage Prerequisites
Verify that you have an IAM user on AWS.
Create your own AWS access keys for your IAM user. This allows you to create S3-compatible storage buckets and store snapshot files in them. MongoDB does not create or issue AWS access keys.
Create your own S3 bucket to store your S3 snapshot store snapshots.
Note
The IAM user that you created the AWS access keys for must have at least the following read and write permissions for the S3-compatible storage Bucket:
s3:PutObjects3:GetObjects3:ListBuckets3:DeleteObject
(Optional) If you serve your Ops Manager instance on AWS EC2, create an IAM Role to handle authorization.
This role needs:
AWS service as the trusted entity.
EC2 as the use case.
Permissions to read and write access to your S3-compatible storage bucket.
To learn more, see:
Other S3-Compatible Storage
Other S3-compatible storage endpoints can be used. Ops Manager attempts to validate these endpoints when you save the configuration. If validation passes, the configuration, Ops Manager saves it. If validation fails, Ops Manager displays an error and doesn't save the configuration.
Procedures
The format of the Username and Password depend upon the authentication mechanism. Select one of the following tabs:
Add One S3-Compatible Snapshot Store
Navigate to the Snapshot Storage page.
Click the Admin link.
Click the Backup tab.
(Optional) If you have not previously set the head directory, set it in the Head Directory box.
Click the Snapshot Storage page.
Provide the S3 blockstore details.
Field | Necessity | Contents | |
|---|---|---|---|
Name | Required | Type the label for the S3-compatible snapshot store. | |
S3 Bucket Name | Required | Type the name of the S3-compatible storage bucket where you want to host the
the S3-compatible snapshot store. | |
Region Override | Conditional | Type the region where your S3-compatible storage bucket resides. Use this field only if your S3-compatible storage store's S3 Endpoint doesn't support region scoping. Don't provide a value for this field with S3-compatible storage buckets. | |
S3 Endpoint | Required | Type the URL for this S3-compatible storage bucket. | |
S3 Max Connections | Required | Type a positive integer indicating the maximum number of
connections to this S3-compatible storage bucket. | |
Path Style Access | Optional | Select if you want your S3-compatible storage bucket
to use a path-style URL endpoint
( To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation | |
Server Side Encryption | Optional | Select to enable server-side encryption.
Clear to disable server-side encryption. | |
S3 Authorization Mode | Required | Select the method used to authorize access to the S3-compatible storage bucket specified in S3 Bucket Name. If you select Keys, Ops Manager uses AWS Access Key and AWS Secret Key to authorize access to your S3-compatible storage bucket. If you select IAM Role, Ops Manager uses an AWS IAM role to authorize access to your S3-compatible storage bucket. AWS Access Key and AWS Secret Key fields are ignored. | |
Keys with Custom CA Bundle | Conditional | Click Choose file to add a custom Certificate Authority
chain. This chain can validate against a self-signed
certificate on the S3-compatible storage bucket. | |
AWS Access Key | Conditional | Type your AWS Access Key ID. Ops Manager displays this field when you set S3 Authorization Mode to Keys. | |
AWS Secret Key | Conditional | Type your AWS Secret Access Key. Ops Manager displays this field when you set S3 Authorization Mode to Keys. | |
Datastore Type | Required | Select Standalone, Replica Set or
Sharded Cluster. This MongoDB database stores
the metadata for the blockstore. | |
MongoDB Host List | Conditional | Type a comma-separated list of For example: Ops Manager displays this field when you set Datastore Type to Replica Set or Sharded Cluster. | |
MongoDB Hostname | Conditional | Type the hostname of the S3-compatible snapshot store metadata database. Ops Manager displays this field when you set Datastore Type to Standalone. | |
MongoDB Port | Conditional | Type the port number of the S3-compatible snapshot store metadata database. Ops Manager displays this field when you set Datastore Type to Standalone. | |
Username | Optional | If you set this value: Type the name of the user authorized to access the this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring SCRAM authentication, see SCRAM. Type the RFC-2253-formatted subject from the client certificate of the user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring x.509 authentication, see x.509. Type the UPN of the user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring Kerberos authentication, see Kerberos. Type the name of the LDAP user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring LDAP authentication, see LDAP. | |
Password | Optional | If you set this value: Type the password associated with the username that can access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring SCRAM authentication, see SCRAM. Leave it blank. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring x.509 authentication, see x.509. Kerberos retrieves the password from its keytab file. Don't type a password into this field. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring Kerberos authentication, see Kerberos. Type the password of the LDAP user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring LDAP authentication, see LDAP. WARNING: If you did not use the credentialstool to encrypt this password, it is stored as plaintext in the database. | |
Connection Options | Optional | Add additional configuration file options for the MongoDB instance. This field supports unescaped values only. TLS options do not work here.
Configure TLS in the For proper syntax, see Connection String URI Format in the MongoDB manual. | |
Deployment Id | Optional | Unique identifier of the Deployment Region
in which to host the bucket. | |
Encrypted Credentials | Optional | Select if the credentials for the database were encrypted
using the
credentialstool.
The credentials include the Username, Password, AWS Access
Key ID and AWS Secret Key. | |
Use TLS/SSL | Optional | Select if the S3-compatible snapshot store metadata database only accepts connection encrypted using TLS. Beyond this checkbox, to connect this S3-compatible snapshot store using TLS, you must enable TLS on the S3 blockstore database. | |
New Assignment Enabled | Optional | Select if you want to enable this S3-compatible snapshot store after creating it.
This is selected by default so the S3-compatible storage blockstore can be
assigned backup jobs. If you clear this checkbox, the S3-compatible snapshot store
is created but you cannot assign backups to this S3-compatible snapshot store. | |
Disable Proxy Settings | Optional | Select if you want to disable proxying to this S3-compatible snapshot store after
creating it. AWS S3 respects the HTTP_PROXY and the
HTTPS_PROXY environment variables. If you set either of
these environment variables, S3-compatible storage still enables the proxy. |
Edit One Existing S3-Compatible Snapshot Store
Ops Manager lists S3-compatible snapshot stores in a table on the Snapshot Storage page. Each row contains the settings for one S3-compatible snapshot store.
Navigate to the Snapshot Storage page.
Click the Admin link.
Click the Backup tab.
(Optional) If you have not previously set the head directory, set it in the Head Directory box.
Click the Snapshot Storage page.
Update any editable values that need to be changed.
In the MongoDB Connection column, update any editable values that need to be changed in the following fields:
Field | Necessity | Editable | Contents | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
S3 Bucket Name | Required | no | Type the name of the S3-compatible storage bucket where you want to host the
the S3-compatible snapshot store. | ||||||||||||||||
Region Override | Conditional | yes | Type the region where your S3-compatible storage bucket resides. Use this field only if your S3-compatible storage store's S3 Endpoint doesn't support region scoping. Don't provide a value for this field with AWS S3 buckets. | ||||||||||||||||
S3 Endpoint | Required | yes | Type the URL for this S3-compatible storage bucket. | ||||||||||||||||
S3 Max Connections | Required | yes | Type a positive integer indicating the maximum number of
connections to this S3-compatible storage bucket. | ||||||||||||||||
Path Style Access | Optional | yes | Click if you want your S3-compatible storage bucket
to use a path-style URL endpoint
( To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation | ||||||||||||||||
Server Side Encryption | Optional | yes | Click to enable server-side encryption.
Clear to disable server-side encryption. | ||||||||||||||||
S3 Authorization Mode | Required | yes | Select the method used to authorize access to the S3-compatible storage bucket specified in S3 Bucket Name.
| ||||||||||||||||
Keys with Custom CA Bundle | Conditional | yes | Click Choose file to add a custom Certificate Authority
chain. This chain can validate against a self-signed
certificate on the S3-compatible storage bucket. | ||||||||||||||||
AWS Access Key | Conditional | yes | Type your AWS Access Key ID. Ops Manager displays this field when you set S3 Authorization Mode to Keys. | ||||||||||||||||
AWS Secret Key | Conditional | yes | Type your AWS Secret Access Key. Ops Manager displays this field when you set S3 Authorization Mode to Keys. Ops Manager doesn't display the existing Secret Access Key. | ||||||||||||||||
<hostname>:<port> | Required | yes | Type in one or more hosts that comprise the S3-compatible storage Snapshot
Store metadata database in the If the S3-compatible snapshot store metadata database is a Replica
Set or Sharded Cluster, type a comma-separated list of
For example: If the S3-compatible snapshot store metadata database is a
standalone MongoDB instance, type the IMPORTANT: If these hosts are changed, the blockstore they host must have the same data as the original blockstore. Changing the host to a new blockstore results in data loss. | ||||||||||||||||
MongoDB Auth Username | Optional | yes | If you set this value: Type the name of the user authorized to access the this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring SCRAM authentication, see SCRAM. Type the RFC-2253-formatted subject from the client certificate of the user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring x.509 authentication, see x.509. Type the UPN of the user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring Kerberos authentication, see Kerberos. Type the name of the LDAP user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring LDAP authentication, see LDAP. | ||||||||||||||||
MongoDB Auth Password | Optional | yes | If you set this value: Type the password associated with the username that can access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring SCRAM authentication, see SCRAM. Leave it blank. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring x.509 authentication, see x.509. Kerberos retrieves the password from its keytab file. Don't type a password into this field. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring Kerberos authentication, see Kerberos. Type the password of the LDAP user authorized to access this database. If your Ops Manager Application Database uses authentication or TLS, you must have connections configured to the application database. To learn more, see Configure the Connections to the Application Database. To learn more about configuring LDAP authentication, see LDAP. Ops Manager doesn't display the existing MongoDB Auth Password. WARNING: If you did not use the credentialstool to encrypt this password, it is stored as plaintext in the database. | ||||||||||||||||
Encrypted Credentials | Optional | yes | Select if the credentials for the database were encrypted
using the
credentialstool.
The credentials include the Username, Password, AWS Access
Key ID and AWS Secret Key. | ||||||||||||||||
Use TLS/SSL | Optional | yes | Select if the blockstore database only accepts connection encrypted using TLS. Beyond this checkbox, to connect this S3-compatible snapshot store using TLS, you must enable TLS on the S3 blockstore database. | ||||||||||||||||
Connection Options | Optional | yes | Type any additional configuration file options for the MongoDB instance. This field supports unescaped values only. For proper syntax, see Connection String URI Format in the MongoDB manual. | ||||||||||||||||
Assignment Labels | Optional | yes | Type a comma-separated list of labels to assign the
S3 blockstores to specific projects. | ||||||||||||||||
Load Factor | Optional | yes | Type any positive integer that expresses how much backup work you want this snapshot store to perform compared to another snapshot store. Backup work includes running backups, restoring snapshots or grooming blockstores. The ratio of backup work assigned to a single snapshot store is called its Load Factor. IMPORTANT: If you have only one snapshot store,
Load Factor represents the number of concurrent
backup work processes the snapshot store performs at a time.
To avoid performance costs associated with running multiple
concurrent processes when you have one snapshot store,
omit this setting to assign your snapshot store the
default Load Factor of When you have multiple snapshot stores, the default Load Factor
of If a snapshot store's Load Factor is changed while
backup work is in progress, all jobs or tasks running on that snapshot store
are allowed to finish. All future backup work is then re-
distributed among the remaining snapshot stores that have a
Load Factor of As a snapshot store's Load Factor increases, it
performs more backup work compared to another snapshot store.
For example, if the Load Factor of snapshot store Snapshot stores with greater computer or storage performance should be given a greater Load Factor. For example, consider a five-shard sharded cluster with the following backup storage configuration:
In this example, For more examples comparing the storage capabilities of different backup configurations, see:
| ||||||||||||||||
Write Concern | Required | yes | Select your preferred Write Concern:
|
Select the checkbox in the Assignment Enabled column.
Select if you want to enable this S3-compatible snapshot store after creating it. This is selected by default so the S3-compatible snapshot store can be assigned backup jobs. If you clear this checkbox, the S3-compatible storage Snapshot Store is created but you cannot assign backups to this S3-compatible storage Snapshot Store.
Optional: Restart Ops Manager instances if needed.
If you change any connection string values or the Write Concern, restart all the Ops Manager instances including those running Backup Daemons.
Warning
Modifying the connection string values or the Write Concern for an existing blockstore requires all Ops Manager components, including those only running the Backup Daemon, to be restarted to apply those changes. Connection parameters include:
<hostname>:<port>
MongoDB Auth Username
MongoDB Auth Password
Encrypted Credentials
Use TLS/SSL
Connection Options
Write Concern
If you change to another blockstore host, the data on the existing blockstore is not copied automatically to the other blockstore.
Tip
See also:
For more details on the MongoDB connection string URI, see Connection String URI Format in the MongoDB Manual.
Delete One S3-Compatible Snapshot Store
Navigate to the Snapshot Storage page.
Click the Admin link.
Click the Backup tab.
(Optional) If you have not previously set the head directory, set it in the Head Directory box.
Click the Snapshot Storage page.