Deploy seekdb

Execute the obd seekdb install command to start the interactive deployment process. In the interactive installation process, configure the following parameters.

1. Select the installation mode

   Currently, three installation modes are supported: Standalone (single-node mode), Primary (primary instance mode), and Standby (standby instance mode).

   Standalone mode

   Primary instance mode

   Standby instance mode

   By default, the standalone mode is used to deploy seekdb if no options are specified.

   obd seekdb install
   

   After the command is executed, configure the following parameters for the seekdb instance:

   #Set the deployment name, which must be unique.
   Instance name [myseekdb]:
   #Enter the IP address of the machine where seekdb is to be installed. The default value is the IP address of the local machine.
   Server IP [10.10.10.1]:
   #Select the user for deployment. The default value is the current user.
   Username [admin]:
   #Set the SSH port. The default value is 22.
   SSH port [22]:
   #Enter the password of the user for deployment. The default value is empty.
   #This parameter is displayed only in non-local deployment. If you have configured password-free login, you can directly press Enter to skip this parameter.
   Password (default empty):
   #Set the installation directory of seekdb. The user specified for deployment must have read and write permissions on the directory.
   Seekdb installation directory [/home/admin/myseekdb]:
   #Set the directory for storing data such as SSTables. The user specified for deployment must have read and write permissions on the directory.
   Data directory (data_dir, optional) [/data/1]:
   #Set the directory for storing logs. The user specified for deployment must have read and write permissions on the directory.
   Redo log directory (redo_dir, optional) [/data/log1]:
   #Set the SQL port of seekdb.
   MySQL port [2881]:
   #Set the OBShell port of seekdb.
   OBShell port [2886]:
   #Specify whether to enable the automatic startup of the Seekdb service when the system boots up. The default value is no.
   #This parameter is displayed only in non-container environments. If you enable the automatic startup, make sure that the deployment user has sudo privileges. Otherwise, the deployment will fail.
   Do you want to enable the SEEK_DB_PLACEHOLDER_e6110f5f070a454dbf790bce2bff984d service to start automatically when the system boots up? (y/yes or n/no) [no]:
   

   You can specify the --primary option to deploy seekdb in the primary instance mode. When you deploy in the primary instance mode, you must configure the RPC port and enable the RPC feature to allow the standby instance to synchronize information.

   obd seekdb install --primary
   

   After the command is executed, configure the following parameters for the seekdb instance:

   #Set the deployment name, which must be unique.
   Instance name [myseekdb_primary]:
   #Enter the IP address of the machine where seekdb is to be installed. The default value is the IP address of the local machine.
   Server IP [10.10.10.1]:
   #Select the user for deployment. The default value is the current user.
   Username [admin]:
   #Set the SSH port. The default value is 22.
   SSH port [22]:
   #Enter the password of the user for deployment. The default value is empty.
   #This parameter is displayed only in non-local deployment. If you have configured password-free login, you can directly press Enter to skip this parameter.
   Password (default empty):
   #Set the installation directory of seekdb. The user specified for deployment must have read and write permissions on the directory.
   Seekdb installation directory [/home/admin/myseekdb_primary]:
   #Set the directory for storing data such as SSTables. The user specified for deployment must have read and write permissions on the directory.
   Data directory (data_dir, optional) [/data/1]:
   #Set the directory for storing logs. The user specified for deployment must have read and write permissions on the directory.
   Redo log directory (redo_dir, optional) [/data/log1]:
   #Set the SQL port of seekdb.
   MySQL port [2881]:
   #Set the RPC port of seekdb.
   RPC port [2882]:
   #Set the OBShell port of seekdb.
   OBShell port [2886]:
   #Specify whether to enable the automatic startup of the Seekdb service when the system boots up. The default value is no.
   #This parameter is displayed only in non-container environments. If you enable the automatic startup, make sure that the deployment user has sudo privileges. Otherwise, the deployment will fail.
   Do you want to enable the SEEK_DB_PLACEHOLDER_9755b1609a8743bbab80b55b63cc159d service to start automatically when the system boots up? (y/yes or n/no) [no]:
   

   You can use the --standby option to deploy the instance in standby mode. When deploying in standby mode, you must configure the information of the primary instance, that is, the instance with the identifier seekdb.

   obd seekdb install --standby
   

   After you execute the preceding command, configure the information of the instance with the identifier seekdb as described in the following example:

   # Set the deployment name. The deployment name must be unique.
   Instance name [myseekdb_standby]:
   # Select the primary instance with the identifier seekdb. If multiple instances with the identifier seekdb exist, you can use the up and down arrow keys to select one.
   ┌────────────────────────────┐
   │   Select primary cluster   │
   ├────────────────────────────┤
   │  ▸  myseekdb_primary       │
   └────────────────────────────┘
     ↑↓ move   Enter confirm   q quit
   Connect to primary (10.10.10.1:2881) ok
   # If the RPC feature is not enabled for the selected primary instance, a warning message is displayed, and an optional solution is provided.
   [WARN] Primary enable_rpc_service is not enabled.
   # You can use the up and down arrow keys to select Modify primary instance configuration and restart (Restart now) to modify the primary instance configuration and restart it, or Exit to exit the deployment process without modifying the configuration.
   ┌─────────────────────────────────────────────────────────────────────────┐
   │                              Choose action                              │
   ├─────────────────────────────────────────────────────────────────────────┤
   │  ▸  Restart now (enable in config, then stop and start primary cluster) │
   │  ○  Exit (exit without changing config)                                 │
   └─────────────────────────────────────────────────────────────────────────┘
     ↑↓ move   Enter confirm   q quit
   # To restart the primary instance, you must enter y. Otherwise, the preceding selection is repeated.
   # Restarting the primary instance may affect the running business. Proceed with caution.
   Restarting the primary instance may affect the running business. Do you want to restart it? (y/yes or n/no) [no]:
   # Enter the IP address of the server where you want to install the instance with the identifier seekdb. By default, the IP address of the current server is used.
   Server IP [10.10.10.1]:
   # Select the user for deployment. By default, the current user is used.
   Username [admin]:
   # Set the SSH port. By default, the port is 22.
   SSH port [22]:
   # Enter the password of the user for deployment. By default, the password is empty.
   # This field is displayed only when the instance is deployed on a server other than the local server. If you have configured password-free login, you can press Enter to skip this step.
   Password (default empty):
   # Set the installation directory of the instance with the identifier seekdb. Make sure that the configured user has read and write permissions for the directory.
   Seekdb installation directory [/home/admin/myseekdb_standby]:
   # Set the directory for storing data such as SSTables. Make sure that the configured user has read and write permissions for the directory.
   Data directory (data_dir, optional) [/data/1]:
   # Set the directory for storing logs. Make sure that the configured user has read and write permissions for the directory.
   Redo log directory (redo_dir, optional) [/data/log1]:
   # Set the SQL port of the instance with the identifier seekdb.
   MySQL port [2881]:
   # Set the RPC port of the instance with the identifier seekdb.
   RPC port [2882]:
   # Set the OBShell port of the instance with the identifier seekdb.
   OBShell port [2886]:
   # Specify whether to enable the automatic startup feature. By default, this feature is disabled.
   # This field is displayed only when the instance is deployed on a server other than the local server. If you want to enable the automatic startup feature, make sure that the deployment user has the sudo permission. Otherwise, an error is returned.
   Do you want to enable the Seekdb service to start automatically when the system boots up? (y/yes or n/no) [no]:
   

