Admin Interfaces
These are now the preferred applications over sign on via PuTTY/ssh. However PuTTY will still need to be accessed to view certain data. This includes:
- Glances (See Gateway server##Glances / top)
- TBC
Other web interfaces to use include:
- RQ Dashboard (See Middleware##Redis)
- RabbitMQ (See Gateway server##RabbitMQ Interface)
URLs are as follows. User names and passwords can be found in the new_interfaces document on Teams.
| Component | Production | Training |
|---|---|---|
| Portainer | https://prod-pt.tms-uk-rail.co.uk/ | https://trg-pt.tms-uk-rail.co.uk/ |
| phpMyAdmin | https://prod-db.tms-uk-rail.co.uk/ | https://trg-db.tms-uk-rail.co.uk/ |
| Log Viewer | https://prod-lv.tms-uk-rail.co.uk | https://trg-lv.tms-uk-rail.co.uk |
| Redis Commander | https://prod-rc.tms-uk-rail.co.uk/ | https://trg-rc.tms-uk-rail.co.uk/ |
| RQ Dashboard | https://prod-rq.tms-uk-rail.co.uk/ | https://trg-rq.tms-uk-rail.co.uk/ |
| RabbitMQ | http://77.68.3.32:15672 | http://77.68.3.32:15672 |
Note: There are different URLs for the production server compared to the training server. It is likely that most of these activities will be undertaken on the production URLs.
Portainer
Click on the primary group to open the dashboard.
Containers
The Container List displays whether a container is healthy, unhealthy, running or stopped.
Note: You may wish to set the number of Items per page to All.
A healthy container can be considered the same as a running container; it just has a built in health check.
There are four containers that are typically displayed as stopped and this is not a concern. These are:
- dockerise_mysql-setup_1
- dockerise_download_bplan_1
- dockerise_download_cif_1
- dockerise_fetch_ad_1
To view the logs associated with a container, click on the blue paper icon in the Quick actions column. Within the Log viewer you may want to use the switch to display timestamps.
Stats can be viewed by clicking the blue graph icon in the Quick actions column. This displays the memory, CPU and network usage. This information only starts to display once opened so should be observed over a time period to see average behaviour.
The option is provided to restart one or more containers. This can be achieved by selecting the container(s) from the Container list or clicking on the specific container.
When will I use this?
- Daily checks to ensure containers are healthy/running
- If a container needs to be restarted. For example, if acumen cannot be accessed, then an option would be to restart dockerise_flask-app_1
phpMyAdmin
phpMyAdmin connects to the database server. The databases are listed down the left hand side of the main page.
Note: phpMyAdmin is not available for the gateway server.
Checking the CIF
Click to open the cif_record database.
The tbl_downloaded_cif table displays if the CIF has been downloaded to the server. Check the int_index column for the most recent file. The file name should display the previous day's date.
Now return to the cif_record database and open the tbl_header_stats table. The most recent file should have the same index number as before. This checks that the CIF has been processed.
Note: DO NOTE DELETE ANY RECORDS!
When will I use this?
- Daily check to ensure incremental (or full) CIF has been downloaded
- As part of investigative work following a ticket. For example, may choose to search through the tsdb train service database.
How do I redownload the CIF if needed?
ssh into production (and training) servers in PuTTY, then enter the following commands:
cd dockerise
./system_management/acumen cif full
This re-initialises the database. Wait for the code to finish.
There is no need to restart any containers.
Log Viewer
The Log Viewer is a web interface alternative to loading the application logs (See Gateway server##Application logs).
The folders provide a last modified time/date to indicate what has changed and what needs to be checked. The following folders are likely to see daily activity, otherwise the files within the folders should show a size of 0B meaning there is no log to report.
| Folder | File(s) | Reason for log |
|---|---|---|
| download_cif | post_processing | Incremental CIF received and processed daily |
| Example? | Example? | Why? - TBC |
Note: The logs rotate every 12hrs, aka they receive a date stamp after 12hrs and a new log is created. These can be seen by scrolling down within the folder.
When will I use this?
- When investigating an error. For example acumen loses s-class messages but RabbitMQ says the gateway server is fine and the container is running. The s-class folder within the Log Viewer could show what the error is.
redis Commander
redis Commander containers the forecast schedules. A service Key or entity can be selected from the left hand side and then View mode tree opened to see the forecast.
Note: The 5-digit key can be identified as follows. Open the Global Search Tab within acumen and search for the required headcode. Then right-click on the page and select Inspect. Hover over the headcode to read the key.
redis Commander includes a command line at the bottom of the page. For example, to type FLUSHDB to drain the forecast.
To see a list of recent active users, type SELECT 6 in the command line and then open the user file on the left hand side. This lists users who have logged in within the previous 8hrs.
Note: The list of commands can be found under the Commands tab in the top left hand corner.
When will I use this?
- If a schedule should be in the acumen forecast but is not, then the schedule can be interrogated here. For example, VSTP schedules not displaying because they're missing TB and TF activity codes (now resolved).
- To drain the forecast. The prompt for this would be if the docker is out of date, e.g. following the data feeds having failed for an hour or more.
- Before giving a demo or undertaking testing to see what dockers may have active users and which are 'free'.