Note The Garoon 3 system is not available while backing up. You must use the same version of Garoon 3 to perform data backup and restoration.

Transcription

1 Maintenance Maintenance This chapter describes how to back up and restore data and how to migrate Garoon to another server, assuming that Garoon is installed in the following environment: Web server Windows: IIS 7 Linux: Apache. Installation identifier: cbgrn Install directory On Windows OS: C:\Program Files\Cybozu On Linux OS: /usr/local/cybozu/ Tip The following error is output in the results of slow query logs, but this error does not affect the operation of Garoon : [Warning] The syntax '--log_slow_queries' is deprecated and will be removed in MySQL 7.0. Please use '--slow_query_log'/'--slow_query_log_file' instead.. Backup and Restoration Backup and restoration of data can be performed by a user with "Administrator" privileges in a Windows environment or by a root user in a Linux environment. Note The Garoon system is not available while backing up. You must use the same version of Garoon to perform data backup and restoration. Backup Target Garoon can back up the following data in a MySQL database: On Windows OS: C:\Program Files\Cybozu\mysql-.0data C:\Program Files\Cybozu\mysql-.0files On Linux OS: /usr/local/cybozu/mysql-.0/data /usr/local/cybozu/mysql-.0/files Data in the database The following data is stored in the "data" directory: mysql: Data required for MySQL to operate, such as the database administrator's password cb_cbgrn: User information and other data used in Garoon applications such as Messages and Scheduler 88 Cybozu Garoon Administrator Guide

2 . Backup and Restoration Attachments These are the data stored in the "file" directory, including the files attached to messages and topics. Data in MySQL and attachments are linked. Careful planning is required for backup and restoration to avoid data discrepancies. Note Garoon uses InnoDB for MySQL tables. You cannot use mysqlhotcopy. Backup Method Data in MySQL can be backed up using operating system commands or mysqldump. Attachments can be backed up using operating system commands. Stop MySQL and Cybozu scheduling service when you use operating system commands. We recommend that you remove Garoon from the monitoring target till the task is complete, if you are monitoring operations of services and daemons. Tip You can use operating system commands for faster data backups. The following methods are available: Use storage software to back up difference of the data only. Use a snapshot function. mysqldump is installed at the same time as MySQL. Unused areas in the database are removed if you use mysqldump for backup. Therefore, restored data may occupy less area than before in some cases. Backup Mode Setting There may be data discrepancies observed between MySQL data and attachments since their backup methods are different. Database updates should be prohibited during backup in order to maintain the data consistency. You can configure Garoon to not allow database updates by turning on backup mode. The backup mode function is disabled by default. Modify the configuration file common.ini to enable the backup mode function. The location of the common.ini file and the required modifications are as follows: Location of the configuration file (CGI directory)/(installation identifier)/common.ini On Windows OS: C:\Inetpub\scripts\cbgrn\common.ini On Linux OS: /var/www/cgi-bin/cbgrn/common.ini Cybozu Garoon Administration Guide 89

3 Maintenance Required changes Delete part of the line describing "disable = """ under [BackupMode] as follows. Before deletion [BackupMode] disable = "" driver = "xxxxx" After deletion [BackupMode] driver = "xxxxx" Tip Execute a command from the command line to turn on or release backup mode. Users cannot use Garoon while backup mode is enabled. Restore the configuration file contents to the original state to disable backup mode. What is Cybozu scheduling service? Cybozu scheduling service regularly provides specified service at a scheduled time. For example, the scheduling service automatically deletes unnecessary files from Garoon or retrieves weather data at the time specified in the "sched.ini" file. The date and time of the Garoon server are applied to the scheduling service. The scheduling service is performed according to the time zone, date and time of the Garoon server. Note You must first stop the scheduling service before stopping the database engine. You must first start the database engine before starting the scheduling service. Cybozu scheduling service and Cybozu database engine must be stopped or started by the following users: For Windows OS: Users with "Administrator" accounts For Linux OS: Users with "root" user accounts.. Backing Up with OS Commands This part describes how to copy a directory to back up data using operating system commands. Backing up in Windows Environment You can create a backup directory and back up the data using the following procedure: C:\backup\YYYYMMDD To back up data using OS commands: 90 Stop the scheduling service, then the database engine. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and stop the following services: Cybozu Garoon Administrator Guide

