Fix websockets ip address config
[integration/packaging/puppet-opendaylight.git] / README.markdown
index 03b88ee4fde302af5eaf41bb2b5a2ff2fcc4326e..13603999525cdbf817ca9779d7a0d7d271054c84 100644 (file)
@@ -96,24 +96,16 @@ OpenDaylight is installed from.
 
 ```puppet
 class { 'opendaylight':
-  rpm_repo => 'opendaylight-61-release',
+  rpm_repo => 'https://nexus.opendaylight.org/content/repositories/opendaylight-oxygen-epel-7-$basearch-devel',
 }
 ```
 
-The naming convention follows the naming convention of the CentOS Community
-Build System, which is where upstream ODL hosts its RPMs. The
-`opendaylight-61-release` example above would install OpenDaylight Carbon SR1
-6.1.0 from the [nfv7-opendaylight-61-release][2] repo. Repo names ending in
-`-release` will always contain well-tested, officially released versions of
-OpenDaylight. Repos ending in `-testing` contain frequent, but unstable and
-unofficial, releases. The ODL version given in repo names shows which major
-and minor version it is pinned to. The `opendaylight-61-release` repo will
-always provide OpenDaylight Carbon SR1 6.1, whereas `opendaylight-4-release`
-will provide the latest release with major version 6 (which could include
-Service Releases, like SR2 6.2).
+The URL should be formatted like a baseurl in RPM .repo config files. In
+particular, note the $basearch variable, which should be left form the
+package manager (yum, dnf) to populate.
 
 For additional information about ODL RPM repos, see the [Integration/Packaging
-RPM repositories documentation][3].
+RPM repositories documentation][2].
 
 This is only read for Red Hat-family operating systems.
 
@@ -130,7 +122,7 @@ class { 'opendaylight':
 
 The naming convention is same as the naming convention of Launchpad PPA's,
 which is where ODL .debs are hosted. The `ppa:odl-team/carbon` example above
-would install OpenDaylight Carbon from the [boron launchpad repo][4].
+would install OpenDaylight Carbon from the [Boron launchpad repo][3].
 
 This is only read for Debian-family operating systems.
 
@@ -181,6 +173,35 @@ class { 'opendaylight':
 }
 ```
 
+### Configuring websocket address
+
+Websocket address can be configured to the IP of ODL rather than default 0.0.0.0. This IP will
+be defined by `odl_bind_ip`.
+
+### Enabling TLS with OpenDaylight
+
+It is possible to enable TLS encrypted communication for OpenDaylight Northbound REST
+along with Southbound OVSDB/OpenFlow communication with Open vSwitch. To enable
+TLS, use the `enable_tls` flag. This option will create two keystores in OpenDaylight
+which are stored in '/opt/opendaylight/configuration/ssl'. The first keystore
+is the controller keystore, which will hold the private key and ODL certificate,
+along with the Certificate Authority (CA) certificate if provided. The second
+keystore is the trust keystore, which will hold the trusted OVS switch certificates.
+
+In order to enable TLS, it is required to provide the `tls_keystore_password`
+parameter. This represents the password to use for the controller and truststore
+keystores. With only providing these parameters, ODL will generate the
+controller keystore with a random private key and self-signed certficate.
+
+Additionally the `tls_key_file` and `tls_cert_file` parameters may be provided.
+These represent ODL's private key file and certificate file to be used when building
+the controller keystore. Optionally the `tls_ca_cert_file` may be provided which
+will chain the CA certificate to the keystore for client validation.
+
+`tls_trusted_certs` may be provided as an array of trusted certificates to be
+added to the trusted keystore. This allows OpenDaylight to identify trusted
+clients which may connect to ODL Southbound and Northbound.
+
 ## Reference
 
 ### Classes
@@ -232,8 +253,7 @@ Valid options: A valid port number as a string or integer.
 
 ##### `rpm_repo`
 
-OpenDaylight CentOS CBS repo to install RPM from (opendaylight-6-testing,
-opendaylight-6-release, ...).
+Repo URL to install ODL RPM from, in .repo baseurl format.
 
 ##### `deb_repo`
 
@@ -301,6 +321,16 @@ Default: `2`
 
 Valid options: An integer greater than 0.
 
+##### `log_mechanism`
+
+Logging mechanism for karaf logs. They are logged either to a file or console.
+When `log_mechanism` is `file`, log files are configured as per `log_max_size`
+and `log_max_rollover`.
+
+Default: `file`
+
+Valid options: `file`, `console`.
+
 ##### `enable_ha`
 
 Enable or disable ODL High Availablity.
@@ -343,14 +373,6 @@ Valid options: Index of a member of the array `ha_node_ips`: `0`.
 
 This parameter is now deprecated and is no longer used.
 
-##### `security_group_mode`
-
-Specifies the mode to use for security groups.
-
-Default: `stateful`
-
-Valid options: `transparent`, `learn`, `stateless`
-
 ##### `snat_mechanism`
 
 Specifies the mechanism to be used for SNAT.
@@ -401,21 +423,19 @@ Valid options: A password string.
 
 We welcome contributions and work to make them easy!
 
-See [CONTRIBUTING.markdown][5] for details about how to contribute to the
+See [CONTRIBUTING.markdown][4] for details about how to contribute to the
 OpenDaylight Puppet module.
 
 ## Release Notes
 
-See the [CHANGELOG][6] for information about releases.
+See the [CHANGELOG][5] for information about releases.
 
 [1]: http://www.opendaylight.org/ "OpenDaylight homepage"
 
-[2]: http://cbs.centos.org/repos/nfv7-opendaylight-61-release/x86_64/os/Packages/ "OpenDaylight Carbon SR1 CentOS CBS repo"
-
-[3]: http://docs.opendaylight.org/en/latest/submodules/integration/packaging/docs/rpms.html#repositories "ODL RPM repo docs"
+[2]: http://docs.opendaylight.org/en/latest/submodules/integration/packaging/docs/rpms.html#repositories "ODL RPM repo docs"
 
-[4]: https://launchpad.net/~odl-team/+archive/ubuntu/carbon "ODL Carbon Deb repo"
+[3]: https://launchpad.net/~odl-team/+archive/ubuntu/carbon "ODL Carbon Deb repo"
 
-[5]: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging/puppet-opendaylight.git;a=blob;f=CONTRIBUTING.markdown "Contributing docs"
+[4]: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging/puppet-opendaylight.git;a=blob;f=CONTRIBUTING.markdown "Contributing docs"
 
-[6]: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging/puppet-opendaylight.git;a=blob;f=CHANGELOG "Chagelog"
+[5]: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging/puppet-opendaylight.git;a=blob;f=CHANGELOG "Chagelog"