Revision 10342619
Added by François ARMAND almost 7 years ago
| 00_introduction/01_presentation.txt | ||
|---|---|---|
|
== Introduction
|
||
|
|
||
|
[[what-is-rudder]]
|
||
|
=== What is Rudder?
|
||
|
|
||
|
image::./images/big-rudder-logo.png[Rudder logo]
|
||
| 10_installation/05_requirements/00_intro.txt | ||
|---|---|---|
|
|
||
|
[[rudder-installation-requirements]]
|
||
|
=== Requirements
|
||
|
|
||
| 10_installation/05_requirements/05_requirements.txt | ||
|---|---|---|
|
[[configure_the_network, Configure the network]]
|
||
|
|
||
|
=== Requirements
|
||
|
|
||
|
[[configure-the-network]]
|
||
|
==== Networking
|
||
|
|
||
|
===== Mandatory flows
|
||
| ... | ... | |
|
|
||
|
====
|
||
|
|
||
|
And this one is optional:
|
||
|
And this one is optional:
|
||
|
|
||
|
====
|
||
|
|
||
| ... | ... | |
|
These flows are used to add features to Rudder:
|
||
|
|
||
|
====
|
||
|
|
||
|
|
||
|
// include::../glossary/big-red-button.txt[]
|
||
|
|
||
|
include::../../glossary/port-5309-node.txt[]
|
||
| 10_installation/05_requirements/21_supported_architecture.txt | ||
|---|---|---|
|
[[nodes_supported_OS, the list of supported Operating Systems for Nodes]]
|
||
|
[[node-supported-os, the list of supported Operating Systems for Nodes]]
|
||
|
|
||
|
==== Fully supported Operating Systems
|
||
|
|
||
| ... | ... | |
|
====
|
||
|
|
||
|
|
||
|
[[Server_supported_OS, the list of supported Operating Systems for Root server]]
|
||
|
[[server-supported-os, the list of supported Operating Systems for Root server]]
|
||
|
|
||
|
===== For Rudder Root Server
|
||
|
|
||
| 10_installation/05_requirements/23_cloud.txt | ||
|---|---|---|
|
|
||
|
[[rudder-cloud-compatibility]]
|
||
|
==== Cloud compatibility
|
||
|
|
||
|
The agent provides an abstraction that permits a high level management of the infrastructure.
|
||
| 10_installation/05_requirements/30_hardware_specifications.txt | ||
|---|---|---|
|
|
||
|
[[node-hardware-requirements]]
|
||
|
==== Hardware specifications for Rudder Agent
|
||
|
|
||
|
Rudder agent has a very small footprint, and only consumes:
|
||
| ... | ... | |
|
* a few kB on the network to report
|
||
|
* around 100 MB of disk space for the installed files and the workspace
|
||
|
|
||
|
These figures will vary depending on your configuration (backup retention,
|
||
|
These figures will vary depending on your configuration (backup retention,
|
||
|
number of configured components to check, etc...).
|
||
|
|
||
|
|
||
|
[[server-hardware-requirements]]
|
||
|
==== Hardware specifications and sizing for Rudder Root Server
|
||
|
|
||
|
A dedicated server is strongly recommended, either physical or virtual with at least one dedicated core.
|
||
| ... | ... | |
|
For large installations, you should also tune the amount of RAM given to:
|
||
|
|
||
|
* the web application, as explained in the section
|
||
|
<<_configure_ram_allocated_to_jetty, about webapplication RAM configuration>>
|
||
|
<<_configure_ram_allocated_to_jetty, about webapplication RAM configuration>>
|
||
|
* PostgresSQL, as explained in the <<_optimize_postgresql_server, Optimize PostgreSQL Server>> section
|
||
|
|
||
|
===== Disk
|
||
| ... | ... | |
|
max_space = number of Directives * number of Nodes * retention duration in days * 400 kB
|
||
|
----
|
||
|
|
||
|
For example, a default installation with 500 nodes and an average of
|
||
|
50 Directives by node, should require between 14 GB and 38 GB of disk space for PostgreSQL.
|
||
|
For example, a default installation with 500 nodes and an average of
|
||
|
50 Directives by node, should require between 14 GB and 38 GB of disk space for PostgreSQL.
|
||
|
|
||
|
Follow the <<_reports_retention, Reports Retention>> section to configure the
|
||
|
retention duration.
|
||
| 10_installation/10_install_server/00_install_intro.txt | ||
|---|---|---|
|
|
||
|
[[install-server]]
|
||
|
=== Install Rudder Server
|
||
|
|
||
|
This chapter covers the installation of a Rudder Root Server, from the
|
||
|
specification of the underlying server, to the initial setup of the application.
|
||
|
|
||
|
Before all, you need to setup a server according to
|
||
|
Before all, you need to setup a server according to
|
||
|
<<Server_supported_OS, the server specifications>>. You should also
|
||
|
<<configure_the_network, configure the network>>. These topics are covered in the
|
||
|
Architecture chapter.
|
||
| ... | ... | |
|
depend of the amount of data you store in it, especially in the shared-files folder (files that will get
|
||
|
distributed to the agents using the "Download a file for the shared folder" Technique).
|
||
|
|
||
|
/var/log/rudder::
|
||
|
/var/log/rudder::
|
||
|
Report logs (/var/log/rudder/reports) size will depend on the amount of nodes you manage.
|
||
|
It is possible to reduce this drastically by unticking "Log all reports received to /var/log/rudder/reports/all.log"
|
||
|
under the Administration - Settings tab in the Rudder web interface. This will prevent Rudder from recording this logs
|
||
| 10_installation/11_install_agent/00_install_agent.txt | ||
|---|---|---|
|
|
||
|
[[install-agent]]
|
||
|
=== Install Rudder Agent
|
||
|
|
||
| 30_basic_administration/30_plugins.txt | ||
|---|---|---|
|
|
||
|
[[rpkg_plugin_management]]
|
||
|
[[plugins-management]]
|
||
|
|
||
|
=== Plugins
|
||
|
|
||
| 80_extension_and_integration/00_intro.txt | ||
|---|---|---|
|
|
||
|
[[extending_and_integrating_rudder]]
|
||
|
|
||
|
[[extending-and-integrating-rudder]]
|
||
|
== Rudder extension and integration with third party software
|
||
|
|
||
|
Rudder was thought from the begining to be a good citizen in you infrastructure.
|
||
| 80_extension_and_integration/20_Rudder_plugins.txt | ||
|---|---|---|
|
|
||
|
|
||
|
[[extending_rudder_with_plugins]]
|
||
|
|
||
|
[[extending-rudder-with-plugins]]
|
||
|
=== Extending Rudder with plugins
|
||
|
|
||
|
Rudder can be extended with Plugins so that new features or API endpoints are
|
||
| 80_extension_and_integration/40_Rudder_Integration.txt | ||
|---|---|---|
|
|
||
|
[[rudder_integration_in_infrastructure]]
|
||
|
|
||
|
[[rudder-integration]]
|
||
|
=== Rudder integration in your infrastructure
|
||
|
|
||
|
The other mains way to integrate Rudder into an existing infrastructure is
|
||
| ... | ... | |
|
a server managed by Rudder is drifting away from its expecting configuration, and
|
||
|
use iTop to understand the impact of such a drift for your IT services.
|
||
|
|
||
|
|
||
|
[[rudder-api-integration]]
|
||
|
==== Integrate Rudder thanks to its APIs
|
||
|
|
||
|
All the above plugins are using http://www.rudder-project.org/rudder-api-doc/[Rudder APIs]
|
||
Also available in: Unified diff
Fixes #10688: Use \"-\" in place of \"_\" in named reference in doc