4 . Backup and Restoration Cybozu_Scheduling_Service_cbgrn Cybozu_Database_Engine 0 : "cbgrn" may be replaced by your installation identifier. Launch the command prompt. Create a backup directory under the current directory. mkdir C:\backup\YYYYMMDD Copy the "data" directory and the "files" directory to the directory created in the step. xcopy "C:\Program Files\Cybozu\mysql-.0\data" C:\backup\YYYYMMDD\data /E /I xcopy "C:\Program Files\Cybozu\mysql-.0\files" C:\backup\YYYYMMDD\files /E /I If you copy to an existing directory, a message is displayed to confirm whether or not to overwrite the data. Enter "Yes" or "All" to overwrite, or "No" to cancel. Start the database engine, then the scheduling service. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and start the following services: Cybozu_Database_Engine 0 Cybozu_Scheduling_Service_cbgrn Check that Garoon can be accessed without any problems. Backing up in Linux Environment You can create a backup directory and back up the data using the following procedure: /backup/yyyymmdd To back up data using OS commands: Launch the command prompt. /etc/init.d/cyss_cbgrn stop /etc/init.d/cyde 0 stop : "cbgrn" may be replaced by your installation identifier. Stop the scheduling service, then the database engine. Create a backup directory. mkdir -p /backup/yyyymmdd Copy the "data" directory and "files" directory to the directory created in the step. cp -rp /usr/local/cybozu/mysql-.0/data /backup/yyyymmdd/ Cybozu Garoon Administration Guide 9

5 Maintenance cp -rp /usr/local/cybozu/mysql-.0/files /backup/yyyymmdd/ Start the database engine, then the scheduling service. /etc/init.d/cyss_cbgrn start /etc/init.d/cyde 0 start Check that Garoon can be accessed without any problems... Restoring with OS Commands This part describes how to restore the copied data using operating system commands. Restoring in Windows Environment You can restore the data stored in a backup directory using the following procedure: C:\backup\YYYYMMDD To restore data using OS commands: Stop the scheduling service, then the database engine. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and stop the following services: Cybozu_Scheduling_Service_cbgrn Cybozu_Database_Engine 0 : "cbgrn" may be replaced by your installation identifier. Launch the command prompt. Delete the existing database area and attachments area. rmdir /s /q "C:\Program Files\Cybozu\mysql-.0\data" rmdir /s /q "C:\Program Files\Cybozu\mysql-.0\files" Copy the backup data to the original directory. xcopy C:\backup\YYYYMMDD\data "C:\Program Files\Cybozu\mysql-.0\data" /E /I xcopy C:\backup\YYYYMMDD\files "C:\Program Files\Cybozu\mysql-.0\files" /E /I Start the database engine, then the scheduling service. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and start the following services: Cybozu_Database_Engine 0 Cybozu_Scheduling_Service_cbgrn 9 Cybozu Garoon Administrator Guide

6 . Backup and Restoration Check that Garoon can be accessed without any problems. Restoring in Linux Environment You can restore the data stored in a backup directory using the following procedure: /backup/yyyymmdd To restore data using OS commands: Stop the scheduling service, then the database engine. /etc/init.d/cyss_cbgrn stop /etc/init.d/cyde 0 stop : "cbgrn" may be replaced by your installation identifier. Delete the existing database area and attachments area. rm -rf /usr/local/cybozu/mysql-.0/data rm -rf /usr/local/cybozu/mysql-.0/files Copy the backup data to the original directory. cp -rp /backup/yyyymmdd/data /usr/local/cybozu/mysql-.0/ cp -rp /backup/yyyymmdd/files /usr/local/cybozu/mysql-.0/ Start the database engine, then the scheduling service. /etc/init.d/cyss_cbgrn start /etc/init.d/cyde 0 start Check that Garoon can be accessed without any problems. Tip The database engine may not start in some cases due to a change in the directory privileges after the restoration. In such cases, use the chown command to grant read and write privileges for the MySQL data area to CGI users such as apache. Cybozu Garoon Administration Guide 9

