Skip to content

Commit

Permalink
regenerate reference
Browse files Browse the repository at this point in the history
  • Loading branch information
zilchms committed Jan 16, 2024
1 parent 0dbc98e commit c6ed86c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 32 deletions.
70 changes: 39 additions & 31 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -26,7 +26,7 @@

## Classes

### <a name="hyperglassagent"></a>`hyperglass::agent`
### <a name="hyperglass--agent"></a>`hyperglass::agent`

installs the hyperglass linux agent

Expand All @@ -37,43 +37,47 @@ 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)

##### <a name="manage_python"></a>`manage_python`
##### <a name="-hyperglass--agent--manage_python"></a>`manage_python`

Data type: `Boolean`

installs python3

Default value: ``true``
Default value: `true`

##### <a name="manage_gcc"></a>`manage_gcc`
##### <a name="-hyperglass--agent--manage_gcc"></a>`manage_gcc`

Data type: `Boolean`

installs gcc

Default value: ``true``
Default value: `true`

##### <a name="data"></a>`data`
##### <a name="-hyperglass--agent--data"></a>`data`

Data type: `Hash`

generic hyperglass configuration hash.

Default value: `{
Default value:

```puppet
{
'debug' => true,
'listen_address' => '127.0.0.1',
'mode' => 'bird',
'secret' => fqdn_rand_string(20),
'ssl' => {
'enable' => false,
},
}`
}
```

### <a name="hyperglassserver"></a>`hyperglass::server`
### <a name="hyperglass--server"></a>`hyperglass::server`

installs the hyperglass looking glass

Expand All @@ -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)

##### <a name="manage_depended_services"></a>`manage_depended_services`
##### <a name="-hyperglass--server--manage_depended_services"></a>`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`

##### <a name="manage_python"></a>`manage_python`
##### <a name="-hyperglass--server--manage_python"></a>`manage_python`

Data type: `Boolean`

installs python3

Default value: ``true``
Default value: `true`

##### <a name="manage_gcc"></a>`manage_gcc`
##### <a name="-hyperglass--server--manage_gcc"></a>`manage_gcc`

Data type: `Boolean`

installs gcc

Default value: ``true``
Default value: `true`

##### <a name="devices"></a>`devices`
##### <a name="-hyperglass--server--devices"></a>`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',
Expand All @@ -148,17 +155,18 @@ Default value: `{
],
},
],
}`
}
```

##### <a name="commands"></a>`commands`
##### <a name="-hyperglass--server--commands"></a>`commands`

Data type: `Hash`

specific commands that can be used by the devices

Default value: `{}`

##### <a name="data"></a>`data`
##### <a name="-hyperglass--server--data"></a>`data`

Data type: `Hash`

Expand Down
2 changes: 1 addition & 1 deletion manifests/server/dependencies.pp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
manage_repo => true,
}

class { 'nodejs':}
class { 'nodejs': }

yumrepo { 'yarn':
ensure => 'present',
Expand Down

0 comments on commit c6ed86c

Please sign in to comment.