Work in progress

amousset · Mar 6, 2017 · d6a3672 · d6a3672
1 parent 111c9e6
commit d6a3672
Show file tree

Hide file tree

Showing 52 changed files with 70 additions and 157 deletions.
diff --git a/00_introduction/20_architecture.txt b/00_introduction/20_architecture.txt
@@ -1,4 +1,4 @@
-=== Rudder components
+==== Rudder components
 
 The Rudder infrastructure uses three types of machines: 
 

diff --git a/12_upgrade/00_upgrade.txt b/12_upgrade/00_upgrade.txt
@@ -10,30 +10,5 @@ automatically by packaging scripts. Therefore, you shouldn't have to do any
 upgrade procedures manually, but you will note that several data migrations
 occur during the upgrade process.
 
-==== Upgrade from Rudder 3.1, 3.2 or 4.0
 
-Migration from 3.1, 3.2 or 4.0 are supported, so you can upgrade directly to 4.1.
-
-[WARNING]
-
-====
-
-In Rudder 4.0, we changed the default communication protocol between agent and server,
-but still stay compatible with the old protocol. Hence, you can perfectly keep using
-pre-4.0 agents with a 4.0 or 4.1 server.
-
-However, some networking issues may appear when using 4.0 or 4.1 agents with older servers with the
-reverse DNS lookup option disabled in the settings (*Security* ->
-*Use reverse DNS lookups on nodes to reinforce authentication to policy server*).
-
-Therefore, you need to upgrade your server to 4.1 *before* upgrading the nodes so that the
-configuration distributed to the nodes include the use of the new protocol.
-
-====
-
-==== Upgrade from Rudder 3.0 or older
-
-Direct upgrades from 3.0.x and older are no longer supported on 4.1.
-If you are still running one of those, either on servers or nodes,
-please first upgrade to one of the supported versions above, and then upgrade to 4.1.
 
diff --git a/12_upgrade/05_caution.txt b/12_upgrade/05_caution.txt
@@ -1,4 +1,31 @@
-=== Caution cases
+=== Upgrade notes
+
+==== Upgrade from Rudder 3.0 or older
+
+Direct upgrades from 3.0.x and older are no longer supported on 4.1.
+If you are still running one of those, either on servers or nodes,
+please first upgrade to one of the supported versions above, and then upgrade to 4.1.
+
+==== Upgrade from Rudder 3.1, 3.2 or 4.0
+
+Migration from 3.1, 3.2 or 4.0 are supported, so you can upgrade directly to 4.1.
+
+[WARNING]
+
+====
+
+In Rudder 4.0, we changed the default communication protocol between agent and server,
+but still stay compatible with the old protocol. Hence, you can perfectly keep using
+pre-4.0 agents with a 4.0 or 4.1 server.
+
+However, some networking issues may appear when using 4.0 or 4.1 agents with older servers with the
+reverse DNS lookup option disabled in the settings (*Security* ->
+*Use reverse DNS lookups on nodes to reinforce authentication to policy server*).
+
+Therefore, you need to upgrade your server to 4.1 *before* upgrading the nodes so that the
+configuration distributed to the nodes include the use of the new protocol.
+
+====
 
 ==== Compatibility between Rudder agent 4.1 and older server versions
 
@@ -36,6 +63,22 @@ affects the reliability of policy enforcement, but may only temporarily affects
 reporting on the server.
 Read <<_rsyslog, perfomance notes>> about rsyslog for detailed information.
 
+==== Upgrade manually installed relays (installed before 3.0)
+
+With Rudder 2.11, there were no relay package and the configuration had to be done by hand.
+
+To migrate a manually installed relay to 3.1 using the package, run the following intructions:
+
+* Delete the previous Apache configuration file:
+
+** `/etc/httpd/conf.d/rudder-default.conf file` on RHEL-like
+** `/etc/apache2/sites-enabled/rudder-default` file on Debian-like
+** `/etc/apache2/vhosts.d/rudder-default.conf` file on SuSE 
+
+* Install the relay package named *rudder-server-relay*.
+
+This is enough to replace the relay configuration, and no change is needed on the root server.
+
 ==== Known issues
 
 * After upgrade, if the web interface has display problems, empty your navigator cache and/or logout/login.

