Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #17771: Add link to further information in get started section #742

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ vagrant ssh server
sudo -i # to get a root access
----

We will use the `rudder` command that gives access to all Rudder actions.
We will use the `rudder` command that gives access to all xref:reference:reference:man.adoc[Rudder actions].

But first, let's explain a bit how things work on the agent.
We saw that the server generates an applicable configuration
Expand Down Expand Up @@ -64,4 +64,4 @@ image::./node-compliance.png["Node compliance", align="center"]
We have now finished our first policy application, from definition, using a new technique
or a built-in one, to the actual application on our Rudder server.

We will now dig a bit deeper on what the policy mode (we modified) is, and how to use it.
We will now dig a bit deeper on what the xref:reference:usage:configuration_management.adoc#_policy_mode_audit_enforce[policy mode] (we modified) is, and how to use it.
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ In this section you will:

====

You have just learnt to use the technique editor, which gives access to a broad
You have just learnt to use the xref:reference:usage:technique_editor.adoc#_techniques[Technique Editor], which gives access to a broad
range of building blocks for policies. To allow an easy configuration of
common system settings, Rudder also comes with a pre-defined set of techniques,
directly usable after installation.

Go to the *Configuration Management -> Directives* page. What is a directive? It is a simply a technique instance:
Go to the *Configuration Management -> Directives* page. What is a xref:reference:usage:configuration_management.adoc#_directives[Directive]? It is a simply a technique instance:
a technique plus some parameters, making it an applicable piece of configuration.

We will now configure the SSH service on our nodes using the dedicated pre-built technique.
Expand Down Expand Up @@ -61,7 +61,7 @@ it is applied to (we will see later which ones exactly).
Let's create a second directive, based on the technique we have just created (our demo user).
Use the filter to find it in the directive tree, still on the Directives page.

This time, we will change one of the general parameters by overriding the policy mode to Audit mode.
This time, we will change one of the general parameters by overriding the xref:reference:usage:configuration_management.adoc#_policy_mode_audit_enforce[policy mode] to Audit mode.

image::./audit.png["Audit mode", align="center"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In this section you will:
As you saw just before, we configured one of our directives in "Audit mode".
You may have guessed, according to its name, what this means.

Rudder has two available policy modes:
Rudder has two available xref:reference:usage:configuration_management.adoc#_policy_mode_audit_enforce[policy modes]:

* *Enforce*: it will modify the target system, if necessary, to achieve the expected state
* *Audit*: it will only report about non-compliant components
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ In this section you will:
Here you will learn to define a configuration policy through Rudder's technique editor.
A technique is a configuration policy template, that will need to be instantiated afterwards.

Go to *Configuration policy -> Techniques*. A configuration policy in Rudder is called a technique.
First, go to the xref:reference:usage:technique_editor.adoc#_techniques[Technique Editor] in *Configuration policy -> Techniques*. A configuration policy in Rudder is called a
xref:reference:usage:configuration_management.adoc#_techniques[technique].

You may have expected to start writing configuration code at this point. We won't!
(though it is also perfectly possible, but not the purpose of this guide).
Expand All @@ -33,7 +34,7 @@ How does this interface work?
* The center is the technique itself
* The right part is the "methods" column (and a category list to navigate within methods)

The methods will be the building blocks to our technique. You can think of them as small bricks
The xref:reference:reference:generic_methods.adoc[methods] will be the building blocks to our technique. You can think of them as small bricks
you will assemble into a technique. Let's start the configuration, click on the *User* category (in the lower right of the interface),
and click on the *User present* method.
It is now part of our technique's component list, with an orange warning asking for parameters. To provide them, click on the method instance in the technique.
Expand All @@ -44,7 +45,7 @@ image::./demo.png["demo user", align="center"]

We have defined a first policy! Let's add a second method: click on *Add methods*
in the lower left of the technique details, to display the list of available methods,
and navigate to the *User* category. Let's add a user description, with the *User fullname* method:
and navigate to the *User* category. Let's add a user description, with the xref:reference:reference:generic_methods.adoc#_user_fullname[User fullname method]:

image::./fullname.png["demo user's fullname", align="center"]

Expand All @@ -55,5 +56,5 @@ we can apply yo our machines.

As you can see it is really simple to define the expected state for our machines
through this editor.
Later in this guide, we will get back to the technique editor to explore the rest
Later in this guide, we will get back to the xref:reference:usage:technique_editor.adoc#_techniques[Technique Editor] to explore the rest
of the features, but you already know enough to define a lot of configuration policies.