DB Server

Available in VPC

In DB Server, you can create or delete the Cloud MongoDB servers, as well as check the list of MongoDB servers in operation. In addition, you can also change the specifications of the MongoDB servers in operation or manage admin (user) accounts.

DB server page

The basics of using DB server are as follows:

Checking MongoDB server list

You can check the information of each server from the list of MongoDB servers that have been created and are in operation. To view the information, follow these steps:

1. Click Services > Database > Cloud DB for MongoDB from the VPC environment of the NAVER Cloud Platform console, in order.

2. Click the DB server menu.

3. If the list of created MongoDB servers appears, check the summary information or click a MongoDB server to check the details.
   

   • DB service name: a group of MongoDB clusters under the MongoDB service name
   • Cluster role: roles of the MongoDB cluster
   • DB server name: name of the MongoDB server
   • DB role/role: roles of the MongoDB Server
   • DB server type: type of the MongoDB server and its available memory
   • Monitoring: directs to the monitoring page
   • DB status: directs to the View DB Server details page
   • DB access port: port number being used by the MongoDB server
   • Private domain: information of the private domain
   • Public domain: information of public domain
   • Data storage: size of the data storage in use (available capacity)
   • Data storage type: type of the data storage in use
   • Data storage capacity: available capacity and used capacity of the data storage in use
   • Status: status of the MongoDB server
     • Creating: status in which the MongoDB server is being created with the information entered by the user
     • Configuring: status in which the MongoDB server is being configured after being created with the information entered by the user
     • Running: status in which the creation and configuration of the MongoDB server has been completed with the information entered by the user, and access to MongoDB from the application server is available
     • Deleting: status in which the MongoDB server is being deleted with the information entered by the user
     • Stopping: status in which the MongoDB server is being stopped with the information entered by the user
     • Restarting: status in which the MongoDB server is being restarted with the information entered by the user
   • Creation date: date when the MongoDB server was created, the initial point when the server entered Creating status
   • Running date: date when the MongoDB server started running, the initial point when the server entered Running status
   • ACG: ACG name and ID used in the MongoDB server
     • : click to move to Server > ACG
     • [View rules] button: click to display the detailed rules applied
   • DB engine version: information of the MongoDB version installed on the server
   • Cluster Type: type of the MongoDB cluster
   • Replica Set (Shard) Name: name of the replica set (shard)
   • VPC: VPC name used in the MongoDB server
   • Subnet: name of the subnet being used by the MongoDB server
   • Backup storage period (backup time): the configured backup file storage period and backup cycle, if the backup function is enabled
     • : click to enable or disable backup or set the file retention period and backup cycle

Creating MongoDB Server

To create a MongoDB server from the NAVER Cloud Platform console, follow these steps:

1. Click Services > Database > Cloud DB for MongoDB from the VPC environment of the NAVER Cloud Platform console, in order.

2. Click the DB server menu.

3. Click the [Create DB server] button.
   

4. When the service request page appears, proceed with the following steps in order.

   • 1. Set cluster
   • 2. Set server
   • 3. Set DB
   • 4. Final confirmation

1. Set cluster

To set the information for the MongoDB cluster to be installed, follow these steps:

1. When the Set cluster page appears, check the type of DBMS you want to install to the server from DBMS type.
   

2. Select the server generation.

3. Select the version of MongoDB you want to install.

4. Select the type of the MongoDB cluster.

   • Stand-alone: supports configuration for test and development environment
   • Single replica set: a Mongod process group that maintains the same data set and provides high availability
   • Sharding: a configuration that distributes the storage of data in multiple replica sets
   • The settings can't be changed after the creation of the MongoDB server

5. Set the rest of the items required for the creation of the MongoDB server.

   • DB server name: enter the name of the MongoDB server to create
     • The name must be 3-15 characters long and can only include Korean letters, English letters, numbers, and the hyphen (-)
     • A duplicated name can't be used
     • It is created with random text added to avoid a duplicated host name.
   • DB service name: enter the group name of the MongoDB server to be created
     • The name must be 3-15 characters long and can only include Korean letters, English letters, numbers, and the hyphen (-)
     • A duplicated name can't be used
   • VPC: select the VPC to be used for the creation of the server and MongoDB
     • [Refresh] button: click if you want to see the latest version of the created VPC list
     • [Create VPC] button: click if you don't have any VPCs that have been created and need to create one
   • Subnet: select a private subnet to be used when accessing VPC
     • [Create subnet] button: click if you want to see the latest version of the created subnet list
   • Data storage type: click to select the storage type for saving DB data, between SSD and HDD
     • The settings can't be changed after the creation of the MongoDB server
   • Data storage capacity: check the storage capacity for saving DB data
     • Upon initial creation of a MongoDB server, 10 GB is allocated
     • The capacity is automatically added in 10 GB units and charged as data increases
     • Up to 2000 GB is supported

