Skip to content

Commit

Permalink
(SIMP-62) Update tags and grammar/spelling
Browse files Browse the repository at this point in the history 
for versions (which may be useless) and
included sample files

added changes per first code review

SIMP-29 #close #comment will generate V4 docs with tags
SIMP-29 #comment but readthedocs can't handle it
SIMP-62 #close

Change-Id: Ia0db9e3abbc05f767c91be258944ada532363f84
  • Loading branch information
Judy Johnson committed Jul 22, 2015
1 parent 05ae655 commit 98ed7f8
Show file tree
Hide file tree
Showing 48 changed files with 903 additions and 543 deletions.
4 changes: 3 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
rst/_build
docs/_build
_build
_build_v5
_build_v4
.sw[pnoqst]
builderrors
4 changes: 3 additions & 1 deletion .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ language: python
python:
- "2.7"
install: "pip install -q -r requirements.txt --use-mirrors"
script: sphinx-build -n -t simp_5_1_0 -b html -d _build/sphinx_cache docs/ _build/html
script:
- sphinx-build -n -t simp_4 -b html -d _build_v4/sphinx_cache docs/ _build_v4/html
- sphinx-build -n -t simp_5 -b html -d _build_v5/sphinx_cache docs/ _build_v5/html
13 changes: 7 additions & 6 deletions docs/user_guide/Client_Management.rst → docs/common/Client_Management.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The table below lists the steps to configure DHCP.
+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3. | Save and close the file. |
+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4. | Type **puppet agent --test --tags dhcpd** on the Puppet Master to apply the changes. |
| 4. | Type ``puppet agent -t --tags dhcpd`` on the Puppet Master to apply the changes. |
+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Table: DHCP Configuration Procedure
Expand Down Expand Up @@ -78,9 +78,9 @@ table lists the steps for a local setup.
| | |
| | - Delete any unnecessary zone stanzas (i.e. forwarding) if not necessary |
| | |
| | - Substitute in the FQDN of your domain for all occurrances of *your.domain* |
| | - Substitute in the FQDN of your domain for all occurrences of *your.domain* |
+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4. | Type **puppet agent --test --tags named** on the Puppet Master to apply the changes. |
| 4. | Type ``puppet agent -t --tags named`` on the Puppet Master to apply the changes. |
| | Validate DNS and ensure the /etc/resolv.conf is updated appropriately. |
+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 5. | If an error about the rndc.key appears when starting bind, copy the rndc.key to /etc then re-run the puppet command: |
Expand Down Expand Up @@ -111,11 +111,12 @@ The table below lists the steps to configure the kickstart.
| | |
| | NOTE: Use the following command to obtain a hashed value of the passwords that will be changed: |
| | |
| | **ruby -r 'digest/sha2' -e 'puts "password".crypt("$6$" + rand(36\*\*8).to\_s(36))'** |
| | ``ruby -r 'digest/sha2' -e 'puts "password".crypt("$6$" + rand(36\*\*8).to\_s(36))'`` |
+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3. | Type **chown root.apache /var/www/ks;/\*** to ensure that the ownership of all of the files is correct. |
| 3. | Type **chown root.apache /var/www/ks/\*** to ensure that all files are owned by root and in the apache group. |
+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 4. | Type **chmod 640 /var/www/ks;/\*** to change the permissions so the owner can read and write the file and the group can read only. When this is complete, the system is ready to kickstart the clients. |
| 4. | Type **chmod 640 /var/www/ks/\*** to change the permissions so the owner can read and write the file and the apache group can read only. |
| | Once this is complete, the system is ready to kickstart the clients. |
+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Table: Kickstart Configuration Procedure
Expand Down
27 changes: 27 additions & 0 deletions docs/common/File_Samples.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Appendix A - Sample Puppet Files
================================

This is a sample reverse (e.g. 0.0.10.db) file

.. literalinclude:: ../sample/122.168.192.db

This is a sample forward (e.g.your.domain) file

.. literalinclude:: ../sample/simp.net.db

This is a sample (e.g. dhcpd.conf) dhcpd file

.. literalinclude:: ../sample/dhcpd.conf

This is a sample named file

.. literalinclude:: ../sample/named.conf

This is a sample zones (e.g. your.domain) file

.. literalinclude:: ../sample/simp.net

This is a sample kickstart (e.g. pupclient_x86_64.cfg) file

.. literalinclude:: ../sample/pupclient_x86_64.cfg

0 docs/installation_guide/Introduction.rst → docs/common/Introduction.rst
View file
File renamed without changes.
24 changes: 20 additions & 4 deletions docs/installation_guide/PXE_Boot.rst → docs/common/PXE_Boot.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ appropriate repository created under the */var/www/yum* directory.

Once the model is ready, the default SIMP settings provide access to the
user's trusted subnets as defined in the
*/etc/puppet/hieradata/simp\_def.yaml* directory.
.. only:: not simp_4

*/etc/puppet/environments/simp/hieradata/simp\_def.yaml* directory.

.. only:: simp_4

*/etc/puppet/hieradata/simp\_def.yaml* directory.

The *pupclient\_x86\_64.cfg* file in the */var/www/ks;* directory is
used as an example in the following sections.
Expand Down Expand Up @@ -68,7 +74,7 @@ Manifest

Assuming that the Puppet server is being used, create and add the
following example code to a site manifest,
*/etc/puppet/modules/site/manifests/tftpboot.pp*. Keep in mind that the
*/etc/puppet/environment/simp/modules/site/manifests/tftpboot.pp*. Keep in mind that the
code varies based on the model being kickstarted.

Source Code for Setting Up TFTP on Puppet Server
Expand All @@ -93,7 +99,17 @@ TFTP Examples
Next, add the tftpboot site manifest to your puppet server node via
Hiera. If it does not already exist, create
*/etc/puppet/hieradata/hosts/your.server.fqdn.yaml*. Add the following


.. only:: not simp_4

*/etc/puppet/environments/simp/hieradata/hosts/your.server.fqdn.yaml*. Add the following


.. only:: simp_4

*/etc/puppet/hieradata/hosts/your.server.fqdn.yaml*. Add the following

example code to that yaml file.

Source Adding TFTP Site Manifest to Hiera
Expand All @@ -106,5 +122,5 @@ TFTP Examples
- 'site::tftpboot'
After updating the above file, type **puppet agent -t --tags tftpboot**
After updating the above file, type ``puppet agent -t --tags tftpboot``
on the Puppet server.
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'classic'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

Welcome to SIMP's documentation!
================================
.. only:: not simp_4_2_0
.. only:: not simp_4

This is the 5.1.0 release of the SIMP
product based on the 7.1 release of CentOS and Red Hat
Enterprise Linux (RHEL).


.. only:: simp_4_2_0
.. only:: simp_4

This is the 4.2.0 release of the SIMP
product based on the 6.6 release of CentOS and Red Hat
Expand Down

0 comments on commit 98ed7f8

Please sign in to comment.