BRU Server 1.2
QuickStart Guide for Mac OS X
 
Installation Under OS X
 
Graphical Installation
 
The standard installation method for OS X is to use the normal package installer from within the Finder™.  Simply double-click the packages to install each.  BRU Server 1.2 packages must be installed in the following order and the following rules still apply for where you install each package:
 
Server Component: Install this component onto the system that will be performing the actual backups - either to tape drives or Stage volumes.
 
Agent Component: Install this onto any system that will be backed up by the server system.  This includes the server system if it will be included in the backups.
 
Console Component: The Console is the backup administrator's eyes and ears to the BRU Server environment.  The console may be installed onto any compatible system (graphical, text-based, and command line versions are available) that the administrator may wish to use for controlling the BRU Server environment.  Additionally, there are no installation license restrictions on the Console, so you may install it on as many systems as you require to manage your BRU Server environment.
 
Headless Command Line Installation
 
BRU Server's installation process supports installation with the "installer" command line tool.  Once you have the packages copied to the remote system (such as a headless Xserve system), use ssh to login to the system and then install the packages using the following syntax:
 
sudo installer -pkg "package name.pkg" -target "/"
 
Replace "package name.pkg" with the appropriate BRU Server component package - note that the quote marks around the package name are required as the packages have spaces in their names.
 
You may also install all BRU Server component packages under OS X using Apple Remote Desktop.
 
Once the packages are installed, starting with version 1.2.0 we now install a symbolic link from the actual application installation within the /Applications folder to /usr/local/bru-server.  This provides command-line compatibility with the other Unix platforms.
 
Updating From Version 1.1.5 or Earlier
 
This update for BRU Server will properly update a 1.1.5 server version.  All settings, jobs, schedules, and users are retained during the update.
 
Please note that it is required that you update ALL client systems to the 1.2.0 Agent when you update the Server.  Version 1.1.5 and earlier are not compatible with 1.2.0 and failure to update will cause the backups to fail.
 
If you do wish to make copies of the BRU Server server environment, please refer to Appendix C in the BRU Server 1.2.0 Admin Guide.
Initial OS X Configuration
 
You may configure the BRU Server components graphically or via command line.  In either case, you must configure the server component prior to configuring any agent components.
 
Because the BRU Server daemons (server and agent) MUST have full root authorization while running, you must perform the configuration steps as a user with administration rights on the machine where the configuration is occurring.
 
Graphical Server Configuration
 
Open your Applications Folder
If you have a Tape Library, ensure at least one data tape is inserted into slot one (1) of the library.  Slot one (1) must not contain a cleaning tape as this will cause the hardware scan to fail.
Start the "BRU Server Config Tool" application
Authenticate as your system administrator (not the same as the BRU Server "admin" account)
 
 
Server Configuration - Hardware Scan
Initially, the config tool will scan your system for compatible tape drives and libraries.  Once this scan completes, you will be asked to assign a BRU Server "admin" user password.  For security reasons, this password should not be the same as your system administration password.  The BRU Server "admin" user is a self-contained user that does not equate to any other user on your system.  Do not confuse our use of the term "admin" with the System Administrator.
 
 
Server Configuration - Password Entry
Once the password is assigned, the server daemon will be started.
 
If you wish to have the BRU Server server daemon started at boot, simply click the  "Auto" button to remove the daemon from the Startup Items and set server startup to manual.
 
Adding a Primary License
 
If you have a license, click the "Add License" button and you will see the license panel.  Enter the information as it is provided on the license information card received with your BRU Server package.  Since this will be your primary server license, DO NOT check the "Additional Clients" checkbox (you may add additional clients later).
 
 
Server Configuration - Add License Information
Adding an Additional Clients License
 
If you received an Additional Client License, enter your main license information as outlined above and the click the Add License button once more.  With the license info for the Additional Clients, you will see 2 serial numbers listed.  The Serial Number and the Primary Serial Number.  The Serial Number entry is the serial number for the additional clients.  The Primary Serial Number entry is the serial number for the server to which these clients are being added.  This Primary Serial Number MUST match the server serial number that you entered previously.
 
 
Server Configuration – Additional Clients
Click the Additional Clients checkbox and the license panel will change as shown above.  Be careful to enter the appropriate serial number into the appropriate field before you save the entries.
 
Once the Password and License information have been properly added, you are now ready to configure any client systems.
 
 
Server Configuration - Configuration Complete
 
Command Line Server Configuration
 
Connect to your server system via ssh or open the Terminal.
Execute the following commands and respond to the prompts:
 
 
sudo -s
cd /usr/local/bru-server
./server --kill
./server --passwd
        (Enter your new BRU Server "admin" Password – will not be echoed)
./server
 
The BRU Server server daemon will start as a background process.  To check the status, you may monitor the server log file using the "tail" command:
 
tail -f /var/log/server_log
 
Your output should look something like:
 