7 Maintenance.. Backing up with mysqldump You must perform the backup during the period when users do not access Garoon. This part describes how to back up data by executing mysqldump in backup mode. See the following section for backup mode: "Backup Method" on page 89. Notes on the use of mysqldump The MySQL tables (privilege database) may be lost due to disk corruption or system failures. If you cannot import the data backed up with dump due to the damaged MySQL tables, the data can be restored using the following procedure: To restore the dump data: Install Garoon as a new installation. Back up the data of Garoon installed in the step using operating system commands. See ".. Backing Up with OS Commands" on page 90. Restore the data backed up in the step using operating system commands. See ".. Restoring with OS Commands" on page 9. Restore the dump data using mysqldump. See ".. Backing up with mysqldump" on page 9. Speed of mysqldump If you use mysqldump, the backup and restoration process may take a long time to complete depending on the data size. Restoration takes longer than backup. Restoration with mysqldump takes longer than restoration with operating system commands. Disk space after restoration The data after restoration with mysqldump may occupy less area than the data before backup. This is because unused areas are removed when the data is backed up, but not because the data is lost. 9 Cybozu Garoon Administrator Guide

8 . Backup and Restoration Backing up in Windows Environment You can create a backup directory and back up the data using the following procedure: C:\backup\YYYYMMDD Tip Modify the Garoon configuration in advance to enable backup mode. "Backup Method" on page 89. To back up data using mysqldump: Launch the command prompt. Create a backup directory. mkdir C:\backup\YYYYMMDD Stop the scheduling service. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and stop the following service: Cybozu_Scheduling_Service_cbgrn : "cbgrn" may be replaced by your installation identifier. Set Garoon to backup mode. cd C:\Inetpub\scripts\cbgrn grn_command.exe -f.\code\command\backupmode_start.csp Execute mysqldump as a database administrator. "C:\Program Files\Cybozu\mysql-.0\bin\mysqldump" --defaults-file="c:\program Files\Cybozu\mysql-.0\etc\my.ini" --all-databases --single-transaction -u cbroot p > C:\backup\YYYYMMDD\full.sql 7 8 Enter the database administrator's password. Back up the attachments. xcopy "C:\Program Files\Cybozu\mysql-.0\files" C:\backup\YYYYMMDD\files /E /I Release backup mode. cd C:\Inetpub\scripts\cbgrn grn_command.exe -f.\code\command\backupmode_end.csp 9 Start the scheduling service. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and start Cybozu Garoon Administration Guide 9

9 Maintenance the following service: Cybozu_Scheduling_Service_cbgrn 0 Check that Garoon can be accessed without any problems. Backing up in Linux Environment You can create a backup directory and back up the data using the following procedure: /backup/yyyymmdd Tip Modify the Garoon configuration in advance to enable backup mode. "Backup Method" on page 89. To back up data using mysqldump: Create a backup directory. mkdir -p /backup/yyyymmdd Stop the scheduling service. /etc/init.d/cyss_cbgrn stop : "cbgrn" may be replaced by your installation identifier. Turn on backup mode. cd /var/www/cgi-bin/cbgrn./grn_command -f./code/command/backupmode_start.csp Execute mysqldump as a database administrator. /usr/local/cybozu/mysql-.0/bin/mysqldump --defaults-file=/usr/local/cybozu/mysql-.0/etc/my.ini --all-databases --single-transaction -u cbroot -p > /backup/yyyymmdd/full.sql 7 Enter the database administrator's password. Back up the attachments. cp -rp /usr/local/cybozu/mysql-.0/files /backup/yyyymmdd/ Release backup mode. cd /var/www/cgi-bin/cbgrn./grn_command -f./code/command/backupmode_end.csp 8 Start the scheduling service. /etc/init.d/cyss_cbgrn start 9 Cybozu Garoon Administrator Guide

