blob: 33220d6d262ef964e48526a1c74d4d1974bdba0e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# FD.IO
#### Table of Contents
1. [Overview](#overview)
1. [Module Description](#module-description)
1. [Setup](#setup)
1. [Usage](#usage)
1. [Reference ](#reference)
1. [Limitations](#limitations)
1. [Development](#development)
1. [Release Notes/Contributors](#release-notescontributors)
## Overview
Puppet module that installs and configures [FD.IO][7].
## Module Description
Deploys FD.IO to various OSs via package.
All configuration should be handled through the Puppet
module's [params](#parameters).
## Setup
* Installs VPP and Honeycomb
* Assumes pre-exiting DPDK bindings
* Configures VPP's startup.conf
* Ensures services are running
## Usage
The most basic usage, passing no parameters to the fdio class, will
install and start vpp and honeycomb with a default configuration.
```puppet
class { 'fdio':
}
```
### Ports
To change the port vpp listens use the `vpp_port` param.
```puppet
class { 'fdio':
vpp_port => '5002',
}
```
### Set uio-driver
To set the uio-driver use the `dpdk_pmd_driver` param.
```puppet
class { 'fdio':
dpdk_pmd_driver => 'vfio_pci',
}
```
## Reference
### Classes
#### Public classes
* `::fdio`: Main entry point to the module.
#### Private classes
* `::fdio::params`: Contains default class param values.
* `::fdio::install`: Installs VPP and Honeycomb from packages.
* `::fdio::config`: Manages vpp config
* `::fdio::service`: Starts the services.
### `::fdio`
#### Parameters
##### `vpp_port`
Sets the VPP port.
Default: `8080`
Valid options: A valid port number for VPP to listen on.
##### `dpdk_pmd_driver`
Sets the uio-driver for vpp
Default: `uio_pci_generic`
Valid options: Driver names are specifed as strings.
## Limitations
* Tested on CentOS 7.
## Development
We welcome contributions and work to make them easy!
TODO
## Release Notes/Contributors
TODO
[1]: <link to fd.io website>
|
