diff --git a/README.md b/README.md index ab73c39..4aa7002 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ ## Table of Contents -1. [Description](#description) -1. [Setup - The basics of getting started with hdm](#setup) - * [What hdm affects](#what-hdm-affects) - * [Setup requirements](#setup-requirements) - * [Beginning with hdm](#beginning-with-hdm) -1. [Usage - Configuration options and additional functionality](#usage) -1. [Limitations - OS compatibility, etc.](#limitations) -1. [Development - Guide for contributing to the module](#development) +- [puppet-hdm](#puppet-hdm) + - [Table of Contents](#table-of-contents) + - [Description](#description) + - [Setup](#setup) + - [Setup Requirements](#setup-requirements) + - [Beginning with hdm](#beginning-with-hdm) + - [Reference](#reference) + - [Limitations](#limitations) ## Description @@ -21,77 +21,32 @@ This module allows you to either make use of the HDM Docker container or to inst ## Setup -### Setup Requirements **OPTIONAL** +### Setup Requirements -If your module requires anything extra before setting up (pluginsync enabled, -another module, etc.), mention it here. +The puppet-hdm module needs puppetlabs/stdlib as we use some of the stdlib data types. -If your most recent release breaks compatibility or requires particular steps -for upgrading, you might want to include an additional "Upgrading" section here. +If you want to make use of the docker container, you need the following module: -### Beginning with hdm - -The very basic steps needed for a user to get the module up and running. This -can include setup steps, if necessary, or it can be an example of the most basic -use of the module. - -## Usage - -Include usage examples for common use cases in the **Usage** section. Show your -users how to use your module to solve problems, and be sure to include code -examples. Include three to five examples of the most important or common tasks a -user can accomplish with your module. Show users how to accomplish more complex -tasks that involve different types, classes, and functions working in tandem. - -## Reference - -This section is deprecated. Instead, add reference information to your code as -Puppet Strings comments, and then use Strings to generate a REFERENCE.md in your -module. For details on how to add code comments and generate documentation with -Strings, see the [Puppet Strings documentation][2] and [style guide][3]. - -If you aren't ready to use Strings yet, manually create a REFERENCE.md in the -root of your module directory and list out each of your module's classes, -defined types, facts, functions, Puppet tasks, task plans, and resource types -and providers, along with the parameters for each. +- puppetlabs/docker - min version 4.4.0 -For each element (class, defined type, function, and so on), list: +If you want to install HDM using Puppet Ruby, you need the following modules: -* The data type, if applicable. -* A description of what the element does. -* Valid values, if the data type doesn't make it obvious. -* Default value, if any. +- puppetlabs/vcsrepo - min version 5.2.0 +- puppet/systemd - min version 3.10.0 -For example: +### Beginning with hdm -``` -### `pet::cat` +The most simple approach is to just include the hdm class: -#### Parameters + include hdm -##### `meow` +This will install HDM as docker container. -Enables vocalization in your cat. Valid options: 'string'. +## Reference -Default: 'medium-loud'. -``` +Please check the [REFERENCE.md](REFERENCE.md) file. ## Limitations -In the Limitations section, list any incompatibilities, known issues, or other -warnings. - -## Development - -In the Development section, tell other users the ground rules for contributing -to your project and how they should submit their work. - -## Release Notes/Contributors/Etc. **Optional** - -If you aren't using changelog, put your release notes here (though you should -consider using changelog). You can also add any additional sections you feel are -necessary or important to include here. Please use the `##` header. - -[1]: https://puppet.com/docs/pdk/latest/pdk_generating_modules.html -[2]: https://puppet.com/docs/puppet/latest/puppet_strings.html -[3]: https://puppet.com/docs/puppet/latest/puppet_strings_style.html +On SLES we can not use the puppetlabs/docker module. +Instead set the manage_docker parameter to false and take care on docker package and service by yourself. diff --git a/REFERENCE.md b/REFERENCE.md index 31041e9..5db13f2 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -45,6 +45,7 @@ The following parameters are available in the `hdm` class: * [`port`](#port) * [`bind_ip`](#bind_ip) * [`hostname`](#hostname) +* [`timezone`](#timezone) * [`hdm_path`](#hdm_path) * [`git_url`](#git_url) * [`user`](#user) @@ -115,6 +116,14 @@ The hostname to use Default value: `$facts['networking']['fqdn']` +##### `timezone` + +Data type: `String[1]` + +THe timezone to use when running with docker + +Default value: `$facts['timezone']` + ##### `hdm_path` Data type: `Stdlib::Unixpath` diff --git a/metadata.json b/metadata.json index 68152b6..6661bb6 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "betadots-hdm", - "version": "1.0.2", + "version": "1.0.3", "author": "betadots GmbH", "summary": "Manage Hiera Data Manager application", "license": "Apache-2.0",