Work in progress

amousset · Feb 16, 2017 · 3500009 · 3500009
1 parent 3f22bf1
commit 3500009
Show file tree

Hide file tree

Showing 37 changed files with 30 additions and 170 deletions.
diff --git a/techniques/applications/apacheReverseProxy/2.0/metadata.xml b/techniques/applications/apacheReverseProxy/2.0/metadata.xml
@@ -14,13 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-This is the Apache reverse proxy installation Technique.
-Compatibility : Linux Red Hat like, Debian like
-
-It is intended to set up Apache as a reverse proxy server, for example to expose
-application server data to the outside or to centralize HTTP ressources in one point.
--->
 <TECHNIQUE name="HTTP Reverse Proxy (Apache)">
   <DESCRIPTION>This technique will configure the Apache HTTP server as a reverse proxy.
 

diff --git a/techniques/applications/apacheServer/3.0/metadata.xml b/techniques/applications/apacheServer/3.0/metadata.xml
@@ -14,16 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the Apache installation PT.
-    Compatibility : Linux Red Hat like, Debian like
-
-It is intended to check if Apache is installed and install it if not,
-then check if it is started on boot.
--
-It then adds apache to the boot init scripts if not already set to start on boot.
--->
-<TECHNIQUE name="Apache 2 HTTP server">
+<TECHNIQUE name="HTTP server (Apache)">
   <DESCRIPTION>This technique will configure the Apache HTTP server and ensure it is running.
 
   It will ensure the "apache2" package is installed (via the appropriate packaging tool for each OS), ensure the service is running and start it if not and ensure the service is configured to run on initial system startup.

diff --git a/techniques/applications/aptPackageInstallation/4.0/metadata.xml b/techniques/applications/aptPackageInstallation/4.0/metadata.xml
@@ -14,15 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the aptPackageInstallation PT.
-    Compatibility : Linux Debian like
-
-It is intended to install the defined packages, by OS,
-and to ensure certain parameters are met, such as the
-presence of a package, and if not met to enforce them.
--->
-
 <TECHNIQUE name="Package management for Debian / Ubuntu / APT systems">
   <DESCRIPTION>This technique operates on individual packages.
 

diff --git a/techniques/applications/aptPackageManagerSettings/3.1/metadata.xml b/techniques/applications/aptPackageManagerSettings/3.1/metadata.xml
@@ -14,16 +14,8 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the APT Package Manager Configuration PT.
-    Compatibility : Debian like
-
-It is intended to set a bunch of options commonly
-appreciated by administrators on the APT package
-manager, and eventually enforce them.
--->
-<TECHNIQUE name="APT package manager configuration">
-  <DESCRIPTION>This technique configure the APT package manager.</DESCRIPTION>
+<TECHNIQUE name="Package manager configuration (APT)">
+  <DESCRIPTION>This technique configures the APT package manager.</DESCRIPTION>
 
   <BUNDLES>
     <NAME>check_apt_settings</NAME>

diff --git a/techniques/applications/packageManagement/1.0/metadata.xml b/techniques/applications/packageManagement/1.0/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Package management">
+<TECHNIQUE name="Packages">
   <DESCRIPTION>This technique operates on individual packages.
 
   It will ensure that the defined packages are in the desired state using the appropriate package manager.</DESCRIPTION>

diff --git a/techniques/applications/repoGpgKeyManagement/1.0/metadata.xml b/techniques/applications/repoGpgKeyManagement/1.0/metadata.xml
@@ -20,7 +20,7 @@
 
 -->
 
-<TECHNIQUE name="Repository GPG Key Management for RPM / APT Systems">
+<TECHNIQUE name="Package Repository Keys">
 
   <!-- This description is displayed in detailed views in the interface.
      It should be used to describe what this Technique does, in detail.

diff --git a/techniques/applications/zmdPackageManagerSettings/3.0/metadata.xml b/techniques/applications/zmdPackageManagerSettings/3.0/metadata.xml
@@ -13,7 +13,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
-<TECHNIQUE name="RUG / YaST package manager configuration (ZMD)">
+<TECHNIQUE name="Package manager configuration (RUG/YaST/ZMD)">
   <DESCRIPTION>This technique configures the RUG and YaST package manager using Novell's ZMD.</DESCRIPTION>
   <MULTIINSTANCE>true</MULTIINSTANCE>
   <COMPATIBLE>

