Adding a MongoDB application server

Edit online

To start protecting MongoDB resources, you must add the server that hosts your MongoDB instances, and set credentials for the instances. Repeat the procedure to add all the servers that host MongoDB resources.

About this task

To add a MongoDB application server to IBM Storage® Protect Plus, you must have the host address of the machine.

Procedure

  1. In the navigation panel, expand Manage Protection > Databases > MongoDB.
  2. In the MongoDB window, click Manage Application Servers, and click Add Application Server to add the host machine.
  3. In the Application Properties form, enter the Host Address.
  4. Obtain the server key and verify that the key type and key fingerprint match the host. Click Get server key.
    Get server key
    The SSH server key for the Linux-based host. You must complete this step when adding servers for the first time or if the key on the server changes.
    When upgrading to the IBM Storage Protect Plus latest version, systems that are already registered in the previous version are set to trust on first use (TOFU) and the SSH key fingerprint will automatically be added to the registration information in the catalog.
    Key type
    The type of key for the Linux-based host is displayed. The following key types are supported:
    • RSA with a minimum key size of 2048 bits
    • ECDSA
    • DSA
    Key fingerprint
    The MD5 hash of the SSH key fingerprint is displayed. Confirm that they key fingerprint matches the key fingerprint of the host that you are adding.
  5. Choose to register the host with a user or an SSH key.
    If you select User, you can choose to enter a new user and password, or an existing user. If you select SSH Key, select the SSH key from the menu.
    Restriction: Any user that is specified must have sudo privileges set up.
    Figure 1. Adding a MongoDB agent
    Adding MongoDB application server
  6. Click Get Instances to detect and list the MongoDB instances that are available on the host server that you are adding.

    Each MongoDB instance is listed with its connection host address, status, and an indication of whether it is configured.

    Attention: If you register more than one application server for one replica set, the instance name that is displayed might change after each inventory, backup, or restore operation. The host name of the most recently added application server that belongs to the replica set is used as part of the instance name. An inventory operation is run as part of backup and restore operations.
  7. If you are using access control, configure an instance by setting credentials. Click Set Credential, and set the user ID, and password. Alternatively, you can select to use an existing user profile.
    For more information about access control, see Managing user access.

    When you set credentials, you assign MongoDB user roles for the backup and restore operations with access to role-protected MongoDB servers by using Salted Challenge Response Authentication Mechanism (SCRAM), or Challenge and response authentication. The MongoDB user that is assigned for the role-protected MongoDB server requires one of the following access levels to protect resources:

    • Host Manager: manages the database as the administrator. This role is required for taking and managing snapshots.
    • Cluster Administrator: retrieves configuration information and runs test mode restore operations of MongoDB replica sets. This role is required to reconfigure test mode restore operations of MongoDB replica sets for data queries.
    • Cluster Monitor: monitors the protection of MongoDB resources, and retrieves configuration information.
  8. Optional: Set the option Maximum concurrent databases by entering a number in the field.
  9. Save the form, and repeat the steps to add other MongoDB application servers to IBM Storage Protect Plus.

What to do next

After you add MongoDB application servers to IBM Storage Protect Plus, an inventory is automatically run on each application server to detect the relevant databases in those instances.

To verify that the databases are added, review the job log. Go to Jobs and Operations. Click the Running Jobs tab, and look for the latest Application Server Inventory log entry.

Completed jobs are shown on the Job History tab. You can use the Sort By list to sort jobs based on start time, type, status, job name, or duration. Use the Search by name field to search for jobs by name. You can use asterisks as a wildcard in the name.

Databases must be detected to ensure that they can be protected. For instructions about running a manual inventory, see Detecting MongoDB resources.