Merge pull request #896 from jschmid1/wip-man-stage-n

 Adding more information to the man pages

man/deepsea-commands.7

@@ -118,22 +118,43 @@ salt-run state.orch ceph.redeploy.osds
 salt-run state.orch ceph.restart.ganesha
 .RS
 .RE
+salt-run state.orch ceph.restart.ganesha.lax
+.RS
+.RE
 salt-run state.orch ceph.restart.igw
 .RS
 .RE
+salt-run state.orch ceph.restart.igw.lax
+.RS
+.RE
 salt-run state.orch ceph.restart.mds
 .RS
 .RE
+salt-run state.orch ceph.restart.mds.lax
+.RS
+.RE
 salt-run state.orch ceph.restart.mgr
 .RS
 .RE
+salt-run state.orch ceph.restart.mgr.lax
+.RS
+.RE
 salt-run state.orch ceph.restart.mon
 .RS
 .RE
+salt-run state.orch ceph.restart.mon.lax
+.RS
+.RE
 salt-run state.orch ceph.restart.osd
 .RS
 .RE
+salt-run state.orch ceph.restart.osd.lax
+.RS
+.RE
 salt-run state.orch ceph.restart.rgw
+.RS
+.RE
+salt-run state.orch ceph.restart.rgw.lax
 .PP
 .SS STATES
 Salt States are the essential building blocks for running a series of steps on a single minion.  The state.apply is a Salt module that processes an
@@ -166,6 +187,12 @@ salt 'igw*' state.apply ceph.igw.keyring
 salt 'igw*' state.apply ceph.igw.restart
 .RS
 .RE
+salt 'igw*' state.apply ceph.igw.restart.force
+.RS
+.RE
+salt 'igw*' state.apply ceph.igw.restart.reload
+.RS
+.RE
 salt 'igw*' state.apply ceph.igw.sysconfig
 .RS
 .RE
@@ -183,6 +210,15 @@ salt 'storage*' state.apply ceph.osd.keyring
 salt 'storage*' state.apply ceph.osd.restart
 .RS
 .RE
+salt 'storage*' state.apply ceph.osd.restart.force
+.RS
+.RE
+salt 'storage*' state.apply ceph.osd.restart.controlled
+.RS
+.RE
+salt 'storage*' state.apply ceph.osd.restart.parallel
+.RS
+.RE
 salt 'storage*' state.apply ceph.osd.scheduler
 .RS
 .RE
@@ -210,6 +246,12 @@ salt 'rgw*' state.apply ceph.rgw.keyring
 salt 'rgw*' state.apply ceph.rgw.restart
 .RS
 .RE
+salt 'rgw*' state.apply ceph.rgw.restart.controlled
+.RS
+.RE
+salt 'rgw*' state.apply ceph.rgw.restart.force
+.RS
+.RE
 salt 'rgw*' state.apply ceph.rgw.users
 .RS
 .RE
@@ -288,6 +330,12 @@ salt 'ganesha*' state.apply ceph.ganesha.keyring
 salt 'ganesha*' state.apply ceph.ganesha.restart
 .RS
 .RE
+salt 'ganesha*' state.apply ceph.ganesha.restart.controlled
+.RS
+.RE
+salt 'ganesha*' state.apply ceph.ganesha.restart.force
+.RS
+.RE
 salt 'ganesha*' state.apply ceph.ganesha.service
 .RS
 .RE
@@ -310,6 +358,12 @@ salt 'mds*' state.apply ceph.mds.pools
 salt 'mds*' state.apply ceph.mds.restart
 .RS
 .RE
+salt 'mds*' state.apply ceph.mds.restart.controlled
+.RS
+.RE
+salt 'mds*' state.apply ceph.mds.restart.force
+.RS
+.RE
 salt 'mds*' state.apply ceph.mds
 .PP
 .RS
@@ -338,6 +392,12 @@ salt 'master_minion' state.apply ceph.mon.key
 salt 'mon*' state.apply ceph.mon.restart
 .RS
 .RE
+salt 'mon*' state.apply ceph.mon.restart.controlled
+.RS
+.RE
+salt 'mon*' state.apply ceph.mon.restart.force
+.RS
+.RE
 salt 'mon*' state.apply ceph.mon
 .PP
 .RS