10 . Backup and Restoration 9 Check that Garoon can be accessed without any problems... Restoring with mysqldump This part describes how to restore the backup data and attachments using mysqldump. You must perform the restoration during the period when users do not access Garoon. Restoring in Windows Environment You can restore the data stored in a backup directory using the following procedure: C:\backup\YYYYMMDD To restore data using mysqldump: 7 8 Launch the command prompt. Stop the scheduling service. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and stop the following service: Cybozu_Scheduling_Service_cbgrn : "cbgrn" may be replaced by your installation identifier. Set Garoon to backup mode. cd C:\Inetpub\scripts\cbgrn grn_command.exe -f.\code\command\backupmode_start.csp Import the backup data as a database administrator. "C:\Program Files\Cybozu\mysql-.0\bin\mysql" --defaults-file="c:\program Files\Cybozu\mysql-.0\etc\my.ini" -u cbroot -p < C:\backup\YYYYMMDD\full.sql Enter the database administrator's password. Delete the existing attachments area. rmdir /s /q "C:\Program Files\Cybozu\mysql-.0\files" Restore the attachments. xcopy C:\backup\YYYYMMDD\files "C:\Program Files\Cybozu\mysql-.0\files" /E /I Release backup mode. cd C:\Inetpub\scripts\cbgrn grn_command.exe -f.\code\command\backupmode_end.csp Cybozu Garoon Administration Guide 97

11 Maintenance 9 Start the scheduling service. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and start the following service: Cybozu_Scheduling_Service_cbgrn 0 Check that Garoon can be accessed without any problems. Restoring in Linux Environment You can restore the data stored in a backup directory using the following procedure: /backup/yyyymmdd To restore data using mysqldump: Stop the scheduling service. /etc/init.d/cyss_cbgrn stop : "cbgrn" may be replaced by your installation identifier. Set Garoon to backup mode. cd /var/www/cgi-bin/cbgrn./grn_command -f./code/command/backupmode_start.csp Import the backup data as a database administrator. /usr/local/cybozu/mysql-.0/bin/mysql --defaults-file=/usr/local/cybozu/mysql-.0/etc/my.ini -u cbroot -p < /backup/yyyymmdd/full.sql 7 Enter the database administrator's password. Delete the existing attachments area. rm -rf /usr/local/cybozu/mysql-.0/files Restore the attachments. cp -rp /backup/yyyymmdd/files /usr/local/cybozu/mysql-.0/ Release backup mode. cd /var/www/cgi-bin/cbgrn./grn_command -f./code/command/backupmode_end.csp 8 Start the scheduling service. /etc/init.d/cyss_cbgrn start 98 Cybozu Garoon Administrator Guide

12 . Migrating Between Servers 9 Check that Garoon can be accessed without any problems. Tip The database engine may not start in some cases due to a change in the directory privileges after the restoration. In such cases, use the chown command to grant read and write privileges for the MySQL data area to CGI users such as apache.. Migrating Between Servers This section describes how to migrate an operating Garoon to another server. A server migration must be performed by a user with "Administrator" privileges in a Windows environment or by a root user in a Linux environment. When you migrate data between servers, the following information must be identical in the source server and the destination server: Garoon version Installation identifier Database user passwords Tip The installation identifier can be found in "app_name" in the "[Global]" section in the "common.ini" file... Migrating between -bit OSs or -bit OSs Garoon can be migrated by copying the data to the destination server, if you migrate data between the same types of servers: for example between -bit operating systems or -bit operating systems. This part describes how to migrate from a server in a Windows environment to a server in a Linux environment. To migrate between servers with the same operating systems: Back up the data in Garoon in a Windows environment. See ".. Backing Up with OS Commands" on page 90. Install and initialize Garoon in a Linux environment. Use the same installation identifier and database user password as the source server. The Administrator password is optional. The password in the source server will be set to the destination server when the migration is complete. Tip: Garoon will use the language and time zone specified during initialization as default. You cannot change either the default language or the default time zone once Garoon is initialized. Stop the scheduling service, then database engine in the Linux environment. /etc/init.d/cyss_cbgrn stop /etc/init.d/cyde 0 stop : "cbgrn" may be replaced by your installation identifier. Cybozu Garoon Administration Guide 99

13 Maintenance 7 Copy the data in the Windows environment to the Linux environment. See ".. Restoring with OS Commands" on page 9. Configure the permissions and the owner of the data area in the Linux environment. chmod -R 7 data chmod -R 700 files chown -R apache:root data files Start the database engine, then the scheduling service in the Linux environment. /etc/init.d/cyde 0 start /etc/init.d/cyss_cbgrn start Check that Garoon can be accessed without any problems... Migrating from -bit OS to -bit OS Garoon can be migrated by overwriting the database using mysqldump, if you migrate data between different types of servers: for example, from a -bit operating system to a -bit operating system, or from a -bit operating system to a -bit operating system. Migrating to Windows Environment To migrate to a Windows environment: 00 On the source server, back up the data in Garoon using mysqldump. ".. Backing up with mysqldump" on page 9. Install and initialize Garoon on the destination server. Use the same installation identifier and database user password as the source server. The Administrator password is optional. The password in the source server will be set to the destination server when the migration is complete. Tip: Garoon will use the language and time zone specified during initialization as default. You cannot change either the default language or the default time zone once Garoon is initialized. Stop the scheduling service on the destination server. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and stop the following services Cybozu_Scheduling_Service_cbgrn : "cbgrn" may be replaced by your installation identifier. Launch the command prompt. Delete the existing attachments area. Cybozu Garoon Administrator Guide

