ansible-role-openhab

A brief description of the role goes here.

Requirements

None

Role Variables

Variable	Description	Default
`openhab_user`	User of `openhab`	`{{ __openhab_user }}`
`openhab_group`	Group of `openhab`	`{{ __openhab_group }}`
`openhab_extra_groups`	A list of extra group for `openhab_user`	`[]`
`openhab_log_dir`	Path to log directory	`{{ __openhab_log_dir }}`
`openhab_db_dir`	Path to database directory	`{{ __openhab_db_dir }}`
`openhab_service`	Service name of `openhab`	`{{ __openhab_service }}`
`openhab_package_name`	Package name of `openhab`	`{{ __openhab_package_name }}`
`openhab_extra_packages`	A list of extra packages to install	`[]`
`openhab_conf_dir`	Path to configuration directory	`{{ __openhab_conf_dir }}`
`openhab_configs`	See below	`[]`
`openhab_flags`		`""`

`openhab_configs`

This is a list of configuration items. An item is a representation of a configuration file. Files are created under openhab_conf_dir. An item is a dict of the following keys and values.

Key	Description	Mandatory?
`name`	Relative path to configuration file. An example: if the value is `services/foo.cfg`, the path will be `{{ openhab_conf_dir }}/services/foo.cfg`.	Yes
`state`	Create a file if the value is `present` or delete it if `absent`.	No
`content`	Raw content of the file.	No

Debian

Variable	Default
`__openhab_user`	`openhab`
`__openhab_group`	`openhab`
`__openhab_log_dir`	`/var/log/openhab2`
`__openhab_package_name`	`openhab2`
`__openhab_service`	`openhab2`
`__openhab_db_dir`	`/var/lib/openhab2`
`__openhab_conf_dir`	`/etc/openhab2`

FreeBSD

Variable	Default
`__openhab_user`	`openhab`
`__openhab_group`	`openhab`
`__openhab_log_dir`	`/var/log/openhab2`
`__openhab_package_name`	`openhab2`
`__openhab_service`	`openhab2`
`__openhab_db_dir`	`/var/db/openhab2`
`__openhab_conf_dir`	`/usr/local/etc/openhab2`

Dependencies

None

Example Playbook

---
- hosts: localhost
  roles:
    - role: trombik.apt_repo
      when: ansible_os_family == 'Debian'
    - role: trombik.java
    - role: ansible-role-openhab
  vars:
    apt_repo_enable_apt_transport_https: yes
    apt_repo_keys_to_add:
      # XXX bintray repo is broken.
      # https://community.openhab.org/t/the-repository-https-dl-bintray-com-openhab-apt-repo2-stable-release-is-not-signed-raspberry-pi-3/60047/17
      - https://bintray.com/user/downloadSubjectPublicKey?username=openhab
    apt_repo_to_add:
      - deb https://openhab.jfrog.io/openhab/openhab-linuxpkg stable main
    java_packages: "{% if ansible_os_family == 'FreeBSD' %}[ 'java/openjdk8-jre' ]{% elif ansible_os_family == 'Debian' %}[ 'openjdk-8-jdk' ]{% endif %}"

    openhab_extra_groups:
      - name: "{% if ansible_os_family == 'Debian' %}dialout{% elif ansible_os_family == 'FreeBSD' %}dialer{% endif %}"

    openhab_configs:
      - name: services/addons.cfg
        state: present
        content: |
          package = standard
          remote = true
          binding = astro,mqtt,ntp
          ui = basic,paper
          persistence = rrd4j
          action = mail
          transformation = jsonpath,map
          voice = voicerss
      - name: services/basicui.cfg
        content: |
          org.eclipse.smarthome.basicui:defaultSitemap=demo
          org.eclipse.smarthome.basicui:iconType=svg
      - name: services/classicui.cfg
        content: |
          org.eclipse.smarthome.classicui:defaultSitemap=demo
      - name: services/logging.cfg
        content: |
          pattern=%date{ISO8601} - %-25logger: %msg%n
      - name: services/rrd4j.cfg
        content: ""
      - name: services/runtime.cfg
        content: |
          org.eclipse.smarthome.core.localeprovider:language=en
      - name: services/foo.cfg
        state: absent
        content: |
          org.eclipse.smarthome.core.localeprovider:language=en
    flags_freebsd: ""
    flags_debian: |
      EXTRA_JAVA_OPTS=""
      OPENHAB_HTTP_PORT=8080
    openhab_flags: "{% if ansible_os_family == 'Debian' %}{{ flags_debian }}{% elif ansible_os_family == 'FreeBSD' %}{{ flags_freebsd }}{% endif %}"

License

Copyright (c) 2019 Tomoyuki Sakurai <[email protected]>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.