From c6ed86c0065e4f5a42c160762186e2e4ad421b8d Mon Sep 17 00:00:00 2001 From: markuszilch Date: Tue, 16 Jan 2024 23:02:12 +0100 Subject: [PATCH] regenerate reference --- REFERENCE.md | 70 ++++++++++++++++++-------------- manifests/server/dependencies.pp | 2 +- 2 files changed, 40 insertions(+), 32 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index d56c9b1..2122992 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -8,8 +8,8 @@ #### Public Classes -* [`hyperglass::agent`](#hyperglassagent): installs the hyperglass linux agent -* [`hyperglass::server`](#hyperglassserver): installs the hyperglass looking glass +* [`hyperglass::agent`](#hyperglass--agent): installs the hyperglass linux agent +* [`hyperglass::server`](#hyperglass--server): installs the hyperglass looking glass #### Private Classes @@ -26,7 +26,7 @@ ## Classes -### `hyperglass::agent` +### `hyperglass::agent` installs the hyperglass linux agent @@ -37,33 +37,36 @@ installs the hyperglass linux agent The following parameters are available in the `hyperglass::agent` class: -* [`manage_python`](#manage_python) -* [`manage_gcc`](#manage_gcc) -* [`data`](#data) +* [`manage_python`](#-hyperglass--agent--manage_python) +* [`manage_gcc`](#-hyperglass--agent--manage_gcc) +* [`data`](#-hyperglass--agent--data) -##### `manage_python` +##### `manage_python` Data type: `Boolean` installs python3 -Default value: ``true`` +Default value: `true` -##### `manage_gcc` +##### `manage_gcc` Data type: `Boolean` installs gcc -Default value: ``true`` +Default value: `true` -##### `data` +##### `data` Data type: `Hash` generic hyperglass configuration hash. -Default value: `{ +Default value: + +```puppet +{ 'debug' => true, 'listen_address' => '127.0.0.1', 'mode' => 'bird', @@ -71,9 +74,10 @@ Default value: `{ 'ssl' => { 'enable' => false, }, - }` + } +``` -### `hyperglass::server` +### `hyperglass::server` installs the hyperglass looking glass @@ -84,44 +88,47 @@ installs the hyperglass looking glass The following parameters are available in the `hyperglass::server` class: -* [`manage_depended_services`](#manage_depended_services) -* [`manage_python`](#manage_python) -* [`manage_gcc`](#manage_gcc) -* [`devices`](#devices) -* [`commands`](#commands) -* [`data`](#data) +* [`manage_depended_services`](#-hyperglass--server--manage_depended_services) +* [`manage_python`](#-hyperglass--server--manage_python) +* [`manage_gcc`](#-hyperglass--server--manage_gcc) +* [`devices`](#-hyperglass--server--devices) +* [`commands`](#-hyperglass--server--commands) +* [`data`](#-hyperglass--server--data) -##### `manage_depended_services` +##### `manage_depended_services` Data type: `Boolean` if true, installs all other services that hyperglass requires, like redis, yarn, nginx, python -Default value: ``true`` +Default value: `true` -##### `manage_python` +##### `manage_python` Data type: `Boolean` installs python3 -Default value: ``true`` +Default value: `true` -##### `manage_gcc` +##### `manage_gcc` Data type: `Boolean` installs gcc -Default value: ``true`` +Default value: `true` -##### `devices` +##### `devices` Data type: `Hash` hash containing all the devices hyperglass can connect to. Defaults to demo data so the service starts properly. -Default value: `{ +Default value: + +```puppet +{ 'routers' => [ { 'name' => 'atl_router01', @@ -148,9 +155,10 @@ Default value: `{ ], }, ], - }` + } +``` -##### `commands` +##### `commands` Data type: `Hash` @@ -158,7 +166,7 @@ specific commands that can be used by the devices Default value: `{}` -##### `data` +##### `data` Data type: `Hash` diff --git a/manifests/server/dependencies.pp b/manifests/server/dependencies.pp index bbd0855..7b6bb3f 100644 --- a/manifests/server/dependencies.pp +++ b/manifests/server/dependencies.pp @@ -22,7 +22,7 @@ manage_repo => true, } - class { 'nodejs':} + class { 'nodejs': } yumrepo { 'yarn': ensure => 'present',