@@ -365,6 +425,15 @@ salt 'openattic*' state.apply ceph.openattic.keyring
 salt 'openattic*' state.apply ceph.openattic.oaconfig
 .RS
 .RE
+salt 'openattic*' state.apply ceph.openattic.restart
+.RS
+.RE
+salt 'openattic*' state.apply ceph.openattic.restart.controlled
+.RS
+.RE
+salt 'openattic*' state.apply ceph.openattic.restart.force
+.RS
+.RE
 salt 'openattic*' state.apply ceph.openattic
 .PP
 .RS
@@ -531,6 +600,9 @@ salt '*' cephinspector.inspect
 salt '*' cephprocesses.check
 .RS
 .RE
+salt '*' cephprocesses.need_restart
+.RS
+.RE
 salt '*' cephprocesses.wait
 .PP
 salt '*' fs.btrfs_get_mountpoints_of_subvol subvol='@/var/lib/ceph'
@@ -1010,7 +1082,7 @@ salt-run changed.global
 salt-run changed.client
 .RS
 .RE
-salt-run changed.config [service]
+salt-run changed.config name=service
 .PP
 
 .SH AUTHOR

man/deepsea-customization.7

@@ -0,0 +1,87 @@
+.TH deepsea 7
+.SH NAME
+DeepSea customization
+.SH DESCRIPTION
+.B SLS 
+is short for Salt State Files. Those files are used to define a state you wish a node to be in.
+DeepSea has the concept of a 'default' file that will be executed when you invoke a salt state.
+For example when you want to execute a refresh on the pillar you do,
+
+.B salt -G 'deepsea:*' state.apply ceph.refresh
+
+internally this looks in
+
+.B /srv/salt/ceph/refresh/init.sls
+
+include:
+  - .{{ salt['pillar.get']('refresh_init', 'default') }}
+
+which looks for a value of 'refresh_init' in the pillar. When it's not found it defaults to the name 'default' 
+which is the name of the file in the directory. (Ignore the file extension)
+
+.B /srv/salt/ceph/refresh/default.sls
+
+refresh_pillar:
+  module.run:
+    - name: saltutil.refresh_pillar
+
+This advises salt to to execute the 
+.B module: saltutil 
+
+which with it's function 
+
+.B refresh_pillar
+
+If you, for any reason, want to change this behavior. You can add a file to 
+
+.B /srv/salt/ceph/refresh
+
+called 
+
+.B custom.sls
+
+and fill it with your desired module.
+
+In order to get your custom state loaded instead of the default one, you have to change the 
+
+.B refresh_init 
+
+value by editing
+
+.B /srv/pillar/ceph/stack/global.yml
+
+with
+
+.B refresh_init: custom
+
+To try it:
+
+.B salt -G 'deepsea:*' state.apply ceph.refresh
+
+will now load your custom.sls.
+
+.SH More examples
+
+
+DeepSea ships a number of non-default states that can be used. For example we offer alternating stage.0s which 
+have either updates or reboots (or both) disabled.
+
+To apply those you'd have to add 
+
+.B stage_prep_minion: default-no-update-no-reboot
+
+.B stage_prep_master: default-no-update-no-reboot
+
+to 
+
+.B /srv/pillar/ceph/stack/global.yml
+
+To find all alternating files for the stages go into 
+
+.B /srv/salt/ceph/stage/{0..5}/
+
+.SH AUTHOR
+Joshua Schmid <[email protected]>
+.SH SEE ALSO
+.BR deepsea (1),
+.BR deepsea (7),

man/deepsea-mines.7

@@ -0,0 +1,15 @@
+.TH deepsea 7
+.SH NAME
+DeepSea mines
+.SH DESCRIPTION
+.B Mines
+are a salt concept to collect arbitrary data from the Minions and store it on the master. For more information read https://docs.saltstack.com/en/latest/topics/mine/
+
+DeepSea uses mines to retrieve the information about the underlying hardware configuration 
+and about rbd images.
+
+.SH AUTHOR
+Joshua Schmid <[email protected]>
+.SH SEE ALSO
+.BR deepsea (1),
+.BR deepsea (7),