6. Check the applicable pricing plan information when using Cloud DB for MongoDB.

   • Pricing plan: an hourly pricing plan, which is billed based on the hours used, is applied by default, and it is changed according to the server specifications and storage capacity
   • Click Pricing information for more information

7. Check the version and license information of MongoDB to be installed.

8. Specify the ACG settings for the MongoDB server access.

   • Access control group (ACG) is created automatically
   • The detailed settings for the ACG are available from Server > ACG in the console

9. Click the [Next] button.

2. Set server

To set the information for MongoDB server to be installed, follow these steps:

1. When the Set server page appears, set items needed for the creation of the MongoDB server.

   • If you've selected Stand-alone for the cluster type, then set the following items
     
     • Stand-alone Server Spec: select the specifications for the stand-alone server
     • port: enter the port number for the stand-alone server between 10000-65535
       • Default: 17017
       • The default MongoDB port number of 27017 is not recommended due to security vulnerabilities
   • If you've selected Single Replica Set for the cluster type, then set the following items
     
     • Number of members per replica set (primary & secondary): select the number of member servers in each shard (3 to 7 including the arbiter server)
     • Member server spec: select the specifications for the member servers
     • Number of arbiters per replica set: select the number of arbiter servers per shard (0-1 unit)
       • In clusters consisting of primary - secondary - arbiter, when there is a replication delay or failure in one secondary member, a request set as read concern: majority or write concern: { w: majority } will not respond (difficult to see the effect of server duplexing)
       • In clusters with primary - secondary - arbiter configuration, it is recommended to set read concern: local, write concern: { w: 1, j: true }
       • Avoid configuring primary - secondary - arbiter in the production environment
     • Arbiter server spec: select the specifications for the arbiter servers
     • port: enter the port number for each server between 10000-65535
       • Default: 17017
       • The default MongoDB port number of 27017 is not recommended due to security vulnerabilities
   • If you've selected Sharding for the cluster type, then set the following items
     
     • Number of members per replica set (primary & secondary): select the number of member servers in each shard (3 to 7 including the arbiter server)
     • Member server spec: select the specifications for the member servers
     • Number of arbiters per replica set: select the number of arbiter servers per shard (0-1 unit)
       • In clusters consisting of primary - secondary - arbiter, when there is a replication delay or failure in one secondary member, a request set as read concern: majority or write concern: { w: majority } will not respond (difficult to see the effect of server duplexing)
       • In clusters with primary - secondary - arbiter configuration, it is recommended to set read concern: local, write concern: { w: 1, j: true }
       • Avoid configuring primary - secondary - arbiter in the production environment
     • Arbiter server spec: select the specifications for the arbiter servers
     • Number of shards: select the number of shards
       • 2 or 3 can be selected upon initial installation
       • Up to 5 shards can be added in the management page after installation
       • If you need more than 5 shards, make an inquiry to Customer support
     • Number of mongos (router) servers: select the number of mongos servers (2-5 units)
     • Mongos server spec: select the specifications for the mongos servers
     • Number of config servers: check the number of config servers (3 fixed units)
     • Config server spec: select the specifications for the config servers
     • port: enter the port number for each server between 10000-65535
       • Default: 17017
       • The default MongoDB port number of 27017 is not recommended due to security vulnerabilities

2. Click the [Next] button.

3. Set DB

To set the information for the MongoDB to be installed, follow these steps:

