Diffstat (limited to 'sitemodules/profiles/README.md')
1 files changed, 13 insertions, 56 deletions
diff --git a/sitemodules/profiles/README.md b/sitemodules/profiles/README.md
index 25ac564..e1b9b81 100644
@@ -4,80 +4,37 @@
1. [Setup - The basics of getting started with profiles](#setup)
- * [What profiles affects](#what-profiles-affects)
- * [Setup requirements](#setup-requirements)
* [Beginning with profiles](#beginning-with-profiles)
1. [Usage - Configuration options and additional functionality](#usage)
-1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
1. [Limitations - OS compatibility, etc.](#limitations)
-1. [Development - Guide for contributing to the module](#development)
-Start with a one- or two-sentence summary of what the module does and/or what
-problem it solves. This is your 30-second elevator pitch for your module.
-Consider including OS/Puppet version it works with.
-You can give more descriptive information in a second paragraph. This paragraph
-should answer the questions: "What does this module *do*?" and "Why would I use
-it?" If your module has a range of functionality (installation, configuration,
-management, etc.), this is the time to mention it.
+The profiles module defines functionality that is part of node roles. Profiles
+should be assigned to nodes by including them in the node's role class.
-### What profiles affects **OPTIONAL**
-If it's obvious what your module touches, you can skip this section. For
-example, folks can probably figure out that your mysql_instance module affects
-their MySQL instances.
-If there's more that they should know about, though, this is the place to mention:
-* A list of files, packages, services, or operations that the module will alter,
- impact, or execute.
-* Dependencies that your module automatically installs.
-* Warnings or other important notices.
-### Setup Requirements **OPTIONAL**
-If your module requires anything extra before setting up (pluginsync enabled,
-etc.), mention it here.
-If your most recent release breaks compatibility or requires particular steps
-for upgrading, you might want to include an additional "Upgrading" section
### Beginning with profiles
-The very basic steps needed for a user to get the module up and running. This
-can include setup steps, if necessary, or it can be an example of the most
-basic use of the module.
+To use a profile you should define its required parameters in hiera data and
+include the profile in the node's role class.
-This section is where you describe how to customize, configure, and do the
-fancy stuff with your module here. It's especially helpful if you include usage
-examples and code samples for doing things with your module.
+Usage is very specific to the particular profile classes. See the class
+documentation for the profiles you want to use.
-Here, include a complete list of your module's classes, types, providers,
-facts, along with the parameters for each. Users refer to this section (thus
-the name "Reference") to find specific details; most users don't read it per
-This is where you list OS compatibility, version compatibility, etc. If there
-are Known Issues, you might want to include them under their own heading here.
+#### Public classes
-Since your module is awesome, other users will want to play with it. Let them
-know what the ground rules for contributing are.
+*[`profiles::base`](#profiles-base): Setup the base functionality for a puppet managed node.
-## Release Notes/Contributors/Etc. **Optional**
-If you aren't using changelog, put your release notes here (though you should
-consider using changelog). You can also add any additional sections you feel
-are necessary or important to include here. Please use the `## ` header.
+This module is designed to be used on CAcert infrastructure only. It is not
+designed for reuse anywhere else. The CAcert infrastructure is described at https://infradocs.cacert.org/.