diff --git a/12_upgrade/70_migrating_relays.txt b/12_upgrade/70_migrating_relays.txt
diff --git a/20_usage/00_usage_intro.txt b/20_usage/00_usage_intro.txt
@@ -1,4 +1,4 @@
-== Rudder Web Interface 
+== Web interface usage
 
 This chapter is a general presentation of the Rudder Web Interface. You will
 find how to authenticate in the application, a description of the design of the

diff --git a/21_node_management/20_node_management.txt b/21_node_management/20_node_management.txt
@@ -1,8 +1,8 @@
-== Node Management
+== Node management
 
 [[inventory, Node Inventory]]
 
-=== Node Inventory
+=== Node inventory
 
 Rudder integrates a node inventory tool which harvest useful information
 about the nodes. This information is used by Rudder to handle the nodes, and

diff --git a/21_node_management/22_search_nodes.txt b/21_node_management/22_search_nodes.txt
@@ -8,7 +8,7 @@ about the Nodes which have been already validated, and are managed by Rudder.
 
 [[quick-search, Quick Search]]
 
-==== Quick Search
+==== Quick search
 
 You might have noticed the small text area at the top of the Rudder interface:
 it is the Quick Search bar. Its purpose is to enable a user to easily search for

diff --git a/22_configuration_management/30_configuration_management.txt b/22_configuration_management/30_configuration_management.txt
@@ -1,3 +1,3 @@
-== Configuration Management
+== Configuration concepts
 
 
diff --git a/22_configuration_management/31_techniques.txt b/22_configuration_management/31_techniques.txt
@@ -47,5 +47,3 @@ is an advanced task which is currently not covered by this guide.
 
 ====
 
-==== Available Techniques
-
diff --git a/22_configuration_management/32_list_of_techniques.txt b/22_configuration_management/32_list_of_techniques.txt
diff --git a/22_configuration_management/37_validation_workflow.txt b/22_configuration_management/37_validation_workflow.txt
@@ -51,7 +51,7 @@ Here is a diagram about all those states and transitions:
 
 image::./images/workflows/States.png[]
 
-===== Change request management page 
+==== Change request management page 
 
 All Change requests can be seen on the /secure/utilities/changeRequests page.
 There is a table containing all requests, you can access to each of them by clicking on their id.

diff --git a/23_manage_your_it/00_manage_your_it.txt b/23_manage_your_it/00_manage_your_it.txt
@@ -1,3 +1,3 @@
 [[_manage_your_it]]
-== Configuration Policies
+== Configuration policies
 
diff --git a/3_usecases/0_usecases_intro.txt → ...e_your_it/5_usecases/0_usecases_intro.txt b/3_usecases/0_usecases_intro.txt → ...e_your_it/5_usecases/0_usecases_intro.txt
@@ -1,15 +1,15 @@
-== Usecases
+=== Usecases
 
 This chapter gives a few examples for using Rudder. We have no doubt that you'll
 have your own ideas, that we're impatient to hear about...
 
-=== Dynamic groups by operating system
+==== Dynamic groups by operating system
 
 Create dynamic groups for each operating system you administer, so that you can
 apply specific policies to each type of OS. When new nodes are added to Rudder,
 these policies will automatically be enforced upon them.
 
-=== Library of preventive policies
+==== Library of preventive policies
 
 Why not create policies for emergency situations in advance? You can then put
 your IT infrastructure in "panic" mode in just a few clicks.
@@ -19,7 +19,7 @@ resolution Directive to use your own internal DNS servers for normal situations,
 and a second, alternative Directive, to use Google's public DNS servers, in case
 your internal DNS servers are no longer available.
 
