.. _DevOps Guide:

============
DevOps Guide
============

Environment "testenv"
=====================

This environment allow developers and power users to run additional
testing such as automated system tests and manual tests.
One of its main purposes is to uncover bugs and defects not detected
by the CI.

One host machine acting as a GitLab runner runs the instructions
specified in the `deploy` job of the GitLab CI.
There's only one specific machine allowed to pick and run the `deploy` job
so that environment `testenv` is always deployed to the same machine.
The app running in `testenv` is exposed to the WWW
as `reflectivity-test.sns.gov`.

Currently, the database in this environment is not persistent,
meaning a new deployment will erase whatever data has been stored since the
last deployment.
Also, `testenv` is currently listening and writing to `livedata.sns.gov`,
as well as listening to `oncat.ornl.gov`. Development of a test environment
for the web monitor will bring about test substitutes for both servers.

.. include:: database_management.rst

Deployment for Testing
----------------------

Deployment for the testing environment is handled by the
`web-relectivity-deploy repo <https://code.ornl.gov/sns-hfir-scse/deployments/web-reflectivity-deploy>`_.
For details on how to deploy, read the
`Guide for the deployment to Testing Environment <https://code.ornl.gov/sns-hfir-scse/deployments/web-reflectivity-deploy/-/blob/main/docs/deploy_test.md>`_.

Access to the Test Environment
------------------------------

Access to the test server `reflectivity-test.sns.gov` via SSH is granted on a per user *and* per client-machine basis.
Contact the DevOps engineer assigned to maintenance of the server. After granted access, SSH to the machine as user
`cloud`

.. code-block:: bash

   ssh cloud@reflectivity-test.sns.gov

The goal of accessing the test server is to troubleshoot any problems by directly manipulating the deployed application.

Deployment in Production
------------------------
This deployment is scheduled to happen after a new version of the software
is released and thoroughly tested in deployment `testenv`.
For details on how to deploy, read the
`Guide for the deployment to Production Environment <https://code.ornl.gov/sns-hfir-scse/deployments/web-reflectivity-deploy/-/blob/main/docs/webref-prod%20steps%20to%20release.md>`_.