Skip to content

Latest commit

 

History

History
400 lines (248 loc) · 13.2 KB

REFERENCE.md

File metadata and controls

400 lines (248 loc) · 13.2 KB
Raw

Reference

Table of Contents

Classes

Public Classes

Private Classes

  • systemd_journal_remote::gatewayd::config: This class configures the systemd-journal-gatewayd unit override
  • systemd_journal_remote::gatewayd::service: This class manages the systemd-journal-gatewayd service
  • systemd_journal_remote::remote::config: This class configures the [Remote] section of journal-remote.conf
  • systemd_journal_remote::remote::service: This class manages the systemd-journal-remote service
  • systemd_journal_remote::upload::config: This class configures the [Upload] section of journal-upload.conf
  • systemd_journal_remote::upload::service: This class manages the systemd-journal-upload service

Data types

Classes

systemd_journal_remote

This module manages and configures the systemd journal remote package

Parameters

The following parameters are available in the systemd_journal_remote class:

manage_package

Data type: Boolean

Manage the systemd-journal-remote package installation

Default value: true

package_name

Data type: String

The systemd-journal-remote package name to use

Default value: 'systemd-journal-remote'

package_ensure

Data type: Enum['latest', 'absent', 'present']

The systemd-journal-remote package state

Default value: present

systemd_journal_remote::gatewayd

This class manages and configures the systemd-journal-gatewayd service

Parameters

The following parameters are available in the systemd_journal_remote::gatewayd class:

command_path

Data type: Stdlib::Absolutepath

The service ExecStart command path

Default value: '/usr/lib/systemd/systemd-journal-gatewayd'

command_flags

Data type: Systemd_Journal_Remote::Gatewayd_Flags

The service ExecStart command flags to use

Default value: {}

manage_service

Data type: Boolean

Manage the journal-gatewayd service

Default value: true

service_enable

Data type: Boolean

Enable the journal-gatewayd service

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

The journal-gatewayd service ensure state

Default value: running

service_name

Data type: String

The journal-gatewayd service name

Default value: 'systemd-journal-gatewayd'

systemd_journal_remote::remote

This module manages and configures the systemd journal remote package

Parameters

The following parameters are available in the systemd_journal_remote::remote class:

command_path

Data type: Stdlib::Absolutepath

The service ExecStart command path

Default value: '/usr/lib/systemd/systemd-journal-remote'

command_flags

Data type: Systemd_Journal_Remote::Remote_Flags

The service ExecStart command flags to use

Default value: {}

manage_output

Data type: Boolean

Manage the creation of the default output paths (/var/log/journal/remote/)

Default value: false

manage_service

Data type: Boolean

Manage the systemd-journal-remote service

Default value: true

service_enable

Data type: Boolean

Enable the journal-remote service

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

Ensure the journal-remote service state

Default value: running

service_name

Data type: String

The journal-remote service name

Default value: 'systemd-journal-remote'

options

Data type: Systemd_Journal_Remote::Remote_Options

Config hash to configure the [Remote] options in journal-remote.conf

Default value: {}

systemd_journal_remote::upload

This class manages and configures the systemd journal upload service

Parameters

The following parameters are available in the systemd_journal_remote::upload class:

command_path

Data type: Stdlib::Absolutepath

The service ExecStart command path

Default value: '/usr/lib/systemd/systemd-journal-upload'

command_flags

Data type: Systemd_Journal_Remote::Upload_Flags

The service ExecStart command flags to use

Default value: {}

manage_service

Data type: Boolean

Manage the journal-upload service

Default value: true

manage_state

Data type: Boolean

Manage the journal-upload state file creation

Default value: false

service_enable

Data type: Boolean

Enable the journal-upload service

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

Ensure the journal-upload state

Default value: running

service_name

Data type: String

The journal-upload service name

Default value: 'systemd-journal-upload'

options

Data type: Systemd_Journal_Remote::Upload_Options

