installation instructions document (NFR006, inst-04)

[dscuyle]

https://github.com/ngds/ckanext-ngds/blob/master/installation/NGDSInstallationInstructions.docx is 6 months old; does not match install scripts.

[smrgeoinfo]

@chkhm can we replace this with the install instructions for the current install package?

[smrgeoinfo]

Need to review installer documentation and verify that it is accurate and up-to-date.

[ccaudill]

https://github.com/ngds/documents/blob/master/NGDS_Installation_Documentationv1_20140226.pdf?raw=true Installing test node to update installation guide further.

[ccaudill]

working also from https://github.com/ngds/dev-info/wiki/Low-Level-Installer-Script-Documentation

[ccaudill]

Done. https://github.com/ngds/documents/blob/master/NGDS_Installation_Documentation.pdf?raw=true https://github.com/ngds/documents

Will still test installer branch at https://github.com/ngds/ckanext-ngds/issues/391

[mattmackenzie]

A couple of issues:

1. The maximum stack configured for Java, (-Xmx) is 2048mb, yet minimum system requirements are 1024MB? I'd say minimum for small production is more like 4096mb, maybe 3072.
2. There are unmentioned, yet important config parameters such as SERVER_NAME. These don't matter when you are installing on your desktop to check things out, but when in production they are important as they are used for Apache virtual server configuration.
3. If the installation script moves to using a apt package, as suggested, JAVA_OPTS will belong in /etc/default/tomcat7. There will also be no need to mention catalina.sh, or even touch it in any way as part of initial installation.
4. Why is this document assuming everyone just wants to install a self contained developer-like install, and not an actual internet addressable node (references to virtual box, and assuming the node is installed on a linux machine that has Xorg installed as opposed to a headless server install that cannot be reached via 127.0.0.1.
5. Permissions almost always have to be adjusted, why not specify the recommended commands?
6. The reference at the end to the "paster" command is ambiguous.
7. I don't think a complete step by step of installing xubuntu on vbox is needed, especially considering that these installation instructions should be focused on producing a production node on the internet.
8. Similiar to above, discussion of CNTLM is superfluous.
9. Appendix B is confusion. Why does development.ini need to be changed? Doesn't the installer do that?

[ccaudill]

Thanks @mattmackenzie the document will be edited regarding 1,2,3,8 I will defer to @asonnenschein on points 5,6,9

Point 7: This document is of course a Beta, temporary solution for those installing NIAB in advance of an easier UI, single push button, or more simple script as discussed with @asonnenschein and @smrazgs. I argue that having instructions for the VM install is really important at this time because we're giving this documentation over to state subs who will install NIAB and need this guidance. I had that audience in mind when revising this document.

Point 4: What you're asking here makes complete sense. For sure not everyone will want to run this on an Oracle Virtual Box (which can certainly be internet accessible) - only those who only have Windows OS hardware. I'm sure most people will run through the install without even going to the VM instructions in Appendix A. Like I mentioned above, though, having the option in to do a VM on a Windows OS (which I will actually explain in the document more in depth why it's there - thanks) will make this possible for those without much Linux experience or Linux machines. It's for a broader audience.

[ccaudill]

@asonnenschein or @jalisdairi Actually, SOLR doens't seem to be running using the scripting method given here https://github.com/ngds/dev-info/wiki/Low-Level-Installer-Script-Documentation - tried with master branch and installer branch.

[asonnenschein]

Is Tomcat running?

[ccaudill]

Discussed at https://github.com/ngds/ckanext-ngds/issues/391

[mattmackenzie]

@ccaudill Thanks for responding.

[jpTipton]

@mattmackenzie @ccaudill Issue 4 . I am currently and plan to use Virtual Box in my production server. We only have 1 public server and it is running Windows Server. Plus isn't that why we call it niaBOX ! Even if I had a Linux server, I would still want to run this in a virtual machine of some sort so it would be self contained system.

[ccaudill]

Please see a more finished version at https://github.com/ngds/documents/ with the new and working installer script. Added Section 5 as suggested by @kimjpatten and @jmatti for a short how-to-use-your-new-node. It's a rough and incomplete section, but again, this is a sort of placeholder document in advance of a smoother push-button UI or some other easy installer method. https://github.com/ngds/documents/blob/master/NGDS_Installation_Documentation.pdf?raw=true

@asonnenschein Can we delete Appendix B?

[mattmackenzie]

@jpTipton I am not opposed to having documentation that helps virtualbox users, it just reads as prescriptive toward that virtualization. I personally run it under VMWare, as well as on a cloud server, so it should be clear that if you have the right version of linux, you are golden. I'd rather see the document as a wiki page on here, with the ability to link to different tutorials for different platforms as people figure them out. For example, NREL must use redhat enterprise linux. They could later add their experiences in doing so as a link from the install documentation.

[ccaudill]

revised doc at https://github.com/ngds/documents/blob/master/NGDS_Installation_Documentation.pdf?raw=true

I hear you, @mattmackenzie and totally agree .... I would like this to eventually evolve to a smater wiki page with helpful links and real user experiences.

[ccaudill]

@smrazgs I added some new text here (and accepted your changes) - you want to review/edit before this issue is closed?

[smrgeoinfo]

current text instructions are workable for v1. I reviewed and edited. Create install-and-run repo for installer script, instructions, and use that issue tracker for install/run issue reporting to keep that trafic clear of the software development issue tracker. Close for now. Create more specific issues for any overlooked items.

[ccaudill]

@smrazgs Additional edits, added some text on Section 5 @asonnenschein Can you address some of the comments that Steve made? (See in Word track changes) https://github.com/ngds/documents NGDS_Installation_Documentation.docx