-=== Standardizing configurations
+==== Standardizing configurations
 
 You certainly have your own best practices (let's call them good habits) for
 setting up your SSH servers.
@@ -30,15 +30,15 @@ servers. SSH servers can then be stopped or reconfigured manually many times,
 Rudder will always restore your preferred settings and restart the SSH server in
 less than 5 minutes.
 
-=== Using Rudder as an Audit tool
+==== Using Rudder as an Audit tool
 
 Using Rudder as an Audit tool is useful if you do not want to make any changes on the system,
 temporarily (freeze period, etc.) or permanently.
 
 To use Rudder as an Audit tool without modifying any configuration on your systems,
 set the Policy Mode to *Audit* in the Settings, and do not allow overriding.
 
-=== Using Audit mode to validate a policy before applying it
+==== Using Audit mode to validate a policy before applying it
 
 Before applying a configuration policy to some systems (a new policy or a new system),
 you can switch the policy mode of the directive defining this policy or of the nodes

diff --git a/26_advanced_node_management/00_intro.txt b/26_advanced_node_management/00_intro.txt
@@ -0,0 +1,2 @@
+== Advanced Node management
+
diff --git a/4_advanced_usage/10_node_management.txt → ...ed_node_management/10_node_management.txt b/4_advanced_usage/10_node_management.txt → ...ed_node_management/10_node_management.txt
diff --git a/4_advanced_usage/11_node_install.txt → ...anced_node_management/11_node_install.txt b/4_advanced_usage/11_node_install.txt → ...anced_node_management/11_node_install.txt
diff --git a/...ced_usage/15_node_execution_frequency.txt → ...anagement/15_node_execution_frequency.txt b/...ced_usage/15_node_execution_frequency.txt → ...anagement/15_node_execution_frequency.txt
diff --git a/28_advanced_configuration_management/00_intro.txt b/28_advanced_configuration_management/00_intro.txt
@@ -0,0 +1,2 @@
+== Advanced configuration
+
diff --git a/...ced_usage/30_server_policy_generation.txt → ...anagement/30_server_policy_generation.txt b/...ced_usage/30_server_policy_generation.txt → ...anagement/30_server_policy_generation.txt
diff --git a/4_advanced_usage/30_technique_creation.txt → ...tion_management/30_technique_creation.txt b/4_advanced_usage/30_technique_creation.txt → ...tion_management/30_technique_creation.txt
diff --git a/4_advanced_usage/40_node_properties.txt → ...uration_management/40_node_properties.txt b/4_advanced_usage/40_node_properties.txt → ...uration_management/40_node_properties.txt
diff --git a/...sage/45_node_properties_in_directives.txt → ...ment/45_node_properties_in_directives.txt b/...sage/45_node_properties_in_directives.txt → ...ment/45_node_properties_in_directives.txt
diff --git a/...usage/47_node_properties_data_sources.txt → ...ement/47_node_properties_data_sources.txt b/...usage/47_node_properties_data_sources.txt → ...ement/47_node_properties_data_sources.txt
diff --git a/4_advanced_usage/50_script_in_directives.txt → ...on_management/50_script_in_directives.txt b/4_advanced_usage/50_script_in_directives.txt → ...on_management/50_script_in_directives.txt
diff --git a/4_advanced_usage/60_server_event_hooks.txt → ...tion_management/60_server_event_hooks.txt b/4_advanced_usage/60_server_event_hooks.txt → ...tion_management/60_server_event_hooks.txt
diff --git a/...dministration/00_administration_intro.txt → ...dministration/00_administration_intro.txt b/...dministration/00_administration_intro.txt → ...dministration/00_administration_intro.txt
@@ -1,4 +1,4 @@
-== Administration
+== Basic administration
 
 This chapter covers basic administration task of Rudder services like
 configuring some parameters of the Rudder policy server, reading the services

diff --git a/25_administration/10_archives.txt → 3_basic_administration/10_archives.txt b/25_administration/10_archives.txt → 3_basic_administration/10_archives.txt
diff --git a/25_administration/10_event_logs.txt → 3_basic_administration/10_event_logs.txt b/25_administration/10_event_logs.txt → 3_basic_administration/10_event_logs.txt
diff --git a/25_administration/20_policy_server.txt → 3_basic_administration/20_policy_server.txt b/25_administration/20_policy_server.txt → 3_basic_administration/20_policy_server.txt
diff --git a/25_administration/30_plugins.txt → 3_basic_administration/30_plugins.txt b/25_administration/30_plugins.txt → 3_basic_administration/30_plugins.txt
diff --git a/...nistration/50_services_administration.txt → ...nistration/50_services_administration.txt b/...nistration/50_services_administration.txt → ...nistration/50_services_administration.txt
diff --git a/4_advanced_usage/70_server_rest_api.txt → ...sic_administration/70_server_rest_api.txt b/4_advanced_usage/70_server_rest_api.txt → ...sic_administration/70_server_rest_api.txt
diff --git a/25_administration/80_user_management.txt → ...sic_administration/80_user_management.txt b/25_administration/80_user_management.txt → ...sic_administration/80_user_management.txt
diff --git a/4_administration/00_administration_intro.txt b/4_administration/00_administration_intro.txt
@@ -0,0 +1,5 @@
+== Advanced administration
+
+This chapter covers more advanced administration task of Rudder services.
+
+
diff --git a/6_handbook/10_database_maintenance.txt → 4_administration/10_database_maintenance.txt b/6_handbook/10_database_maintenance.txt → 4_administration/10_database_maintenance.txt
diff --git a/6_handbook/15_migration_backup_restore.txt → ...istration/15_migration_backup_restore.txt b/6_handbook/15_migration_backup_restore.txt → ...istration/15_migration_backup_restore.txt
diff --git a/6_handbook/20_application_tuning.txt → 4_administration/20_application_tuning.txt b/6_handbook/20_application_tuning.txt → 4_administration/20_application_tuning.txt
diff --git a/4_advanced_usage/21_password_management.txt → 4_administration/21_password_management.txt b/4_advanced_usage/21_password_management.txt → 4_administration/21_password_management.txt
diff --git a/...tration/70_system_password_management.txt → ...tration/70_system_password_management.txt b/...tration/70_system_password_management.txt → ...tration/70_system_password_management.txt
diff --git a/4_advanced_usage/75_separate_database.txt → 4_administration/75_separate_database.txt b/4_advanced_usage/75_separate_database.txt → 4_administration/75_separate_database.txt
diff --git a/4_advanced_usage/77_distributed_rudder.txt → 4_administration/77_distributed_rudder.txt b/4_advanced_usage/77_distributed_rudder.txt → 4_administration/77_distributed_rudder.txt
diff --git a/4_advanced_usage/90_server_migration.txt → 4_administration/90_server_migration.txt b/4_advanced_usage/90_server_migration.txt → 4_administration/90_server_migration.txt
diff --git a/...sage/91_mirroring_rudder_repositories.txt → ...tion/91_mirroring_rudder_repositories.txt b/...sage/91_mirroring_rudder_repositories.txt → ...tion/91_mirroring_rudder_repositories.txt
diff --git a/25_administration/991_monitoring.txt → 4_administration/991_monitoring.txt b/25_administration/991_monitoring.txt → 4_administration/991_monitoring.txt
diff --git a/25_administration/992_inventory.txt → 4_administration/992_inventory.txt b/25_administration/992_inventory.txt → 4_administration/992_inventory.txt
diff --git a/4_advanced_usage/00_advanced_usage_intro.txt b/4_advanced_usage/00_advanced_usage_intro.txt
diff --git a/6_handbook/0_handbook_intro.txt b/6_handbook/0_handbook_intro.txt
diff --git a/images/oneLine.png b/images/oneLine.png
diff --git a/images/rudder-datasources-description.png b/images/rudder-datasources-description.png
diff --git a/images/rudder-inventory-workflow.png b/images/rudder-inventory-workflow.png
diff --git a/images/spreadsheet-list-nodes.png b/images/spreadsheet-list-nodes.png
diff --git a/xsl/webhelp-common.xsl b/xsl/webhelp-common.xsl
@@ -40,7 +40,7 @@ xmlns:exsl="http://exslt.org/common"
     <xsl:param name="para.propagates.style" select="1"/>
     <xsl:param name="phrase.propagates.style" select="1"/>
     <xsl:param name="chunk.first.sections" select="1"/>
-    <xsl:param name="chunk.section.depth" select="2"/>
+    <xsl:param name="chunk.section.depth" select="1"/>
     <xsl:param name="use.id.as.filename" select="1"/>
     <xsl:param name="branding">not set</xsl:param>
     <xsl:param name="brandname">Rudder</xsl:param>
@@ -53,7 +53,7 @@ xmlns:exsl="http://exslt.org/common"
     <xsl:param name="part.autolabel" select="0"/>
     <xsl:param name="section.label.includes.component.label" select="1"/>
 
-    <xsl:param name="generate.section.toc.level" select="2"/>
+    <xsl:param name="generate.section.toc.level" select="1"/>
     <xsl:param name="component.label.includes.part.label" select="1"/>
     <xsl:param name="suppress.footer.navigation">0</xsl:param>
     <xsl:param name="callout.graphics.path"><xsl:value-of select="$webhelp.common.dir"/>images/callouts/</xsl:param>