DOE Code

Scripts to setup SMuRF server

Description

This repository contains a set of useful scripts for setting up SMuRF servers, divided in two main categories:

• Scripts used to setup a SMuRF server from scratch,
• Scripts used to release docker system in an SMuRF server.

These scripts are used during SMuRF system deployments as described here.

Server setup script

These scripts are used to setup SMuRF servers, as part of the initial configuration procedure.

The scripts can also be used to upgrade existing SMuRF server.

How to setup a new SMuRF server from scratch

In order to setup a new SMuRF server, please follow the initial configuration procedure described here. In that procedure, the setup-server.sh script is used to setup the SMuRF servers automatically.

How to upgrade an existing SMuRF server

If you have a previously configured SMuRF server, you can use the setup-server.sh script to upgrade your server configuration, when new version of this repository are released. New version contain bug fixes and new feature which you should install in your server to keep it up to date.

In order to upgrade your existing server follow these steps:

1. First, reboot the server.
2. Then, run these commands on any directory of your preference (if the directory smurf-server-scripts already exist in that location, you will need to remove it first):

$ git clone https://github.com/slaclab/smurf-server-scripts -b <VERSION>
$ cd smurf-server-scripts/server_scripts/
$ sudo ./setup-server.sh

3. Finally, reboot the server.

Where <VERSION> is the version of this script you want to use.

A list of available versions, with release notes described the changes on each version, can be found in the releases section of this repository here.

To see the version of the script used to configured your system, run this command:

$ smurf-server-scripts-version

Note: if the command smurf-server-scripts-version does not exist in your system, then you server was setup with a script version previous to R3.8.0.

Docker System Release Scripts

As part of the system initialization described above, scripts to release SMuRF docker-based systems are installed in the server. For more information about these scripts, please refer to this documentation.