Oct 13 08:47:55 Configuration signature same as saved configuration
Oct 13 08:47:55 Listening on port 14441
Oct 13 08:47:55 Bound socket
Oct 13 08:48:05 Starting system housekeeping
Oct 13 08:48:05 Cleaning catalog directory
Oct 13 08:48:05 Stage directory '/Applications/BRU Server Config Tool.app/Contents/MacOS/stage' not found
Oct 13 08:49:34 Accepted new connection from 192.168.1.7:60524
Oct 13 08:49:34 Authenticated user admin from 192.168.1.7:60524
 
To exit the tail function, type CTRL-C.
 
Graphical Agent Configuration
 
Open your Applications Folder
Start the "BRU Server Agent Config Tool" application
Authenticate as your system administrator
 
 
Agent Configuration - Main Window
For any BRU Server server to provide backup services for a client system, that client system must contact and authenticate with the appropriate server system.  To authorize and authenticate a server, click the "New" button.
 
 
Agent Configuration – Add a New Server
You will then be prompted to enter the server name and admin password information (shown above).  The password is the BRU Server admin password that you assigned when you configured the server system.  The Server name or IPv4 address may be an internal short hostname, a fully qualified domain name, or a standard dot-notation IPv4 address.  You may authorize multiple servers to provide backup services for a single client system.  Once the server is authorized, the Agent Config Tool display will appear as below.
 
Agent Configuration – Multiple Authorized Servers
Additionally, the Agent Config Tool allows you to control the Agent startup and manually start or stop the Agent daemon.  Use the two buttons in the lower right of the window to control boot-time starting of the Agent or to stop/start the Agent manually.
 
To de-authorize, or delete a server for a given client, select the appropriate server from the listbox and click the Delete button.  The deleted server will no longer be allowed to connect to this client system.  Please be sure to also remove the client system from the server’s database and any backup jobs to which it may have been assigned.  If you do not remove the client system from the server, no harm will be done, but you will receive an error in the job logs indicating that the system could not be contacted.
 
Command Line Agent Configuration
 
Connect to your server system via ssh or open a Terminal.
Execute the following commands and respond to the prompts:
 
sudo -s
cd /usr/local/bru-server
./agent –config
 
The agent tool will allow you to authorize servers as above using a text-based menu system.
 
BRU Server Agent Configuration
 
Authorized Servers:
None
 
Enter the number to delete, N to add a new server or RETURN to quit >
 
Type an "N" to add a new server to the list and respond when prompted:
 
Hostname of the server > g5office.tolisgroup.com
Administrator password for server > (password is not echoed)
Server added to list of authorized servers
 
Authorized Servers:
 1: g5office.tolisgroup.com 736D-4FAE-A9F6-6C82
 
Enter the number to delete, N to add a new server or RETURN to quit >
 
You may continue to authorize additional servers, or simply hit RETURN to save the current settings and exit.
 
Configuring Agents Using Apple Remote Desktop
 
You may also send the agent configuration sequence to a group of managed OS X systems using ARD's "Send a Unix shell command to Target Computers".  Select the appropriate computers ARD console and select the Manage -> Send UNIX Command... menu option.  The command to send is a single line and consists of the command, the server that will be authorized to backup the systems followed by the BRU Server admin password:
 
    /usr/local/bru-server/agent –config2 servername,password
 
Note that there is no space between the server name, the comma, and the password.
Getting Started
A Simple Backup and Restore Tutorial
 
Once you’ve completed the server and agent setup, the next step is to create a backup job definition, define the data to be included, and set the job schedule.
 
You may use the graphical interface or either of the command line interfaces to perform these tasks.  For this simplified tutorial, we will utilize the BRU Server GUI Console.
 
Start the GUI Console and you will be greeted with the Login window.
 
BRU Server Login Dialog
To login to your BRU Server server:
 
  1. Enter the BRU Server server system’s DNS name or IPv4 address
  2. Use the TAB key or mouse to move to the BRU User field and enter admin
  3. Use the TAB key or mouse to move to the Password field and enter the admin user password.
 
Hit ENTER or click the "Login" button to connect to the BRU Server server and login.
 
 
Defining and Performing a Backup
 
Once the user and password are accepted, the BRU Server Configuration Assistant is displayed.  If you wish to continue with the assistant, step through each of the panels and respond as necessary.  However, for this tutorial click the "Skip Assistant and Configure Manually" checkbox since this tutorial does not require changes to the installation defaults.  
 
In either case, the main BRU Server console window is displayed next.  Please wait while the interface communicates with the server to load information about the server status.  This may take a minute, so please be patient.  Because BRU Server is a true client-server application, the console is simply a view into the state of the server system and must communicate with the server to update its displayed information from time to time.
 
  
BRU Server Console - Main Window
The first step in creating a backup job is to name the job.  Click the "New" button or select New Job from the File menu.  You will see the New Job Name dialog.
 
 
BRU Server Console – New Job Dialog
For the tutorial, we will name the job "QuickStart Demo" and leave the destination set to the "Stage Disk".  Click "Ok" or hit the ENTER key to continue.
 
The next tip dialog informs you of the remaining steps required before you’ve actually created a job.
 
BRU Server Console – New Job Tip
If you do not want the console to remind you of these steps each time you create a new job, click the "Do Not Show Again" checkbox.
 
