Skip to content

Commit

Permalink
Fixes #10692: Bad links, typo, images in french in intro chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
fanf committed May 3, 2017
1 parent 2bc92b4 commit 7639808
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 16 deletions.
2 changes: 1 addition & 1 deletion 00_introduction/01_presentation.txt
Expand Up @@ -74,7 +74,7 @@ policy ready to use, and a graphical rule editor.

image::./images/introduction/web_api_cli.png[Use what best feets your need: Web interface, API, or console]

Developers can script Rudder throught its APIs and security teams can check
Developers can script Rudder through its APIs and security teams can check
conformity level to their policies or inventory (both software and hardware) of a
server at any time.

Expand Down
25 changes: 12 additions & 13 deletions 00_introduction/20_key_features.txt
Expand Up @@ -14,7 +14,6 @@ Rudder is natively integrated with the supported OS (Linux, Windows, AIX - see
<<node-supported-os>>) so that it provides generic, abstract, OS independant
primitives to the user who can:

image::./images/introduction/core_techniques.png["Standard Technique Library", float="right"]

* install software in OS native packaging system (RPM on RHEL, Windows software
components, or even direct install from sources),
Expand All @@ -31,7 +30,7 @@ image::./images/introduction/core_techniques.png["Standard Technique Library", f
* manage service start-up at boot time and ensure that a service is correctly
running at any time, starting it up again if needed.

unfloat::[]
image::./images/introduction/core_techniques.png["Standard Technique Library", align="center"]

The simple primitives can be simply mixed and <<intro-rudder-extensibility,extended>> to provide
solutions for any and all of your unique use cases of software stacks,
Expand All @@ -43,7 +42,7 @@ The nominal working mode of Rudder is a **continuous verification** mode, which
makes Rudder manage the whole application life cycle and check that configurations
remain valid at any time.

image::./images/introduction/general_behavior_workflow.png[Define target, check, report, remediate]
image::./images/introduction/general_behavior_workflow.png["Define target, check, report, remediate", align="center"]

Rudder can also *continuously check* that rules are valid and *proactively* correct
any drift from the desired application state when needed. A *graphical reporting*
Expand All @@ -56,7 +55,7 @@ Understanding what the problem is is made simpler by the graphical reporting
which allows to drill down toward the technical root cause and see in a blink
where the drift comes from.

image::./images/introduction/rule_compliance_details.png[Fine grained reporting on configuration components]
image::./images/introduction/rule_compliance_details.png["Fine grained reporting on configuration components", align="center"]


==== Automatic inventory
Expand All @@ -73,13 +72,13 @@ used to defined coniguration rule targets. Typically, some configurations are
linked to the kind of server (physical or virtual), the quantity of RAM
available, the version of an OS library which contains a security bug, etc.

All of these data are also available <<rudder-api-integration, throught Rudder APIs>>.
All of these data are also available <<rudder-api-integration, through Rudder APIs>>.

==== REST API

All Rudder commands are available throught an exhaustive REST API. That API is
All Rudder commands are available through an exhaustive REST API. That API is
http://www.rudder-project.org/rudder-api-doc/[fully documented online] and can
be used to <<rudder-api-integration, quickly and smoothly integrate Rudder with you existing infrastructure>>.
be used to <<rudder-api-integration, quickly and smoothly integrate Rudder with your existing infrastructure>>.


==== Audit trace and Change Requests
Expand All @@ -88,12 +87,12 @@ Any change done thanks to Rudder in your infrastructure is automatically
recorded in an *Audit Log* which allows a full traceability of all changes.
That feature also allows rollbacks of the recorded change.

image::./images/introduction/audit_trace.png[Trace events and display changes]
image::./images/introduction/audit_trace.png["Trace events and display changes", align="center"]

All changes can be forced to go through a peer review or validation step and
so be part of a conformity process.

image::./images/introduction/change_request.png[Change Request]
image::./images/introduction/change_request.png["Change Request", align="center"]

The validation process can be externalized to third party ticketing system, like
a CMDB, so that it can integrated into an existing company workflow. This
Expand Down Expand Up @@ -127,24 +126,24 @@ more complexe (for example, import JSON data from a REST API).
For information, the following image provides a NON-exhaustive list of
available modules:

image::./images/introduction/generic_methods_list.png[Non exhaustive list of generic methods]
image::./images/introduction/generic_methods_list.png["Non exhaustive list of generic methods", align="center"]

These generic, unitary modules can be used to build new higher level,
OS independent, parametrizable configuration modules. By combining these module,
you are able to manage any configuration and build advanced configuration
policies for your IT services:

image::./images/introduction/rule_directive_generic_method_stack.png[Build your own configuration, matching your requirements]
image::./images/introduction/rule_directive_generic_method_stack.png["Build your own configuration, matching your requirements", align="center"]

The unitary configuration modules can be configured thanks to a high level
programming language:

image::./images/introduction/ncf_language.png[high level definition language]
image::./images/introduction/ncf_language.png["High level definition language", align="center"]

But the natural, common strategy to use them is with the provided graphical
editor which allows to use all the same modules, but with a web UI and
drag'n'drop. Of course, you can configure each unitary module to use data from
a node and behave specifically on each one.

image::./images/introduction/technique_editor_overview.png[Graphical Technique Editor - the simplest way to build new configuration]
image::./images/introduction/technique_editor_overview.png["Graphical Technique Editor - the simplest way to build new configuration", align="center"]

Expand Up @@ -14,6 +14,8 @@ The process of policy generation:
* Replace the old version of the policies by the new one for impacted node
* Restart the policy server on the Rudder central server is authorizations have changed

image::./images/objects-used-in-generation.png[Objects and parameters used in policy generation]

You can customize some of these actions and add new ones using the <<_server_event_hooks, Server Event Hooks>>.

image::./images/policy_generation.png[Status of policy generation]
Expand Down
2 changes: 1 addition & 1 deletion 80_extension_and_integration/20_Rudder_plugins.txt
Expand Up @@ -72,7 +72,7 @@ The project code source is documented to be didactic and provides:
Of course, you can look to the other open source plugins listed above to get
other, more involved example about how to do things.

You also can interact with Rudder developers throught the
You also can interact with Rudder developers through the
https://www.rudder-project.org/site/community/mailing-lists/[community] regular
communication channels.

2 changes: 1 addition & 1 deletion 80_extension_and_integration/40_Rudder_Integration.txt
Expand Up @@ -42,7 +42,7 @@ use iTop to understand the impact of such a drift for your IT services.

All the above plugins are using http://www.rudder-project.org/rudder-api-doc/[Rudder APIs]
under the hood to operate or get data from Rudders. Rudder APIs are as powerful
as the UI, and anything that can be done throught the main graphical interface
as the UI, and anything that can be done through the main graphical interface
can also be scripted away with the APIs.

The documentation provided on APIs is exhaustive, but here comes a summary of
Expand Down
Binary file modified images/introduction/build_run_devops.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/introduction/ncf_language.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/objects-used-in-generation.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7639808

Please sign in to comment.