diff --git a/techniques/applications/zypperPackageManagerRepositories/1.0/metadata.xml b/techniques/applications/zypperPackageManagerRepositories/1.0/metadata.xml
@@ -13,7 +13,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
-<TECHNIQUE name="Zypper package repositories management">
+<TECHNIQUE name="Package repositories (Zypper)">
   <DESCRIPTION>This technique configures repositories for Zypper package manager.</DESCRIPTION>
 
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/applications/zypperPackageManagerSetup/1.0/metadata.xml b/techniques/applications/zypperPackageManagerSetup/1.0/metadata.xml
@@ -13,8 +13,8 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
-<TECHNIQUE name="Zypper package manager setup">
-  <DESCRIPTION>This technique setups Zypper package manager.</DESCRIPTION>
+<TECHNIQUE name="Package manager configuration (Zypper)">
+  <DESCRIPTION>This technique configures Zypper package manager.</DESCRIPTION>
 
   <COMPATIBLE>
     <OS version=">= 10 SP1 (Agama Lizard)">SuSE LES / DES / OpenSuSE</OS>

diff --git a/techniques/fileConfiguration/fileManagement/4.0/metadata.xml b/techniques/fileConfiguration/fileManagement/4.0/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Manage files and folders">
+<TECHNIQUE name="File and directory basics">
   <DESCRIPTION>Make sure that files and folders exist, and set their permissions</DESCRIPTION>
 
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/fileConfiguration/fileSecurity/filesPermissions/2.1/metadata.xml b/techniques/fileConfiguration/fileSecurity/filesPermissions/2.1/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Set the permissions on files">
+<TECHNIQUE name="File permissions">
   <DESCRIPTION>Set the permissions on files</DESCRIPTION>
 
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/fileDistribution/category.xml b/techniques/fileDistribution/category.xml
@@ -15,7 +15,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
 <xml>
-    <name>Distributing files</name>
+    <name>Files Distribution</name>
     <description>
         Send files to servers.
     </description>

diff --git a/techniques/fileDistribution/checkGenericFileContent/7.0/metadata.xml b/techniques/fileDistribution/checkGenericFileContent/7.0/metadata.xml
@@ -14,10 +14,9 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Enforce a file content">
+<TECHNIQUE name="File content">
   <DESCRIPTION>Checks if a file matches a given content and if not, updates it</DESCRIPTION>
 
-  <!--  <CONFIGURATIONPOLICY>false</CONFIGURATIONPOLICY> -->
   <MULTIINSTANCE>true</MULTIINSTANCE>
   <COMPATIBLE>
     <OS version=">= 4 (Etch)">Debian</OS>

diff --git a/techniques/fileDistribution/copyGitFile/2.1/metadata.xml b/techniques/fileDistribution/copyGitFile/2.1/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Download a file from the shared folder">
+<TECHNIQUE name="File download (from the policy server)">
   <DESCRIPTION>This technique ensure that some files are the copy of files on the shared folder of the Rudder Root Server, and let you optionally execute a command if the content of the file was modified</DESCRIPTION>
 
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/fileDistribution/downloadFile/3.0/metadata.xml b/techniques/fileDistribution/downloadFile/3.0/metadata.xml
@@ -14,16 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the downloadFile PT.
-    Compatibility : Linux Red Hat like, Debian like
-
-It is intended to download a file from a curl
-supported source (such as HTTP) and store it on
-the given destination.
--->
-
-<TECHNIQUE name="Download a file">
+<TECHNIQUE name="File download (HTTP)">
   <DESCRIPTION>This technique downloads a file from a server.
 
   It takes a cURL compatible source (HTTP/FTP/...) and a destination on the target host.

diff --git a/techniques/fileDistribution/manageKeyValueFile/1.0/metadata.xml b/techniques/fileDistribution/manageKeyValueFile/1.0/metadata.xml
@@ -14,7 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!-- This technique lets user define a key-value in a file -->
 <TECHNIQUE name="Manage keys-values in file">
   <DESCRIPTION>Manage keys-values in file</DESCRIPTION>
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/jobScheduling/jobScheduler/2.0/metadata.xml b/techniques/jobScheduling/jobScheduler/2.0/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Job scheduler">
+<TECHNIQUE name="Jobs">
   <DESCRIPTION>Runs commands, optionally in the background, optionally with a random distribution across nodes. The command will be run on all nodes, with execution time spread over the period selected. Execution time will remain the same on each node, but will appear random across all nodes.</DESCRIPTION>
   <COMPATIBLE>
     <OS>Every OS</OS>