14 . Migrating Between Servers rmdir /s /q "C:\Program Files\Cybozu\mysql-.0\files" Import the backup data from the source server to the destination server as a database administrator. When the backup data is "C:\backup\YYYYMMDD\full.sql" "C:\Program Files\Cybozu\mysql-.0\bin\mysql" --defaults-file="c:\program Files\Cybozu\mysql-.0\etc\my.ini" -u cbroot -p < C:\backup\YYYYMMDD\full.sql 7 8 Enter the database administrator's password. Copy the attachments from the source server to the destination server. When the backup data is "C:\backup\YYYYMMDD\files" xcopy C:\backup\YYYYMMDD\files "C:\Program Files\Cybozu\mysql-.0\files" /E /I 9 0 Press the Enter key. Start the scheduling service on the destination server. From the Windows Start menu, select Control Panel > Administrative Tools > Service, and start the following services: Cybozu_Scheduling_Service_cbgrn Check that Garoon can be accessed without any problems. Migrating to Linux Environment To migrate to a Linux environment: On the source server, back up the data in Garoon using mysqldump. ".. Backing up with mysqldump" on page 9. Install and initialize Garoon on the destination server. Use the same installation identifier and database user password as the source server. The Administrator password is optional. The password in the source server will be set to the destination server when the migration is complete. Tip: Garoon will use the language and time zone specified during initialization as default. You cannot change either the default language or the default time zone once Garoon is initialized. Stop the scheduling service on the destination server. /etc/init.d/cyss_cbgrn stop : "cbgrn" may be replaced by your installation identifier. Delete the existing attachments area. rm -rf /usr/local/cybozu/mysql-.0/files Cybozu Garoon Administration Guide 0

15 Maintenance Import the backup data from the source server to the destination server as a database administrator. When the backup data is "/backup/yyyymmdd/full.sql" /usr/local/cybozu/mysql-.0/bin/mysql --defaults-file=/usr/local/cybozu/mysql-.0/etc/my.ini -u cbroot -p < /backup/yyyymmdd/full.sql 7 Enter the database administrator's password. Copy the attachments from the source server to the destination server. When the backup data is "/backup/yyyymmdd/files" cp -rp /backup/yyyymmdd/files /usr/local/cybozu/mysql-.0/ 8 Configure the permissions and the owner of the data area. chmod -R 700 files chown -R apache:root data files 9 0 Start the scheduling service on the destination server. /etc/init.d/cyss_cbgrn start Check that Garoon can be accessed without any problems.. Resetting Administrator Passwords If you forget or lose Garoon administrator password, you must reset the password from the command line. This section describes how to reset the password, assuming that Garoon is installed in the following environment: Install identifier: cbgrn Install directory On Windows OS: C:\Inetpub\scripts On Linux OS: /var/www/cgi-bin Resetting a password in Windows environment To reset a password in a Windows environment: Launch the command prompt. Proceed to the CGI directory. cd C:\Inetpub\scripts\cbgrn Execute "set_admin_password.csp". grn_command.exe -f.\code\command\set_admin_password.csp 0 Cybozu Garoon Administrator Guide

16 . Resetting Administrator Passwords Enter "yes" and press the Enter key. Enter a new password and press the Enter key. Enter a confirmation password and press the Enter key. Resetting a password in Linux environment To reset a password in a Linux environment: Proceed to the CGI directory. cd /var/www/cgi-bin/cbgrn Execute "set_admin_password.csp"../grn_command -f./code/command/set_admin_password.csp Enter "yes" and press the Enter key. Enter a new password and press the Enter key. Enter a confirmation password and press the Enter key. Cybozu Garoon Administration Guide 0