Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

YaST Configuration Management

Workflow Status Jenkins Status Coverage Status Code Climate Issue Count

This module allows AutoYaST and Firstboot to delegate part of the configuration to a Software Configuration Management system. Salt and Puppet are supported.

How It Works

Basically, this module takes care of setting up the selected configuration management system (Salt or Puppet) and running it in order to update the system's configuration. It supports working on client/master or masterless modes and it can be combined with AutoYaST and Yast Firstboot. Even a standalone mode is available.

Depending on the module's configuration, it will take care of:

  • Installing the required packages.
  • Retrieving authentication keys (when running in client/master mode).
  • Fetching any additional data which may be needed (Salt states, pillars or formulas or Puppet modules).
  • Updating Salt/Puppet configuration and running them.

Module Configuration

YaST Configuration Management needs some configuration in order to know how to proceed. The snippets below can be embedded into an AutoYaST profile or in the Firstboot configuration (/etc/YaST2/firstboot.xml).

Client/Master

When running in client/master mode, the configuration management system will need to connect to a master server. For authentication, the client must use a pair of public/private keys which can be stored on a server, a hard drive or even on an USB stick. Alternatively, the user might prefer to let the client generate a new pair of keys and authorize them on the fly.

<configuration_management>
  <type>salt</type> <!-- you can use "puppet" too -->
  <master>my-salt-server.example.net</master>
  <auth_attempts config:type="integer">5</auth_attempts>
  <auth_time_out config:type="integer">10</auth_time_out>
  <keys_url>usb:/</keys_url> <!-- you can use HTTP, FTP... -->
</configuration_management>

Masterless Mode

If you do not want to set up a master server, you can instruct YaST Configuration Management to run in masterless mode retrieving the required data from elsewhere.

<configuration_management>
  <type>salt</type> <!-- you can use "puppet" -->
  <states_url>http://myserver.example.net/states.tgz</states_url>
  <pillar_url>http://myserver.example.net/pillar.tgz</pillar_url> <!-- optional -->
</configuration_management>

Firstboot Integration

The Firstboot module offers integration with YaST Configuration Management through a client called firstboot_configuration_management. So in order to use this module in firstboot you need to write a <configuration_management/> section containing the configuration options and add the client to the required workflow. In the example below, only the relevant parts are shown:

WARNING: Only Salt is supported in firstboot.

<?xml version="1.0"?>
<productDefines xmlns="http://www.suse.com/1.0/yast2ns" 
  xmlns:config="http://www.suse.com/1.0/configns">

  <configuration_management>
    <type>salt</type>
    <!-- Default Salt Formulas directories -->
    <formulas_sets config:type="list">
      <listentry>
        <metadata_root>/usr/share/susemanager/formulas/metadata</metadata_root>
        <states_root>/usr/share/susemanager/formulas/states</states_root>
        <pillar_root>/srv/susemanager/formula_data</pillar_root>
      </listentry>
      <listentry>
        <metadata_root>/usr/share/salt-formulas/metadata</metadata_root>
        <states_root>/usr/share/salt-formulas/states</states_root>
        <pillar_root>/srv/salt-formulas/pillar</pillar_root>
      </listentry>
      <listentry>
        <metadata_root>/srv/formula_metadata</metadata_root>
      </listentry>
    </formulas_sets>
    <states_roots config:type="list">
      <listentry>/srv/salt</listentry>
    </states_roots>
    <!-- Default Salt Formulas pillar data directory  -->
    <pillar_root>/srv/pillar</pillar_root>
  </configuration_management>

  <!-- more stuff -->

  <workflows  config:type="list">
    <workflow>
      <stage>firstboot</stage>
      <label>Configuration</label>
      <mode>installation</mode>
      <modules  config:type="list">
        <!-- other modules -->
        <module>
          <label>Finish Setup</label>
          <name>firstboot_configuration_management</name>
        </module>
      </modules>
      <!-- and more modules -->
    </workflow>
  </workflows>
</productDefines>

Salt Formulas Forms Support

Salt Formulas Forms are supported. If you find out that some feature is missing, please, open a bug report.

The supported widget types are listed in the {Y2ConfigurationManagement::Salt::FormBuilder::INPUT_WIDGET_CLASS} constant. Additionally, groups (group and namespace) and collections (edit-group) are supported too.

Options Reference

Name Type Provisioner Mode Description
type string - all Configuration Management System (salt or puppet)
master string all client Master server (if not set, it will run as masterless
auth_attempts integer all client Number of attempts when connecting to the master server
auth_time_out integer all client Time (in seconds) between attempts to connect to the master
enable_services boolean all client Enable the configuration management service at the end
formulas_roots list(string) salt all List of directories to search for Salt formulas
states_roots list(string) salt all List of directories to search for Salt states
pillar_root string salt all Path to write the Salt Pillar content
pillar_url string salt masterless URL to get Pillar content from
keys_url string all masterless URL to get authentication keys from
states_url string salt masterless URL to get the Salt states from
modules_url list(string) puppet masterless URL to get Puppet modules from
enabled_states list(string) salt masterless List of states/formulas to apply
log_level string all all Log level when running the provisioner (default to 'info')

About

Configuration management module for Salt and Puppet

Resources

License

Packages

No packages published

Languages