Forge Home

beid

Puppet module to install Belgian eID

7,093 downloads

214 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.8.6 (latest)
  • 0.8.5
  • 0.8.4
  • 0.8.3
  • 0.8.1 (deleted)
  • 0.8.0
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.0
  • 0.3.0
released Jan 8th 2023
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0
  • , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'yorick-beid', '0.8.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add yorick-beid
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install yorick-beid --version 0.8.6

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

yorick/beid — version 0.8.6 Jan 8th 2023

beid

Build Status Puppet Forge

Table of Contents

  1. Description
  2. Setup - The basics of getting started with beid
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module installs Belgian eID software.

It installs the "eid-archive" package, enabling the eID package repositories. Then it installs the "eid-viewer" and "eid-mw" packages. On Debian based distros it can install the Firefox exention as well.

This module uses the PDK, more info can be found on the PDK readme.

Setup

Beginning with beid

include ::beid should be enough to get it up and running.

Usage

All parameters for the beid module are contained within the main ::beid class, so for any function of the module, set the options you want.

Reference

Classes

Public classes

beid: Main class, includes all other.

Private classes

  • beid::install: Installs all packages and dependencies
  • beid::service: Handles the systemd service

Parameters

Following parameters are available, and are the defaults:

Common

beid::download_url: https://eid.belgium.be/sites/default/files/software
beid::package_ensure: 'present'
beid::package_manage: true
beid::service_enable: true
beid::service_ensure: 'running'
beid::service_manage: true
beid::service_name: 'pcscd'
beid::browser_packages: []

Debian family

beid::version: '2018.3'
beid::package_archive: "eid-archive_%{lookup('beid::version')}_all.deb"
beid::service_package: 'pcscd'
beid::browser_packages_manage: true
beid::firefox_extension_manage: true
beid::packages:
  - eid-viewer
  - eid-mw
beid::browser_packages:
  - icedtea-plugin
  - default-jre
beid::firefox_extension: 'beid-mozilla-extension'
beid::package_archive_name: 'eid-archive'

RedHat family

beid::package_archive: "eid-archive-el-%{lookup('beid::version')}.noarch.rpm"
beid::version: '2016-2'
beid::service_package: 'pcscd-tools'
beid::packages:
  - eid-archive-el
  - eid-viewer
  - eid-mw

Fedora

beid::package_archive: eid-archive-fedora-%{lookup('beid::version')}.noarch.rpm
beid::version: '2016-2'
beid::packages:
  - eid-archive-fedora
  - eid-viewer
  - eid-mw
beid::package_archive_name: 'eid-archive-fedora'

Limitations

This module has been tested on Debian 'stretch' and Fedora 27. CentOS 7 and distros based on Debian (e.g. Ubuntu 16.04) should work as well.

This module does not cover the installation of the smart card reader. More info can be found on the eiD FAQ from the Belgian governement and the Debian Smartcards wiki.

Development

Contributing

Read more in the Contributing section.

Release Notes/Contributors/Etc.