Rackspace Cloud Backup - Install the agent on Linux


The following instructions are for the installation of the Rackspace Cloud Backup agent on your Linux server. If you are using a Windows server, see Rackspace Cloud Backup - Install the Agent (Windows) for parallel instructions.  To schedule and configure backups after the agent is installed, see Rackspace Cloud Backup - Create a Backup.

Note: You can use Cloud Backup on almost any Linux server in the Rackspace Cloud (Debian 5 is excluded). Cloud Backup does not work with FreeBSD 9.

Contents

1. Establish network routes

2. Install the agent

3. Troubleshooting

4. Uninstall the agent from Linux

 

Establish network routes

If your cloud server was created before June 3, 2013, you might need to add network routes to the server so that it can connect to Cloud Backup through the back-end network (ServiceNet). You can find complete instructions for updating your server's network routes in Updating ServiceNet routes on Cloud Servers.

Back to Top

Install the agent

To see if your server already has the Cloud Backup agent installed, run:

sudo cloudbackup-updater -v

If the command runs without an error, the agent is already installed (this should be the case for servers with a Managed Operations service level). If you get a message that the command can't be found, the agent needs to be installed.

If the Cloud Backup agent is not installed, proceed with the instructions for your Linux distribution:

Back to Top

Install the agent on APT-based systems, such as Ubuntu and Debian

Use SSH to log in to your server and run the following commands consecutively as a user with sudo or superuser privileges.

  1. Get the auto-updater.
    wget 'http://agentrepo.drivesrvr.com/debian/cloudbackup-updater-latest.deb'
  2. Install the auto-updater.
    sudo dpkg -i cloudbackup-updater-latest.deb

    The updater installs the agent (if it's not already installed) and sets the agent to start at boot. If you see an error, don't worry; we'll fix it in the next step.

  3. Update the apt repository information then run apt-get with the -f option.  This will fix any outstanding dependency issues on the system.

    sudo apt-get update
    sudo apt-get install -f
  4. Check the installation.

    The updater might take a few minutes to download and install the agent. To check the status of the agent installation, run the following command:

    sudo cloudbackup-updater -v

    If the agent installation is not complete, that command will hang until it completes. When it returns you to the shell prompt, proceed to the next step.

  5. Configure the bootstrap.

    Run the agent with the --configure option to configure the agent. You will be asked for your Rackspace Cloud username and password.

    Tip: This step asks you to confirm that you want to overwrite your configuration file. Answer yes.

    sudo /usr/local/bin/driveclient --configure
  6. Start the agent.
    sudo service driveclient start

Install the agent on RPM-based systems, such as CentOS, Fedora, and Red Hat

Use SSH to log in to your server and run the following commands consecutively as a user with sudo or superuser privileges.

  1. Download and install the auto-updater.
    sudo rpm -Uvh 'http://agentrepo.drivesrvr.com/redhat/cloudbackup-updater-latest.rpm'

    The updater installs the agent (if it's not already installed) and sets it to start at boot.

  2. Check the installation.

    The updater might take a few minutes to download and install the agent. To check the status of the agent install, run the following command:

    sudo cloudbackup-updater -v

    If the agent installation is not complete, that command will hang until it completes. When it returns you to the shell prompt, proceed to the next step.

  3. Configure the bootstrap.

    Run the agent with the --configure option to configure the agent. You will be asked for your Rackspace Cloud username and password.

    sudo /usr/local/bin/driveclient --configure
    
  4. Start the agent.
    sudo service driveclient start

Back to Top

Install the agent on Arch, Gentoo, and SUSE systems

For Arch, Gentoo, and SUSE Linux systems, you must first download the tarball. Then, use SSH to log in to your server and run the following commands consecutively as a user with sudo or superuser privileges.

Note: The tarball has the most up-to-date instructions. If the following instructions differ from the tarball instructions, use the tarball instructions.

  1. Download the tarball.
    wget http://agentrepo.drivesrvr.com/tar/driveclient-latest.tar.bz2
  2. Extract the files.

    Use SSH to log in to your server, and then run the following command to extract the installation files.

    tar -xvjf driveclient-latest.tar.bz2
  3. Change to the directory.

    Enter the directory that was created by extracting the files, for example:

    cd driveclient-1
  4. Create directories and copy files.
    sudo cp driveclient /usr/local/bin/
    sudo chown root:root /usr/local/bin/driveclient
    sudo chmod 700 /usr/local/bin/driveclient
    sudo mkdir -m 700 /etc/driveclient
    sudo cp cacert.pem /etc/driveclient
  5. Configure the agent.

    Run the agent with the --configure option to configure the agent. You will be asked for your Rackspace Cloud username and password.

    Tip: This step asks you to confirm that you want to overwrite your configuration file. Answer yes.

    sudo /usr/local/bin/driveclient --configure
  6. Start the agent.
    sudo /usr/local/bin/driveclient --daemon

    Example init/startup scripts are included in the tarball.

Troubleshooting

If you encounter issues during installation, use the tips in this section to troubleshoot.

Back to Top

Connection error

If Cloud Backup indicates that the agent is not running on your server, ensure that your firewall isn't blocking outgoing connections on port 443.

Back to Top

Status codes

What do the backup statuses Skipped, Missed, Errored, and Failed mean?

  • Skipped: The backup job was skipped because a backup job was already queued. A single backup job can be queued only once.
  • Missed: The backup job was missed because the agent did not respond. The agent was likely offline.
  • Errored: An error occurred during the backup. The backup job did run, but it needs to be investigated.
  • Failed: A serious problem occurred, and the backup job did not run.

How do I troubleshoot the Skipped, Missed, Errored, and Failed statuses?

  • Skipped: This error likely occurs because the frequency of the backup job is set too high. Consider reducing the frequency of the job, or reducing the amount of data. If this is the initial job, then the subsequent jobs might finish faster.
  • Missed: Verify that the agent is running on the server. If the agent is not already running, then start it. Next, check the logs to determine why the backup job failed. An agent should never go offline by itself. Either a software exception occurred or the agent was manually terminated.
  • Errored: Look in the logs on the server. The agent stores all the logs in one location (see the following section). Review the logs line by line. If you cannot determine the cause of the error, raise a ticket with the SME group, and they can help you identify the problem.
  • Failed: As with the Errored status, check the logs on the server. A failed status is severe.

Back to Top

Agent logs

If you need to read the logs of the agent, you can find them in /var/log.

Uninstall the agent from Linux

To uninstall the agent, you can stop and remove both the auto-updater and the backup agent by using the system package manager.

CentOS or Red Hat

sudo yum remove cloudbackup-updater driveclient

Back to Top

Ubuntu

sudo apt-get remove cloudbackup-updater driveclient

Back to Top

Other Linux Distributions

For all other Linux operating systems, follow OS-standard uninstallation operations. Based on the previous installation instructions, use the following commands to uninstall the agent.

Remove /usr/local/bin/driveclient.

sudo rm /usr/local/bin/driveclient

Remove the /etc/driveclient directory.

sudo rm -r /etc/driveclient

If the init script for the driveclient was added for this installation, remove that as well.

Back to Top



Was this content helpful?




© 2014 Rackspace US, Inc.

Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License


See license specifics and DISCLAIMER