diff --git a/techniques/systemSettings/misc/clockConfiguration/3.1/metadata.xml b/techniques/systemSettings/misc/clockConfiguration/3.1/metadata.xml
@@ -15,7 +15,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!-- This technique sets generalist clock parameters like NTP servers and timezones -->
 <TECHNIQUE name="Time settings">
   <DESCRIPTION>Configure system clock (automatic updates via NTP, time zone, ...)</DESCRIPTION>
   <COMPATIBLE>

diff --git a/techniques/systemSettings/misc/genericCommandVariableDefinition/3.0/metadata.xml b/techniques/systemSettings/misc/genericCommandVariableDefinition/3.0/metadata.xml
@@ -13,7 +13,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
-<TECHNIQUE name="Generic CFEngine Command variable definition">
+<TECHNIQUE name="Variable from command output (string)">
   <DESCRIPTION>Configures a generic CFEngine variable in a common bundle from the output of an executable, to be used in another Technique. This Technique does nothing by itself, you must reuse the variable(s) you will create here in another Technique with the form: $(generic_cmd_var_def.variablename)</DESCRIPTION>
   <COMPATIBLE>
     <OS>Every OS</OS>

diff --git a/techniques/systemSettings/misc/genericVariableDefinition/2.0/metadata.xml b/techniques/systemSettings/misc/genericVariableDefinition/2.0/metadata.xml
@@ -14,8 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!-- This technique sets generalist clock parameters like NTP servers and timezones -->
-<TECHNIQUE name="Generic CFEngine variable definition">
+<TECHNIQUE name="Variable (string)">
   <DESCRIPTION>Configures a generic CFEngine variable in a common bundle, to be used in another Technique. This Technique does nothing by itself, you must reuse the variable(s) you will create here in another Technique with the form: ${generic_variable_definition.variablename}</DESCRIPTION>
   <COMPATIBLE>
     <OS>Every OS</OS>

diff --git a/techniques/systemSettings/misc/partitionSizeMonitoring/3.0/metadata.xml b/techniques/systemSettings/misc/partitionSizeMonitoring/3.0/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Monitor partition size">
+<TECHNIQUE name="Partition size monitoring">
   <DESCRIPTION>Execute command(s) when partition free space gets under desired threshold</DESCRIPTION>
 
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/systemSettings/misc/variableFromJsonFile/1.0/metadata.xml b/techniques/systemSettings/misc/variableFromJsonFile/1.0/metadata.xml
@@ -14,8 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!-- This technique sets generalist clock parameters like NTP servers and timezones -->
-<TECHNIQUE name="CFEngine variable definition using a JSON file">
+<TECHNIQUE name="Variable from a JSON file (dict)">
   <DESCRIPTION>Downloads a JSON file from shared-files and reads it into CFEngine variables. You can use these variables in the form ${your_namespace.variable_name}</DESCRIPTION>
   <MULTIINSTANCE>true</MULTIINSTANCE>
   <COMPATIBLE>

diff --git a/techniques/systemSettings/networking/dnsConfiguration/3.0/metadata.xml b/techniques/systemSettings/networking/dnsConfiguration/3.0/metadata.xml
@@ -14,12 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the DNS configuration PT.
-    Compatibility : Debian like, RedHat like, SuSE like and Windows
-
-It is intended to check if the required DNS entries are set.
--->
 <TECHNIQUE name="Name resolution">
   <DESCRIPTION>Configure DNS lookups</DESCRIPTION>
   <COMPATIBLE>

diff --git a/techniques/systemSettings/networking/hostsConfiguration/2.0/metadata.xml b/techniques/systemSettings/networking/hostsConfiguration/2.0/metadata.xml
@@ -14,12 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the hosts configuration PT.
-    Compatibility : Debian like, RedHat like, SuSE like and Windows
-
-It is intended to check if the required hosts entries are set.
--->
 <TECHNIQUE name="Hosts settings">
   <DESCRIPTION>This technique configures the machine hosts file. Be careful: The IP address is used as the key reference for any edition and if multiple hosts have been specified with the same IP in the hosts file, the matching entry defined here will take precedence and erase all the other occurrences of the same IP</DESCRIPTION>
   <COMPATIBLE>

diff --git a/techniques/systemSettings/networking/nfsClient/3.0/metadata.xml b/techniques/systemSettings/networking/nfsClient/3.0/metadata.xml
@@ -14,13 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the NFS Client configuration PT.
-    Compatibility : Debian like, RedHat like, SuSE like
-
-It is intended to check if the NFS client is installed and if the
-required mount points are set with the right options.
--->
 <TECHNIQUE name="NFS Client">
   <DESCRIPTION>Configure an NFS Client</DESCRIPTION>
   <COMPATIBLE>

