Files

James Shubin b01d453ae3 docs: Refresh documentation to provide a better new user experience

This does some cleanups and moves some things around for a better
experience. If you're an expert in this area, or are a new user who has
some feedback about their first impressions and experiences, please let
us know!

2017-11-25 20:45:57 -05:00

5.9 KiB

Raw Blame History

Resources

Here we list all the built-in resources and their properties. The resource primitives in mgmt are typically more powerful than resources in other configuration management systems because they can be event based which lets them respond in real-time to converge to the desired state. This property allows you to build more complex resources that you probably hadn't considered in the past.

In addition to the resource specific properties, there are resource properties (otherwise known as parameters) which can apply to every resource. These are called meta parameters and are listed separately. Certain meta parameters aren't very useful when combined with certain resources, but in general, it should be fairly obvious, such as when combining the noop meta parameter with the Noop resource.

You might want to look at the generated documentation for more up-to-date information about these resources.

Augeas: Manipulate files using augeas.
Exec: Execute shell commands on the system.
File: Manage files and directories.
Hostname: Manages the hostname on the system.
KV: Set a key value pair in our shared world database.
Msg: Send log messages.
Noop: A simple resource that does nothing.
Nspawn: Manage systemd-machined nspawn containers.
Password: Create random password strings.
Pkg: Manage system packages with PackageKit.
Svc: Manage system systemd services.
Timer: Manage system systemd services.
Virt: Manage virtual machines with libvirt.

Augeas

The augeas resource uses augeas commands to manipulate files.

Exec

The exec resource can execute commands on your system.

File

The file resource manages files and directories. In mgmt, directories are identified by a trailing slash in their path name. File have no such slash.

It has the following properties:

path: file path (directories have a trailing slash here)
content: raw file content
state: either exists (the default value) or absent
mode: octal unix file permissions
owner: username or uid for the file owner
group: group name or gid for the file group

Path

The path property specifies the file or directory that we are managing.

Content

The content property is a string that specifies the desired file contents.

Source

The source property points to a source file or directory path that we wish to copy over and use as the desired contents for our resource.

State

The state property describes the action we'd like to apply for the resource. The possible values are: exists and absent.

Recurse

The recurse property limits whether file resource operations should recurse into and monitor directory contents with a depth greater than one.

Force

The force property is required if we want the file resource to be able to change a file into a directory or vice-versa. If such a change is needed, but the force property is not set to true, then this file resource will error.

Hostname

The hostname resource manages static, transient/dynamic and pretty hostnames on the system and watches them for changes.

static_hostname

The static hostname is the one configured in /etc/hostname or a similar file. It is chosen by the local user. It is not always in sync with the current host name as returned by the gethostname() system call.

transient_hostname

The transient / dynamic hostname is the one configured via the kernel's sethostbyname(). It can be different from the static hostname in case DHCP or mDNS have been configured to change the name based on network information.

pretty_hostname

The pretty hostname is a free-form UTF8 host name for presentation to the user.

hostname

Hostname is the fallback value for all 3 fields above, if only hostname is specified, it will set all 3 fields to this value.

KV

The KV resource sets a key and value pair in the global world database. This is quite useful for setting a flag after a number of resources have run. It will ignore database updates to the value that are greater in compare order than the requested key if the SkipLessThan parameter is set to true. If we receive a refresh, then the stored value will be reset to the requested value even if the stored value is greater.

Key

The string key used to store the key.

Value

The string value to set. This can also be set via Send/Recv.

SkipLessThan

If this parameter is set to true, then it will ignore updating the value as long as the database versions are greater than the requested value. The compare operation used is based on the SkipCmpStyle parameter.

SkipCmpStyle

By default this converts the string values to integers and compares them as you would expect.

Msg

The msg resource sends messages to the main log, or an external service such as systemd's journal.

Noop

The noop resource does absolutely nothing. It does have some utility in testing mgmt and also as a placeholder in the resource graph.

Nspawn

The nspawn resource is used to manage systemd-machined style containers.

Password

The password resource can generate a random string to be used as a password. It will re-generate the password if it receives a refresh notification.

Pkg

The pkg resource is used to manage system packages. This resource works on many different distributions because it uses the underlying packagekit facility which supports different backends for different environments. This ensures that we have great Debian (deb/dpkg) and Fedora (rpm/dnf) support simultaneously.

Svc

The service resource is still very WIP. Please help us my improving it!

Timer

This resource needs better documentation. Please help us my improving it!

Virt

The virt resource can manage virtual machines via libvirt.

5.9 KiB Raw Blame History