Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Commit

Permalink
Fix rst2html.py errors and warnings to fix github rendering issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
chambridge committed Jun 21, 2017
1 parent 4f4c396 commit 11e1f7f
Showing 1 changed file with 17 additions and 44 deletions.
61 changes: 17 additions & 44 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,8 @@ all the hosts and ranges that are to be tested against the auths.
The rho tool configuration is created using rho itself. There are subcommands
to create and edit auth and profile items in the configuration. For example:

``
rho auth add --name server1auth --username rho-user --sshkeyfile
/etc/ssh/ssh_host_rsa_key --password
``
``rho auth add --name server1auth --username rho-user --sshkeyfile
/etc/ssh/ssh_host_rsa_key --password``

This creates a new auth item named server1auth, which uses the SSH user
rho-user with a key stored in the key file. The password is input as
Expand All @@ -62,26 +60,18 @@ an Ansible inventory called '<profile name>_hosts' that includes the working
hosts matched with an auth each (the auths are chosen in the order passed in
to the profile add or edit command as will be explained later).

``
rho scan --reset --profile big_test --facts data/facts_eg --ansible_forks 100 --reportfile rep.csv
``
``rho scan --reset --profile big_test --facts data/facts_eg --ansible_forks 100 --reportfile rep.csv``

The output is simple CSV format. If 'default' is the argument for --facts,
the csv output contains the following information:

``
OS,kernel,processor,platform,release name,release version,release
number,system ID,username,instnum,release,CPU count,CPU vendor,CPU model,
BIOS vendor,virtual guest/host,virtual type
``
``OS,kernel,processor,platform,release name,release version,release number,system ID,username,instnum,release,CPU count,CPU vendor,CPU model,BIOS vendor,virtual guest/host,virtual type``

For example:
``
Linux,i686,i386,redhat-release,5Client,5.3.0.3,ID-1000015943,
jsmith,da3122afdb7edd23,Red Hat Enterprise Linux Client release 5.3
(Tikanga),2,GenuineIntel,Intel(R) Core(TM)2 Duo CPU,Award Software, Inc.,host,
xen
``
``Linux,i686,i386,redhat-release,5Client,5.3.0.3,ID-1000015943,
jsmith,da3122afdb7edd23,Red Hat Enterprise Linux Client release 5.3
(Tikanga),2,GenuineIntel,Intel(R) Core(TM)2 Duo CPU,Award Software, Inc.,host,
xen``

As implied by the report output, rho differentiates between baremetal machines,
virtual hosts, and virtual guests, and identifies several major virtual types
Expand Down Expand Up @@ -126,24 +116,18 @@ rho is available for `download <http://download.fedora.redhat.com/pub/epel/>`_ w

1. First, make sure that the EPEL repo is enabled for the server:

``
rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-2.noarch.rpm
``
``rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-2.noarch.rpm``

2. Then, install the rho packages:

``
yum install rho
``
``yum install rho``

-----------------------
COMMAND SYNTAX & USAGE
-----------------------
The basic syntax is:

``
rho command subcommand [options]
``
``rho command subcommand [options]``

There are four rho commands:
* ``auth`` - for managing auth entries
Expand All @@ -166,10 +150,7 @@ AUTH ENTRIES
The first step to configuring rho is adding auth credentials to use to connect
over SSH. Each authentication identity requires its own auth entry.

``
rho auth add --name server1creds --username rho-user --sshkeyfile
/etc/ssh/ssh_host_rsa_key
``
``rho auth add --name server1creds --username rho-user --sshkeyfile /etc/ssh/ssh_host_rsa_key``

*Note:* --password not being passed or passed as empty are considered the same thing.

Expand All @@ -179,10 +160,7 @@ PROFILES
Then, create the profile to use for the scan. This should include a list of IP
addresses or ranges, and the auth identity to use.

``
rho profile edit --name profile1 --hosts "1.2.3.0 - 1.2.3.255" --auth
server1creds server2creds
``
``rho profile edit --name profile1 --hosts "1.2.3.0 - 1.2.3.255" --auth server1creds server2creds``

The hosts can be passed in as a file with all the ranges listed in newlines.

Expand All @@ -195,9 +173,7 @@ Finally an important argument is 'reset'. This tells rho that the profile you ar
passing in is either new or has been updated with changes in either the hosts or
auths or both and that rho has to process it afresh.

``
rho scan --reset --profile profile1 --facts default --reportfile report.csv
``
``rho scan --reset --profile profile1 --facts default --reportfile report.csv``

Since rho collects the successful host auth mappings from a full scan with reset
the user doesn't have to worry about iterating through multiple auths and hosts
Expand Down Expand Up @@ -264,9 +240,9 @@ the first valid auths in the list passed in order to the profile. All the valid
auths are of course listed in the host auth mapping file for the profile for that
scan identified by the time stamp.

-----------------------
^^^^^^^^^^^^^^^^^
Example rho Scan
-----------------------
^^^^^^^^^^^^^^^^^

Following is the results of an example rho scan. This is the example of the
profile called 'big_test' and it's host auth mapping
Expand Down Expand Up @@ -351,10 +327,7 @@ Example Inventory
Example Scan Profile
"""""""""""""""""""""

``
big_test, 192.168.124.[1:40],192.168.121.007,192.168.121.140,192.168.124.153,192.168.124.[150:200], test_first,test_second,test_third,one,two,three,four,five,six,seven,eight

``
``big_test, 192.168.124.[1:40],192.168.121.007,192.168.121.140,192.168.124.153,192.168.124.[150:200], test_first,test_second,test_third,one,two,three,four,five,six,seven,eight``

Example Scan Auths
"""""""""""""""""""""
Expand Down

0 comments on commit 11e1f7f

Please sign in to comment.