1. When the Set DB page appears, set items needed for the creation of the MongoDB server.
   

   • USER_ID: enter the account ID of the MongoDB server admin

     • Enter 4 to 16 characters using English letters and numbers
     • It must start with an English letter
     • Predefined reserved words can't be used

   • USER password: enter the account password of the MongoDB server admin

     • The password must be 8-20 characters long and can only include English letters, numbers, and special characters, with at least 1 of each
     • The special characters ` & + \ " ' / or spaces can't be used

   • DB config settings: check the optimized basic settings provided by NAVER

   • DB data compress: select the data compression algorithm provided by MongoDB

     • Using the default value is recommended

   • Collect DB log: check the provision of log collection and viewer features for error logs and slow query logs

     • Cloud Log Analytics integration
2. Set whether to use the backup for the server to be created.
   • Backup file retention period: click and select the period to store the backup file in a separate backup storage
     • For point-in-time recovery, the backup file is stored for the maximum of set retention period + 24 hours.
   • Backup time: select the backup execution time
     • The backup is performed once a day at the specified time using mongodump provided by MongoDB
     • The backup is started every day within 15 minutes from the time specified by the user
     • If you select this, additional fees will be incurred according to the storage capacity used
3. Click the [Next] button.
4. When the Request subscription to Cloud Log Analytics appears, check the content, and then click the [OK] button.
   • If you need to request a subscription to Cloud Log Analytics, click the [Request subscription to Cloud Log Analytics] button
   • For more information on Cloud Log Analytics, see Cloud Log Analytics guide

4. Final confirmation

1. When the Final confirmation page appears, check the configured cluster information and server information.
   
   • Click the [Previous] button to edit the settings
2. Click the [Create] button.
3. Check the status of a MongoDB that was created from the MongoDB server list on the DB server page.
   • Creating: status in which the MongoDB server is being created with the information entered by the user
   • Configuring: status in which the MongoDB server is being configured after being created with the information entered by the user
   • Running: status in which the creation and configuration of the MongoDB server have been completed with the information entered by the user, and access to MongoDB from the application servers is available

Restarting MongoDB server

You can easily and conveniently restart MongoDB servers. You can't access servers while they're being restarted. To restart, follow these steps:

1. Click Services > Database > Cloud DB for MongoDB from the VPC environment of the NAVER Cloud Platform console, in order.
2. Click the DB server menu.
3. Click the MongoDB server you want to restart, and then click the [Restart] button.
4. When the Restart DB server pop-up window appears, check the name of the DB server to restart, and then click the [Yes] button.
5. Check the status of the MongoDB server from the MongoDB server list in the DB server page.
   • Stopping: status in which the MongoDB server is being stopped
   • Restarting: status in which the MongoDB server is being restarted

Deleting MongoDB server

You can delete a MongoDB server that has been created and is in operation. If you're using the replica set or sharding type clusters, then all of the clusters are deleted together. If you're using the backup feature, then the backup files are also deleted. To delete them, follow these steps:

1. Click Services > Database > Cloud DB for MongoDB from the VPC environment of the NAVER Cloud Platform console, in order.
2. Click the DB server menu.
3. Click the MongoDB server you want to delete and click the [Delete DB server] button.
4. When the Delete DB server pop-up window appears, enter the name of the DB server to delete, and then click the [Yes] button.
5. Check the status of the MongoDB server from the MongoDB server list in the DB server page.
   • Deleting: status in which the MongoDB server is being deleted

Monitoring MongoDB server

NAVER Cloud Platform's Cloud DB for MongoDB provides a monitoring service through the dashboards on each server. This allows you to intuitively check servers in operation and data status, and efficiently manage them.

To go to the monitoring page of the MongoDB server that has been created and is in operation, follow these steps:

1. Click Services > Database > Cloud DB for MongoDB from the VPC environment of the NAVER Cloud Platform console, in order.
2. Click the DB server menu.
3. Click the MongoDB server you want to monitor, and then click the [Monitoring] button.
4. Click and select the dashboard you want to monitor.
   

Manage MongoDB server

While operating the created MongoDB server, you may need to change the options of the server or DB configured upon creation. Cloud DB for MongoDB supports changes or upgrades of a certain number of specifications simply through a few clicks, even for MongoDB servers that have already been created.

To manage a MongoDB server that has been created and is in operation, follow these steps:

1. Click Services > Database > Cloud DB for MongoDB from the VPC environment of the NAVER Cloud Platform console, in order.
2. Click the MongoDB server menu.
3. Click the MongoDB server you want to manage, and then click the [Manage DB] button.
4. Click and select the item you want to manage.
   
   • Manage DB user
   • Manage admin user
   • Change secondary
   • Add shards
   • Change mongos
   • Change config server
   • Change DB specifications
   • Manage public domain
   • Primary DB Failover
   • MongoDB Engine Upgrade
   • Create DB access string

Manage DB user

Cloud DB for MongoDB provides a user management feature that enables you to conveniently add, edit, and delete user accounts that use the server. You can add 10 user accounts at each time of creation, change, or deletion.

To add, edit, and delete user accounts, follow these steps:

1. When the Manage DB user pop-up window appears, perform the required tasks for the user account.
   
   • Add user account: select Create, enter the information for USER_ID, database, DB permissions, and password, and then click the [Add DB user] button
   • Delete user account: select Change/Delete, and then click the [Delete] button in the same row as the user account to be deleted
   • Edit user account information: select the Change/Delete button in the same row as the user account to be modified, and then click the [Edit] button to edit, and click the [Save] button
2. Click the [Yes] button.
3. Check the status of a MongoDB for which you've set users from the MongoDB list in the DB server page.
   • Configuring: status in which the MongoDB server is being configured with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

Manage admin user

When creating a MongoDB server, the ID and password for the server admin account are created by default. However, while operating the server, you may need to reset the password of the admin account.

To change the password of the admin account, when the Admin User management pop-up window appears, enter the new password and click the [Yes] button.

Change secondary

You can change the member server configuration of the replica set (shard), including the config server.

To change a secondary server, follow these steps:

1. When the Change secondary (arbiter) pop-up window appears, check the number of current secondary (arbiter) servers.
2. Click and select the quantity you want to change to.
   
3. Click the [OK] button.
4. Check the status of MongoDB for which you changed the Secondary from the MongoDB list in the DB server page.
   • Creating: status in which the MongoDB server is being created with the information entered by the user
   • Configuring: status in which the MongoDB server is being configured with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

Add shards

You can add up to 5 shards within the MongoDB service.

To add shards, follow these steps:

1. When the Add shards pop-up window appears, check the current number of shards.
2. Click and select the number of shards you want to change to.
   
3. Click the [Yes] button.
4. Check the status of a MongoDB that added shards from the MongoDB server list in the DB server page.
   • Creating: status in which the MongoDB server is being created with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

Change mongos

You can change the number of mongos in the MongoDB service. The number of mongos can be configured from a minimum of 2 to a maximum of 5.

To change the number of mongos, follow these steps:

1. When the Change number of mongos pop-up window appears, check the current number of mongos servers.
2. Click and select the number of mongos servers you want to change to.
   
3. Click the [OK] button.
4. Check the status of a MongoDB for which you changed mongos count from the MongoDB list in the DB server page.
   • Creating: status in which the MongoDB server is being created with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

Change config server

You can change the number of config servers for the MongoDB service. The number of config servers can be from a minimum of 3 to a maximum of 7.

To change the number of config servers, follow these steps:

1. When the Change number of config servers pop-up window appears, check the number of config servers.
2. Click and select the quantity you want to change to.
   
3. Click the [OK] button.
4. Check the status of a MongoDB for which you changed the number of config servers from the MongoDB list in the DB server page.
   • Creating: status in which the MongoDB server is being created with the information entered by the user
   • Configuring: status in which the MongoDB server is being configured with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

Change DB specifications

You can change the server specifications for the MongoDB server you’ve created. Additional fees are incurred when applying specifications upgrades.

To change the specifications, follow these steps:

1. When the Change DB specifications pop-up window appears, check the current server specifications.
2. Click and select the server specifications you want to change to.
   
3. Click the [OK] button.
4. Check the status of a MongoDB for which you changed specifications from the MongoDB list in the DB server page.
   • Configuring: status in which the MongoDB server is being configured with the information entered by the user
   • Upgrading: status in which the MongoDB server is being upgraded with the information entered by the user
   • Downgrading: status in which the MongoDB server is being downgraded with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

Manage public domain

You can allocate or remove public domains required for external access to MongoDB servers.

1. When the Manage public domain or Remove public domain pop-up window appears, check the name of the DB server you'll allocate a public domain to or remove a domain from.
   
2. Click the [Yes] button.
3. Check the status of a MongoDB for which you allocated or removed a public domain from the MongoDB list in the DB server page.
   • Configuring: status in which the MongoDB server is being configured with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available
4. The editing of the host file is required for replica sets.
   Please refer to Creating DB access string.

Primary DB Failover

If the primary MongoDB server fails, then the user can directly use the failover feature to switch between the primary and secondary servers. During the process of the primary being elected again, the primary may not exist for several seconds or longer, which may have an effect on service.

To step down the primary server, follow these steps:

1. When the Primary DB failover pop-up window appears, check the selected server and the shard number.
   
2. Click the [Yes] button.
3. Check the MongoDB's DB role from the MongoDB list in the DB server page.
   • Configuring: status in which the MongoDB server is being configured with the information entered by the user
   • Running: status in which the configuration of the MongoDB server has been completed with the information entered by user, and access to MongoDB from the application servers is available

MongoDB Engine Upgrade

You can upgrade the version of MongoDB. The version upgrade is applied to the entire DB service.
In the case of that there is a Sharding Cluster, the upgrade proceeds one by one in the order of Config > Shard > Mongos.
All replica sets (replica set cluster, sharding cluster config, shard) are upgraded in the order of secondary/arbiter > primary.
During the upgrade, the target server access is not available, and when upgrading the primary server, it is switched to secondary to keep service access to a minimum.

1. Click DB management > Version upgrade.
2. Select the version to upgrade and click the [Yes] button.
3. If a major version upgrade is required, you can select a higher major version by checking [Major version upgrade].

For major version upgrades, configure the development environment in advance, and proceed with the application version compatibility review and function test sufficiently.
After a version upgrade, restoration to the previous version is not available.

Create DB access string

You can create a sample of a string required for external access to MongoDB servers.

To create an access string, follow these steps:

1. When the Create DB access string pop-up window appears, check the created string.
2. Edit the client's host file to access a replica set through a public domain.
   • You can access it using the access string after adding the viewed information to the hosts file.
   • If the replica set is not using a public domain, the hosts file information won't be viewed.
     
3. Click the [OK] button.