Click the "Ok" button to continue.
 
Expand the client system entry for your client by clicking on the disclosure triangle to the left of the system name.  To match the steps in this tutorial, you should expand a Mac OS X client system.
 
    
BRU Server Console – Expand the Client System and Root Volume
Next, expand the root volume and scroll down to the "Applications" folder.  Expand the "Applications" folder and single click on the entries for "Address Book.app",  "Applescript", and a few other applications (we chose around 150MB for this tutorial).  Your selection list should look something like the figure below.
 
BRU Server Console – Selected Files and Folders
Check the Email checkbox and set the appropriate email address in the Email field. The next step is to save these settings.  While we could simply run this job now without saving it, we want to save in this case so we may reuse the job later in the tutorial.  Click the "Save" button to continue.
 
BRU Server Console – Job Was Saved Successfully
Next, we want to schedule the job, so answer Yes or hit the ENTER key to continue.
 
BRU Server Console – Job Schedule Dialog
For our tutorial, select "Daily" from the How Often popup menu and set the "Every" value to "2".  This setting means that this job definition is to be run daily, every other day, at the time specified starting on the date specified.  The current values assigned to the date and time fields are the current day and time.  For now, accept the date and set the time 5 minutes into the future.  Click the "Save" button to continue.
 
To see that the job has been scheduled, click on the "Data Manager" tab and then select "Schedules" from the popup menu.
 
BRU Server Console – Schedule Manager
If you click on the "QuickStart Demo" entry, the Command field will list the actual command that the server daemon will execute to perform the specified job.  Wherever possible, the console will disclose the command line that will be executed.
 
If you wished to remove this job from the scheduler, click the "Delete" button.  To Change the schedule, click the "Change" button.  For now, leave the job as it is and click the "Tools" tab.
 
BRU Server Console – Job Monitor Panel
The default panel on the Tools tab is the "Job Monitor" panel.  This panel displays all active jobs and allows you to monitor them or stop/cancel them.  
 
If your scheduled job has not started, wait until the time that you specified and its entry will appear in the upper list box as shown above.  Once it appears, click on the entry and then click the "Monitor" button.  The Monitor window will open and you will be monitoring the operation of your scheduled backup.
 
BRU Server Console – Monitor Window (Low Detail Display)
The Monitor window allows you to view the operation, but does not allow you to physically interact with the running job.  In fact, you could be monitoring this job for a dozen or more locations within your network and none of the Monitor windows would interfere with the others.  The Monitor window displays the current job name, owner, current file being processed, a count of files processed, and the amount of BRU data that has been processed.
 
If you wish to see more of the behind-the-scenes info, you may check the "Detail Display" check box and the Monitor window will expand to show more information about the job.
 
 BRU Server Console – Monitor Window (Detailed Display)
The "Detail Display" provides additional information from the server concerning this job.  The values displayed in the bottom panel are instantaneous snapshot values and are really only useful for troubleshooting network problems.  Do not look at them as representing the actual final throughput of your backup as they are an average number of the past 30-seconds of the backup operation.
 
If the job has not finished, click the "Close" button and watch the Job Monitor panel in the main window.  When the job completes, it will be removed from the list.
 
Once the backup and verify is completed, you will find information about the job in the History database and the Archives database.  In this instance, there will be no entry in the Tapes database since the backup was written to the Stage folder.  Also, a summary email will be sent to the address that you entered in the Email field.
 
To see the history report for this operation, open the Data Manager panel and select the History option from the popup menu.
 
Be aware that while you have the job monitor window open, it will cause backup operations to perform slower than expected.  This is because the job monitor is displaying information that BRU Server would not normally need to report, thus slowing the backup operation down.
BRU Server Console – Job History Panel
In this case, there is only one entry – the backup and verify that we just ran.  By selecting it in the top list, the actual history information will be displayed in the lower list.  All pertinent information about each system selected in this job will be listed.  At the end of the history report will be a summary for the entire job as shown below.
 
BRU Server Console – Job History Summary
The final step in this tutorial is to restore an application.  We have chosen to restore the "Address Book" application.
 
Open a Finder window and go to the Applications folder.  Find the "Address Book" and rename it to "Address Book Original" as shown in the next figure.
 
Finder – Rename "Address Book" to Address Book Original"
Next, select the Restore tab to display the Restore panel.  Expand the client system that we just backed up and the expand the archive as shown.
 
BRU Server Console – Restore Panel
Next, select the "Address Book.app" entry
 
Finally, click the "Restore" button.  BRU Server will verify that you wish to restore by displaying a verification dialog.  Click the "Yes" button to continue.
 
BRU Server Console – Restore Verification
The Monitor window will be displayed and the progress of the restore will be shown.  This particular example will not take long.
 
BRU Server Console – Restore Completed
To check the success of the restore, return to the Finder window and you will see your "Address Book Original" along with the restored "Address Book" app.
 
Finder – Restored "Address Book" application
This concludes the QuickStart tutorial.  For more in-depth information on BRU Server management and operation, please refer to the BRU Server Admin Guide.