Installation Specification

[hamishmb]

Had some time while multitasking this evening, so here are some quick thoughts. Please excuse my pedanticness

Section 5 comments

The rivercontrolsystem directory is under "/home/pi", not "/home"

Section 5.1.2 comments

It is correct that that is where the tests are, but to run them, you need the command:

Code: Select all

python3 ./unittests.py [args]

The arguments at this point in time are as follows (taken from the help information):

Code: Select all

Usage: unittests.py [OPTION]


Options:

       -h, --help:                   Show this help message
       -D, --debug                   Enable debug mode
       -a, --all:                    Run all the tests. The default.
       -c, --coretools:              Run only the tests for the
                                     coretools module.
       -d, --deviceobjects:          Run only the tests for the
                                     deviceobjects module.
       -e, --devicemanagement:       Run only the tests for the
                                     devicemanagement module.
       -m, --monitortools:           Run only the tests for the
                                     monitortools module.
       -s, --sockettools:            Run only the tests for the
                                     sockettools module.

I recognise that this isn't strictly necessary, but might be useful.

Section 5.2.2 comments

Note that:

Code: Select all

sudo poweroff

Or, if using a keyboard directly connected to the pi (not SSH):

Code: Select all

poweroff

Will also work and are a bit shorter.

Section 6.1.1.1 comments

You only need to press CTRL-C once, which will ensure everything shuts down cleanly - I would suggest doing this from now on. You may need to wait a little bit, but it shouldn't be anything like before.

Section 6.1.1.2 comments

These instructions work fine, but would it be more useful to provide instructions using a commonly available GUI such as GNOME Disks instead of/as well as this? I could provide screenshots and basic instructions if needed. The same goes for restoring images.


NAS Box VM notes

I've never actually done this properly and documented it, so maybe just leave a note for now until I do? I can do this soon if that would be useful.

[hamishmb]

Extra note:

For the external links in Annex B, would it be good to write our own documents/save these pages in case they disappear off the internet in future?

[hamishmb]

Extra note 2:

I formally specified this, if memory serves, but I'm not sure it was finalised. At any rate, I have written some software which assumes a particular format. Of course, this can probably be changed without too much hassle if needed.

I'll try to hunt it down, and if I can't find it, I will make a set of tables or similar. Again, useful for me to get this done soonish?

[TerryJC]

Hamish,

None of this is urgent, but it would be good to ensure it gets done. All of us are likely to move on at some time in the future and we ought to leave the system in good shape.

[hamishmb]

Makes sense. I shall make a note to make sure it gets done.

[hamishmb]

I finally found it!

I have uploaded the spreadsheets I made at: https://wmtprojectsforum.altervista.org ... 0Box/Specs

I'm not sure if this is fully up to date with what I implemented software wise, so I will get back to you and check it over.

[hamishmb]

Just noting that I'm in the process of updating the river system VMs section(s) in the installation spec. I'll post a draft here soon.

[hamishmb]

Oh, forgot: may I include a short passage on how the references work? Both Patrick and I have previously gotten confused about it

[TerryJC]

Oh, forgot: may I include a short passage on how the references work? Both Patrick and I have previously gotten confused about it

Of course.

[hamishmb]

Here's my draft updated spec.

Changes:

• Added section on how to use the references (in the introduction section).
• Added instructions for setting up passwordless sudo in the VMs.
• Fixed a few typing errors in the VM sections.
• Added instructions for installing GIT, xinetd, and net-tools (ifconfig) in the VMs.
• Re-ordered steps slightly so that autologin is set up in the base VM, seeing as this is the same for all VMs.
• Added a note about maintaining mutli-attach mode when updating the base system VM.
• Added note about Host IO cache.

Attached is the document. I forgot to turn on track changes (sorry!) but I have documented exactly what I changed so hopefully that is okay.