Skip to content

Commit

Permalink
Cleanup Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@nothingface0
nothingface0 committed Feb 20, 2024
1 parent ded0c03 commit 0703378
Showing 1 changed file with 1 addition and 142 deletions.
143 changes: 1 addition & 142 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,145 +12,4 @@ It aims to replace the existing one (`Deploy`), found in [`dmwm/deployment`](htt
> [!WARNING]
> This deployment script should *not* be run as a sudo user.
## Requirements

- RHEL8 (Tested with version 8.8)
- `sudo` permissions:
- To install the system-wide packages (listed below).
- Python 3.8

## Deploying [Legacy] DQMGUI

This procedure has been tested on a RHEL8 Openstack VM. Instructions below are primarily for a personal VM.

0. Get the installation package to the machine you want to deploy to:
* Download the latest build artifact and copy it to the machine you want to install it to:
```bash
curl -L https://github.com/cms-DQM/dqmgui_prod_deployment/releases/download/deployment_debug_dqmgui_python3_backup_root_v6-28-08/dqmgui_installation_package.tar.gz --output dqmgui_installation_package.tar.gz
scp dqmgui_installation_package.tar.gz root@<VM machine>:/tmp/
```
OR
* Download all the required files yourself (this is useful if you need specific versions of DMQM/deployment or DQMGUI, change them in `config.sh`):
> [!WARNING]
> You will need to have the same python version with the machine you will be installing to! Configure that in `config.sh`, with the `PYTHON_VERSION` variable.
```bash
git clone --depth 1 https://github.com/cms-DQM/dqmgui_prod_deployment && cd dqmgui_prod_deployment
# Now change config.sh as needed.

# This will create a dqmgui_installation_package.tar.gz in /tmp
bash download_dependencies.sh && bash build_installation_package.sh
scp /tmp/dqmgui_installation_package.tar.gz root@<VM machine>:/tmp/
```

1. Connect to the VM and install the system packages:

```bash
sudo yum install -y patch unzip bzip2 libglvnd-opengl libX11-devel libXext-devel libXft-devel libXpm-devel mesa-libGLU mesa-libGLU-devel perl-Env perl-Switch perl-Thread-Queue glibc-headers libidn libXcursor libXi libXinerama libXrandr perl perl-Digest-MD5 tcsh zsh epel-release libcurl-devel python38 python38-devel boost-python3-devel protobuf-devel jemalloc-devel pcre-devel boost-devel lzo-devel cmake xz-devel openssl-devel libjpeg-turbo-devel libpng-devel gcc-c++ gcc binutils gcc-gfortran mesa-libGL-devel mesa-libGLU-devel glew-devel ftgl-devel fftw-devel cfitsio-devel graphviz-devel libuuid-devel avahi-compat-libdns_sd-devel openldap-devel python3-numpy libxml2-devel gsl-devel readline-devel R-devel R-Rcpp-devel R-RInside-devel xrootd-client
```

2. Add a non-privileged user, create and give access to necessary directories and switch to it:

```bash
adduser dqm

# Installation directory
sudo mkdir -p /data/srv
sudo chown -R dqm /data/srv

# Data directory
sudo mkdir -p /dqmdata/dqm
sudo chown -R dqm /dqmdata

# Installation package
sudo chown dqm /tmp/dqmgui_installation_package.tar.gz

sudo su dqm
```

3. Start the deployment (`dev` flavor):

```bash
cd ~
tar -xf dqmgui_installation_package.tar.gz -C dqmgui_deployment

# Start the deployment script, it will take some time to finish
bash /home/dqm/dqmgui_deployment/deploy_dqmgui.sh

# Start all the services
/data/srv/current/config/dqmgui/manage -f dev start "I did read documentation"
```

4. Open firewall ports (if needed):

```bash
firewall-cmd --list-all-zones
firewall-cmd --zone=public --add-port=8030/tcp # online
firewall-cmd --zone=public --add-port=8060/tcp # dev
firewall-cmd --zone=public --add-port=8070/tcp # online/dev
firewall-cmd --zone=public --add-port=8080/tcp # offline
firewall-cmd --zone=public --add-port=8081/tcp # relval
```

## Deployment command-line arguments

This script uses some internal variables to specify options such as the main installation directory, or the git tags/refs to use when cloning repositories. It's not recommended that you edit those, as most of them are hand-picked so that the project compiles (we're mostly referring to the git refs).

