Adding more information to the man pages #896
Conversation
Signed-off-by: Joshua Schmid <[email protected]>
man/deepsea-customization.7
Outdated
| 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) |
There was a problem hiding this comment.
run-on line here, please add line breaks?
man/deepsea-customization.7
Outdated
|
|
||
| .B refresh_pillar | ||
|
|
||
| If you, for a reason, want to change this behavior. You can add a file to |
There was a problem hiding this comment.
s/for a reason/for any reason/
man/deepsea-customization.7
Outdated
| .SH More examples | ||
|
|
||
|
|
||
| Deepsea ships quite some non-default states that can be used. For example we offer alternating stage.0s which have either updates or reboots (or both) disabled. |
There was a problem hiding this comment.
s/quite some/a number of/
There was a problem hiding this comment.
run-on line, please add line breaks
man/deepsea-mines.7
Outdated
| 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/ |
There was a problem hiding this comment.
run-on line; please add line breaks
man/deepsea-stage-0.7
Outdated
| .SH Preface | ||
| .PP | ||
| Stage.0 behaves differently depending on the presence of a ceph cluster. On the first invocation, or the install phase, deepsea will run all operations in parallel to speep up the process. | ||
| Once you successfully deployed the cluster more caution is exercised and nodes are processed serially. The operation is chunked in three sections. |
There was a problem hiding this comment.
run-on lines; please add line breaks
man/deepsea-stage-0.7
Outdated
|
|
||
| .B Validation: | ||
| .RS | ||
| Deepsea performs a set of system validation tests before running the ramainder of the stage. |
man/deepsea-stage-0.7
Outdated
|
|
||
| .B Salt-Api | ||
| .RS | ||
| In order for openattic to establish a connection with salt, hence deepsea, the salt-api needs to be enabled. |
There was a problem hiding this comment.
Maybe rewrite the sentence like this? "Since openATTIC communicates with DeepSea via Salt, the salt-api service must be enabled and running for openATTIC to establish a connection with Salt."
man/deepsea-stage-0.7
Outdated
| .RE | ||
| .B Sync | ||
| .RS | ||
| When a new salt or deepsea version was installed, salt needs to make sure all modules are synced over to it's minions. |
There was a problem hiding this comment.
in English it's customary to capitalize proper nouns (e.g. Salt, DeepSea, Ceph) to distinguish them from their common noun counterparts (salt, deep sea, ceph(alopod))
http://grammar.yourdictionary.com/capitalization/rules-for-capitalizing-proper-nouns.html
man/deepsea-stage-0.7
Outdated
| .RE | ||
| .B Reboot | ||
| .RS | ||
| If Deepsea detects the need for a reboot, the master will reboot. This can be changed by adjusting |
There was a problem hiding this comment.
globally standardize DeepSea (instead of "deepsea" and "Deepsea") ?
man/deepsea-stage-0.7
Outdated
| .RE | ||
| .B Sync | ||
| .RS | ||
| After a potential update was applied to the master make sure to sync the modules and grains back to the minions |
There was a problem hiding this comment.
This sentence is vague . . . what does it mean to "apply a potential update"? How does one "sync the modules and grains back to the minions" ?
man/deepsea-stage-0.7
Outdated
| .SS Minions | ||
| .B Installation of common packages | ||
| .RS | ||
| Deepsea installs packages are... (shouldn't this acutally go in the specfile?) |
There was a problem hiding this comment.
This sentence is incomplete?
|
@jschmid1 I started reviewing, but cannot see a lot of the text. Can you please wrap the lines? Then, if you like, I can take another look. |
Signed-off-by: Joshua Schmid <[email protected]>
man/deepsea-customization.7
Outdated
| .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. |
There was a problem hiding this comment.
colon after "do" instead of full-stop
man/deepsea-stage-5.7
Outdated
| .RS | ||
| If you remove a service from your policy.cfg and apply it to the pillar by running stage.2 | ||
| .B (see deepsea-stage-2 (7)) | ||
| running stage.5 will remove this service and all it's traces from the node. |
There was a problem hiding this comment.
"it's" should be its, but could be reworded.... "remove all traces of the service from the node"
man/deepsea-stage-5.7
Outdated
| DeepSea stage 5 \- a deeper insight | ||
| .SH DESCRIPTION | ||
| .B DeepSea Stage 5 (Removal) | ||
| is a Salt orchestration that deploys the non-core services of ceph. |
There was a problem hiding this comment.
is a Salt orchestration that removes services.
Separate comment: I think role may still be less confusing than service. Since systemd enables/disables services. Roles are greater since they include configuration files.
man/deepsea-stage-3.7
Outdated
| This option tells you if a Developer Environment is expected. Setting this option bypasses some validations that | ||
| would lead to insufficient replication or data insafety. | ||
| Do not set this option in production. | ||
|
|
There was a problem hiding this comment.
Might want to mention that DEV_ENV can be set as either an environment variable or pillar variable.
Some rewording:
Set this option to 'true' for development environments. Some validations will be bypassed such as requiring minimums for Ceph monitors and storage nodes.
| * mgrs | ||
|
|
||
| * firewall | ||
| Verify if the neccessary ports for ceph are open in the firewall. |
There was a problem hiding this comment.
No ports are actually checked. The default chains are checked for default rules.
There was a problem hiding this comment.
So we are actually checking the negative -> if the ports are not closed.
Signed-off-by: Joshua Schmid <[email protected]>
Signed-off-by: Joshua Schmid <[email protected]>
|
rebase this patch |
Adding
Signed-off-by: Joshua Schmid [email protected]