Skip to content

Latest commit

 

History

History
391 lines (220 loc) · 9.41 KB

REFERENCE.md

File metadata and controls

391 lines (220 loc) · 9.41 KB
Raw

Reference

Table of Contents

Classes

Public Classes

  • zot: Main class, includes all other classes

Private Classes

  • zot::config: This class handles the zot configuration file.
  • zot::install: This class handles zot packages.
  • zot::service: This class handles the zot service

Functions

Classes

zot

Main class, includes all other classes

Examples

include zot

Parameters

The following parameters are available in the zot class:

archive_download_arch

Data type: String

Archictecture for the binary archive

archive_download_base

Data type: Stdlib::HTTPUrl

Base url for the binary archive

archive_download_os

Data type: String

OS for the binary archive

archive_download_url

Data type: Optional[Stdlib::HTTPUrl]

Optional alternative url for downloading the archive

archive_download_version

Data type: String

Verison for the binary archive

binary_path

Data type: Stdlib::Unixpath

Path where the binary should be/is installed

config_dir

Data type: Stdlib::Unixpath

Directory to place the configuration files

config_dist_spec_version

Data type: String

Dist spec version set in the configuration file

config_epp_parameters

Data type: Hash

Hash with parameters to hash to the custom epp file

config_epp_template

Data type: Optional[String]

Optional epp template for the configuration file

config_file

Data type: Stdlib::Unixpath

Full path to place the configuration file

config_hash

Data type: Optional[Hash]

Optional config hash that will be converted to yaml for the config file

config_http

Data type: Hash

Hash containing the http section in the config file

data_dir

Data type: Stdlib::Unixpath

Directory where to store the zot data

config_log

Data type: Hash

Hash containing the log section in the config file

config_extensions_lint

Data type: Optional[Hash]

Hash containing the lint extension configuration in the config file

config_extensions_metrics

Data type: Optional[Hash]

Hash containing the metrics extension configuration in the config file

config_extensions_scrub

Data type: Optional[Hash]

Hash containing the scrub extension configuration in the config file

config_extensions_search

Data type: Optional[Hash]

Hash containing the search extension configuration in the config file

config_extensions_sync

Data type: Optional[Hash]

Hash containing the sync extension configuration in the config file

config_extensions_ui

Data type: Optional[Hash]

Hash containing the ui extension configuration in the config file

Default value: undef

config_storage

Data type: Hash

Hash containing the storage section in the config file

gid

Data type: Accounts::User::Uid

GID of the zot group

group

Data type: String

Name of the zot group

install_method

Data type: Enum['url', 'package', 'none']

Method to install zot Possible values: url, package or none

log_dir

Data type: Stdlib::Unixpath

Directory to store the zot logs

manage_config_dir

Data type: Boolean

Whether to manage the zot config_dir

manage_data_dir

Data type: Boolean

Whether to manage the zot data_dir

manage_group

Data type: Boolean

Whether to manage the zot group

manage_log_dir

Data type: Boolean

Whether to manage the zot log dir

manage_service_file

Data type: Boolean

Whether to manage the zot systemd service file

manage_service

Data type: Boolean

Whether to manage the zot service

manage_sync_credentials_file

Data type: Boolean

Whether to manage the sync credentials file

manage_user

Data type: Boolean

Whether to manage the zot user

package_ensure

Data type: String

Ensure parameter of the zot package resource

package_name

Data type: String

Name of the zot package resource

service_enable

Data type: Boolean

Determines if the service should be enabled

service_ensure

Data type: String

Ensure parameter of the zot service resource

service_epp_parameters

Data type: Hash

Hash with parameters to hash to the custom epp file

service_epp_template

Data type: Optional[String]

Optional epp template for the zot systemd service file

service_name

Data type: String

Name of the zot service

sync_credentials_file

Data type: Stdlib::Unixpath

Path to store the sync credentials file

sync_credentials

Data type: Hash

Content of the sync credentials file

uid

Data type: Accounts::User::Uid

UID of the zot user

user

Data type: String

Name of the zot user

Functions

zot::to_yaml

Type: Ruby 4.x API

https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api

zot::to_yaml(Any $data, Optional[Integer] $depth, Optional[Hash] $options)

https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api

Returns: Any Returns a String with the structured data in YAML format.

data

Data type: Any

The data that should be transformed to YAML.

depth

Data type: Optional[Integer]

Optional. An Integer which described the number of space characters used to indent.

options

Data type: Optional[Hash]

Optional. Pass a Hash of additional options. Refer to Ruby's psych library.