diff --git a/techniques/systemSettings/networking/nfsServer/3.0/metadata.xml b/techniques/systemSettings/networking/nfsServer/3.0/metadata.xml
@@ -14,13 +14,6 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the NFS Server configuration PT.
-    Compatibility : Debian like, RedHat like, SuSE like
-
-It is intended to check if the NFS server is installed and if the
-required mount points are set with the right options.
--->
 <TECHNIQUE name="NFS Server">
   <DESCRIPTION>Configure a NFS server</DESCRIPTION>
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/systemSettings/networking/routingManagement/2.0/metadata.xml b/techniques/systemSettings/networking/routingManagement/2.0/metadata.xml
@@ -14,14 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the routingManagement PT.
-    Compatibility : Linux like, Windows
-
-It is intended to check the defined routes, by OS,
-and to ensure they are present if required.
--->
-<TECHNIQUE name="IPv4 routing management">
+<TECHNIQUE name="IPv4 routing">
   <DESCRIPTION>This technique operates on the system routing table.
 
   It will ensure that the defined routes are present, and will add them if required.</DESCRIPTION>

diff --git a/techniques/systemSettings/process/servicesManagement/3.0/metadata.xml b/techniques/systemSettings/process/servicesManagement/3.0/metadata.xml
@@ -14,16 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This it a process management PT.
-    It takes multivalued arguments to get name, min instances, max instances,
-    restart command and args of the processes to monitor.
-    It then accepts a global process blacklist to kill mercilessly.
-
-It then reports out of bounds process count numbers, restarts them if
-necessary and kill undesired processes.
--->
-<TECHNIQUE name="Services Management">
+<TECHNIQUE name="Services">
   <DESCRIPTION>Check and enforce the state of processes and services</DESCRIPTION>
   <COMPATIBLE>
     <OS version=">= 4 (Etch)">Debian</OS>

diff --git a/techniques/systemSettings/remoteAccess/sshConfiguration/5.0/metadata.xml b/techniques/systemSettings/remoteAccess/sshConfiguration/5.0/metadata.xml
@@ -14,20 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the SSH installation Technique.
-    Compatibility : Linux Red Hat like, Debian like
-
-It is intended to check if SSH is installed and install it if not,
-then check if it is started on boot.
-
-Then, it modifies if required the given configuration statements and if needed, restarts ssh.
-
-It then adds ssh to the boot init scripts if not already set to start on boot.
-
-This implemenation is intended as a reference for Technique development best practices.
--->
-<TECHNIQUE name="OpenSSH server">
+<TECHNIQUE name="SSH server (OpenSSH)">
 
   <DESCRIPTION>This technique will configure the SSH service and ensure it is running.
 

diff --git a/techniques/systemSettings/remoteAccess/sshKeyDistribution/3.0/metadata.xml b/techniques/systemSettings/remoteAccess/sshKeyDistribution/3.0/metadata.xml
@@ -14,13 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<!--
-    This is the SSH Key distribution Technique.
-    Compatibility : Linux Red Hat like, Debian like
-
-It is intended to check if all the required SSH keys are installed.
--->
-<TECHNIQUE name="SSH keys distribution">
+<TECHNIQUE name="SSH keys">
   <DESCRIPTION>This technique will check if the required SSH keys are present on a user directory.</DESCRIPTION>
   <COMPATIBLE>
     <OS version=">= 4 (Etch)">Debian</OS>

diff --git a/techniques/systemSettings/security/fileAlterationMonitoring/2.0/metadata.xml b/techniques/systemSettings/security/fileAlterationMonitoring/2.0/metadata.xml
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<TECHNIQUE name="Monitor a file or directory content">
+<TECHNIQUE name="File and directory monitoring">
   <DESCRIPTION>This technique checks wether a file or directory has changed between agent executions and report changes if any</DESCRIPTION>
 
   <MULTIINSTANCE>true</MULTIINSTANCE>

diff --git a/techniques/systemSettings/systemManagement/cronManagement/3.1/metadata.xml b/techniques/systemSettings/systemManagement/cronManagement/3.1/metadata.xml
@@ -13,7 +13,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 -->
-<TECHNIQUE name="Cron daemon configuration">
+<TECHNIQUE name="Cron Tasks">
   <DESCRIPTION>This technique enables you to set tasks (or "jobs") that will be launched regularily using crond.</DESCRIPTION>
   <COMPATIBLE>
     <OS version="System V and related">UNIX</OS>