However, if needed, you can override them by passing them as arguments to the script in the form of `<variable name>=<value` (e.g. `bash deploy_dqmgui.sh INSTALLATION_DIR="~/dqmgui"`).

Below is a list of the values that you will most probably need to change to customize your installation.

| Variable name | Description |Default value |
|---------------|-------------|--------------|
| `INSTALLATION_DIR` | The directory to install the GUI into. It should be writable by the user running the script | `/data/srv` |

### [Debug] Selectively run parts of the installation script

The script is split into steps (see the `installation_steps` array declared in the `deploy_dqmgui.sh` script), which can all be toggled off or on by arguments when running the script.

The flags are named by concatenating `do_` with the name of the step, so, for example, `do_check_dependencies` or `do_install_rotoglup`.

The are all set to `1` by default, and you can override them when running the script as follows:

```bash
bash deploy_dqmgui.sh do_preliminary_checks=0 do_check_dependencies=0
```

A useful combination that can be used when you've already installed and built all steps once, but you only want to re-compile the DQMGUI part for testing:

```bash
bash deploy_dqmgui.sh do_preliminary_checks=0 do_check_dependencies=0 do_create_directories=1 do_install_boost_gil=0 do_install_gil_numeric=0 do_install_rotoglup=0 do_install_classlib=0 do_compile_classlib=0 do_install_dmwm=0 do_install_root=0 do_compile_root=0 do_install_dqmgui=0 do_compile_dqmgui=1 do_install_yui=0 do_install_extjs=0 do_install_d3=0 do_install_jsroot=0 do_clean_crontab=0 do_install_crontab=0
```

## Download script

The installation package is created by running `download_dependencies.sh`. This is done automatically by github actions (see `.github/workflows/build_installation_package` in this repository). The versions of the packages downloaded are specified in `config.sh`.

## Notes

- We're not using the RHEL8 `root` package, due to the fact that they are built for python3.6, hence we need to build it with python3.8.

## FAQ

### Releases and Installation packages

#### How do I create a new installation package, using new versions of specific packages?

1. Go to [Actions secrets and variables](https://github.com/cms-DQM/dqmgui_prod_deployment/settings/variables/actions).
2. Edit the `Repository variables` to reflect the versions of the packages you want to include in the release. For example, if you want to use DQMGUI [`9.8.0`](https://github.com/cms-DQM/dqmgui_prod/releases/tag/9.8.0), change `DQMGUI_GIT_TAG` to `9.8.0`.
3. Trigger the `build_installation_package` action [here](https://github.com/cms-DQM/dqmgui_prod_deployment/actions/workflows/build_installation_package.yaml): Click the topmost row of the "workflow runs" table, and in the new page that opens, click `Re-run all jobs`.

#### When do I need to re-trigger the GitHub actions of this repository?

Two cases:

1. You want to create a new release, which you cannot find under [Releases](https://github.com/cms-DQM/dqmgui_prod_deployment/releases). This means that you want to change a version of the packages downloaded, e.g.
DQMGUI, or DMWM's deployment.

2. You want to update an *existing* release (less common, probably for debugging reasons): The release you are
looking for exists, but some of the packages downloaded in this release have been updated, using the same tag/reference/branch name. For example, if you want to include a development branch of DQMGUI (e.g. `dev`), the DQMGUI `dev` branch may be updated, but the installation package that has been created cloned an older version of the `dev` branch.

### Installation

#### Is it needed to recompile ROOT every time I install DQMGUI?

No. In principle (assuming that you don't change ROOT version between releases) you only need to compile ROOT once. However, should you want to change ROOT versions between releases or just force a recompilation anyway (guaranteed fun for the whole family), you can do it by deleting the file `<Installation dir>/root/bin/thisroot.sh` (default: `/data/srv/root/bin/thisroot.sh`).
Complete instructions and more information can be found on the [Wiki](./wiki).

0 comments on commit 0703378

Please sign in to comment.