2. Select the deployment mode.

   ┌───────────────────────┐
   │      Select mode      │
   ├───────────────────────┤
   │  ○  Dev (development) │
   │  ▸  Prod (production) ││
   └───────────────────────┘
     ↑↓ move   Enter confirm   q quit
   

   If you select Dev mode, the system directly outputs the configuration information. After you confirm the configuration information, the deployment starts. This mode uses fewer resources. If you select Prod mode, you must set the maximum memory value of the instance with the identifier seekdb and select a memory strategy.

   # Set the maximum memory value for seekdb. obd will generate a value range and default value based on the resources of the seekdb node.
   SeekDB Max Memory (Configurable Range[5, 31], unit: G) [28]:
   # Use the up and down arrow keys to select the memory strategy.
   ┌──────────────────────────────────────────────────────────┐
   │                     Memory strategy                      │
   ├──────────────────────────────────────────────────────────┤
   │  ▸  Balanced (Reduce memory usage when possible)         │
   │  ○  Performance (Use more memory to enhance performance) │
   └──────────────────────────────────────────────────────────┘
     ↑↓ move   Enter confirm   q quit
   

3. Confirm the configuration

   After completing the above configuration, the program will display the configuration you just set. You need to confirm whether these configurations are correct. Here is an example:

   --- Config summary ---
     1. IP = 10.10.10.1
     2. User = admin
     3. ssh_port = 22
     4. home_path = /home/admin/myseekdb_primary
     5. data_dir = /data/1
     6. redo_dir = /data/log1
     7. mysql_port = 2881
     8. rpc_port = 2882
     9. obshell_port = 2886
     10. memory_limit = 15G
     11. memory_hard_limit = 28G
     12. datafile_size = 147G
     13. max_syslog_file_count = 1024
     14. log_disk_size = 46G
     15. auto_start = False
   Confirm config? (y/yes or n/no to modify) [yes]:
   

   Note

   • In the primary instance deployment mode, if the memory_limit value is less than 6 GB, the following warning will be displayed: memory_limit is below 6G. For a primary cluster this is small; standby sync may be slow. Consider 6G or more if you plan heavy replication..
   • When creating a standby instance, the log_disk_size of the corresponding primary instance must be at least three times the value of max(primary memory_limit, standby memory_limit). If it is less than this value, obd will automatically update the log_disk_size of the primary instance.

   You need to enter y or n at the confirmation prompt: If you enter y, the program will start deploying seekdb based on the configuration; if you enter n, you need to select the configuration to modify and set a new value. After setting the new value, all configurations will be displayed again for your confirmation. Here is an example, selecting to modify the redo_dir configuration:

   ┌───────────────────────────┐
   │    Select item to edit    │
   ├───────────────────────────┤
   │  ○  IP                    │
   │  ○  User                  │
   │  ○  ssh_port              │
   │  ○  home_path             │
   │  ○  data_dir              │
   │  ▸  redo_dir              │
   │  ○  mysql_port            │
   │  ○  rpc_port              │
   │  ○  obshell_port          │
   │  ○  memory_limit          │
   │  ○  memory_hard_limit     │
   │  ○  datafile_maxsize      │
   │  ○  max_syslog_file_count │
   │  ○  log_disk_size         │
   │  ○  auto_start            │
   └───────────────────────────┘
     ↑↓ move   Enter confirm   q back
   # Set a new value for redo_log.
   New value (current: /data/log1) [/data/log1]: /data/log2
     Updated redo_dir = /data/log2
   

4. Deployment successful

   After the deployment of seekdb is successful, the program will display the deployment status of the instance and the corresponding connection string. The specific information is as follows:

   Start seekdb ok
   seekdb program health check ok
   Connect to seekdb 10.10.10.1:2881 ok
   obshell start ok
   obshell program health check ok
   obshell bootstrap ok
   Check RPC TLS status ok
   Connect to seekdb 10.10.10.1:2881 ok
   Wait for seekdb init ok
   +--------------------------------+
   |             seekdb             |
   +---------------+---------+------+
   | ip            | version | port |
   +---------------+---------+------+
   | 10.10.10.1    | 1.2.0.0 | 2881 |
   +---------------+---------+------+
   obclient -h10.10.10.1 -P2881 -uroot -p'********' -Doceanbase -A
   myseekdb_primary running