Skip to content

Commit

Permalink
Updated documentation. More updates needed.
Browse files Browse the repository at this point in the history
But at least the magic installer is mentioned ;-)
  • Loading branch information
Alan-R committed Sep 30, 2015
1 parent fb30c91 commit 0bb0877
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docfiles/GettingStarted.c
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,32 @@ This document is a more detailed version of the information provided in the proj
You can either install pre-built packages, or you can build from source and install the packages you built yourself.
If you can, we recommend installing our pre-built packages.
@section MagicInstallerOutline How to get started with the magic installer
As of release 1.0.1 we have a <i>magic</i> installer script designed to work on every platform for which we have pre-built packages. This is the recommended procedure for most people.
The 64-bit platforms which we currently have prebuilt packages for are:
- Ubuntu precise, trusty, vivid, and wily.
- Debian jessie and wheezy.
- CentOS 6 and 7.
- Fedora 21 and 22.
We do not currently produce any prebuilt 32-bit packages. Sorry!
You can find the prebuilt installer at https://raw.githubusercontent.com/assimilation/assimilation-official/master/buildtools/installme.
This is pointed to by this shorter URL: http://bit.ly/assiminstall.
To use the installer follow these steps:
-# Download the installer from one of the links above
-# Inspect it if you like. It's long, but mostly straightforward.
Pull requests including improvements are solicited.
-# <tt>chmod 744 assiminstall</tt>
-# <tt>./assiminstall cma</tt> \# on the machine you wish to be your CMA
-# <tt> mkdir /usr/share/assimilation/crypto.d</tt> on each non-CMA machine.
-# <tt>./assiminstall nano</tt> \# on machines besides your CMA
-# <tt>chmod 700 /usr/share/assimilation/crypto.d</tt> \# on each non-CMA machine.
-# Copy the public keys from the CMA onto your nanoprobe machines. You will find them in
/usr/share/assimilation/crypto.d. The public keys in question will be named <tt>\#CMA\#0000.pub</tt> and <tt>\#CMA\#0001.pub</tt>. Put them in the same location on the other machines. Do <i>not</i> copy the <i>.secret</i> keys over the other machines. The <i>crypto.d</i> directory <i>must</i> be mode 0600.
-# Hide the <tt>\#CMA\#0001.secret</tt> key somewhere besides in plain text on the same machine. Encrypt it and change its name, or hide it in a lock box or something similar.
You're now all installed and ready to get started - if you can use multicast for your entire set of expected machines.
@section PrebuiltProcessOutLine Outline of how to get started with pre-built packages.
You must install the nanoprobe and CMA software on the CMA system before attempting to install other non-CMA machines.
You can find our latest packages at http://bit.ly/assimbuilds and officially released versions at http://bit.ly/assimreleases.
Expand Down
44 changes: 44 additions & 0 deletions docfiles/Releases.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
/**
@page ReleaseDescriptions Release Descriptions
@section Version_1_0_1 version 1.0.1 - the "Day 30" release - 30 September 2015
@subsection Features_1_0_1 New Features
- Moved development to git and github
- Continuous integration via travis-ci
- Awesome universal installer - run this script to install a CMA or nanoprobe system and be happy. Will install any of the systems handling everything.
- Building includes 10(!) 64-bit platforms:
- Ubuntu precise, trusty, vivid, and wily.
- Debian jessie and wheezy.
- CentOS 6 and 7.
- Fedora 21 and 22.
- Added over 40 best practice rules from the <a href="http://ITBestPractices.info>IT Best Practices project</a>. Most are security rules, but one is a networking rule. These include DISA rules for:
- PAM
- /proc/sys
- sshd
- /etc/login.defs
- many more to come in the future!
- increased maximum host name length so it doesn't barf on 56-character host names(!) in travis-ci.
- added the loadbp command to load best practices
- perform checksums over all known checksum programs
- made list of default checksum files be configurable
- updated it to work with newer version of Neo4j and py2neo version 2.x
- improved the process for putting out a release so that everything is consistent and is marked with the right version number.
- Added discovery for /etc/sudoers
- Added travis-ci and coverity badges to github site.
@subsection BugFixes_1_0_1 Bug Fixes
- bug in partitions discovery agent
- bug in mdadm discovery agent
- fixed UnknownIPs query
- removed duplicates from the allips query
- discovery test failures didn't cause overall test results to be marked as failed
- several discovery tests weren't quite right.
@subsection Caveats_1_0_1 Caveats
- Documentation has not been updated to reflect move to github. No doubt other shortcomings exist as well. Sorry! Please fix and generate a pull request.
- No alerting, or interface to existing alerting (hooks to build your own interface are included)
- high availability option for the CMA is roll-your-own using Pacemaker or similar
- queries could benefit from more indexes for larger installations.
- The CMA will suffer performance problems when discovering IP addresses when large numbers of nanoprobes are on a subnet.
- no GUI
- use with recent versions of Neo4j requires disabling authentication on Neo4j
- performance with Neo4j is poor. Strangely, it's not a scalability problem. Fixes will be in a future release.
- Best practices alerts currently only come out in syslog - not as events. Sorry!
- Our current process only allows us to distribute 64-bit binaries. Feel free to build 32-bit binaries yourself. They still work for Ubuntu, and probably Debian and 7.0 and later versions of CentOS.
- The magic installer can't install CMAs onto Fedora.
@section Version_1_0 version 1.0 - the "Independence Day" release - 4 July 2015
This release provides a number of new features, and a number of bug fixes.
This release is eminently suitable for deployments in environments where the caveats are acceptable.
Expand Down

0 comments on commit 0bb0877

Please sign in to comment.