Config hash to configure the [Upload] options in journal-upload.conf

Default value: {}

Data types

Systemd_Journal_Remote::Gatewayd_Flags

Matches systemd gatewayd options in man systemd-journal-gatewayd

Alias of

Struct[{
    Optional['cert']         => Stdlib::Unixpath,
    Optional['key']          => Stdlib::Unixpath,
    Optional['trust']        => Variant[Stdlib::Unixpath, Enum['all']],
    Optional['system']       => Variant[Boolean, Enum['true', 'false']],
    Optional['user']         => Variant[Boolean, Enum['true', 'false']],
    Optional['merge']        => Variant[Boolean, Enum['true', 'false']],
    Optional['D']            => Stdlib::Unixpath,
    Optional['directory']    => Stdlib::Unixpath,
    Optional['file']         => String,
  }]

Systemd_Journal_Remote::Remote_Flags

Matches systemd remote options in man systemd-journal-remote

Alias of

Struct[{
    Optional['url']          => Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl],
    Optional['getter']       => String,
    Optional['listen-raw']   => String,
    Optional['listen-http']  => Variant[String, Integer[-3, -1]],
    Optional['listen-https'] => Variant[String, Integer[-3, -1]],
    Optional['key']          => Stdlib::Unixpath,
    Optional['cert']         => Stdlib::Unixpath,
    Optional['trust']        => Variant[Stdlib::Unixpath, Enum['all']],
    Optional['gnutls-log']   => String,
    Optional['output']       => Stdlib::Unixpath,
    Optional['gnutls-log']   => String,
    Optional['split-mode']   => Enum['none','host'],
    Optional['compress']     => Enum['yes','no'],
    Optional['seal']         => Enum['yes','no'],
  }]

Systemd_Journal_Remote::Remote_Options

Matches systemd remote options in man journal-remote.conf

Alias of

Struct[{
    Optional['Seal']                   => Enum['yes','no'],
    Optional['SplitMode']              => Enum['host','none'],
    Optional['ServerKeyFile']          => Stdlib::Absolutepath,
    Optional['ServerCertificateFile']  => Stdlib::Absolutepath,
    Optional['TrustedCertificateFile'] => Variant[Stdlib::Absolutepath, Enum['all']],
  }]

Systemd_Journal_Remote::Upload_Flags

Matches systemd upload options in man systemd-journal-upload

Alias of

Struct[{
    Optional['u']            => Variant[Stdlib::Host, Stdlib::HTTPUrl, Stdlib::HTTPSUrl],
    Optional['url']          => Variant[Stdlib::Host, Stdlib::HTTPUrl, Stdlib::HTTPSUrl],
    Optional['system']       => Variant[Boolean, Enum['true', 'false']],
    Optional['user']         => Variant[Boolean, Enum['true', 'false']],
    Optional['merge']        => Variant[Boolean, Enum['true', 'false']],
    Optional['D']            => Stdlib::Unixpath,
    Optional['directory']    => Stdlib::Unixpath,
    Optional['file']         => String,
    Optional['cursor']       => String,
    Optional['after-cursor'] => String,
    Optional['save-state']   => Stdlib::Unixpath,
    Optional['follow']       => Boolean,
    Optional['key']          => Variant[Enum['-'], Stdlib::Unixpath],
    Optional['cert']         => Variant[Enum['-'], Stdlib::Unixpath],
    Optional['trust']        => Variant[Enum['-', 'all'], Stdlib::Unixpath],
  }]

Systemd_Journal_Remote::Upload_Options

Matches systemd upload options in man journal-upload.conf

Alias of

Struct[{
    Optional['URL']                    => Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl],
    Optional['ServerKeyFile']          => Stdlib::Absolutepath,
    Optional['ServerCertificateFile']  => Stdlib::Absolutepath,
    Optional['TrustedCertificateFile'] => Stdlib::Absolutepath,
    Optional['NetworkTimeoutSec']      => Variant[Integer, String],
  }]