A standalone snap for Ceilometer

Signed-off-by: Dmitrii Shcherbakov <dmitrii.shcherbakov@canonical.com>

CONTRIBUTING.rst

@@ -0,0 +1,17 @@
+If you would like to contribute to the development of OpenStack, you must
+follow the steps in this page:
+
+   http://docs.openstack.org/infra/manual/developers.html
+
+If you already have a good understanding of how the system works and your
+OpenStack accounts are set up, you can skip to the development workflow
+section of this documentation to learn how changes to OpenStack should be
+submitted for review via the Gerrit tool:
+
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
+
+Pull requests submitted through GitHub will be ignored.
+
+Bugs should be filed on Launchpad, not GitHub:
+
+   https://bugs.launchpad.net/snap-ceilometer

LICENSE

@@ -0,0 +1,176 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+

README.md

@@ -0,0 +1,70 @@
+# Ceilometer Snap
+
+This repository contains the source code of the snap for the OpenStack Data
+Collection service, Ceilometer.
+
+## Installing this snap
+
+The ceilometer snap can be installed directly from the snap store:
+
+    sudo snap install [--edge] ceilometer
+
+## Configuring Ceilometer
+
+Snaps run in an AppArmor and seccomp confined profile, so don't read
+configuration from `/etc/ceilometer` on the hosting operating system install.
+
+This snap supports configuration via the $SNAP\_COMMON writable area for the
+snap:
+
+    etc
+    ├── ceilometer
+    │   ├── ceilometer.conf
+    └── ceilometer.conf.d
+        └── ceilometer-snap.conf
+
+The ceilometer daemons (api, collector, agent-notification, agent-central)
+can be configured in a few ways.
+
+Firstly each daemon will detect and read `etc/ceilometer/ceilometer.conf`.
+
+Alternatively all daemons will load all configuration files from
+`etc/ceilometer.conf.d` if needed.
+
+For reference, $SNAP\_COMMON is typically located under
+`/var/snap/ceilometer/common`.
+
+## Managing Ceilometer
+
+Currently all snap binaries must be run as root; for example, to run the
+ceilometer-api binary use:
+
+    sudo ceilometer.manage
+
+## Restarting Ceilometer services
+
+To restart all ceilometer services:
+
+    sudo systemctl restart snap.ceilometer.*
+
+or use the individual service name:
+
+    sudo systemctl restart snap.ceilometer.api
+    sudo systemctl restart snap.ceilometer.agent-central
+
+## Building the Ceilometer snap
+
+Simply clone this repository and then install and run snapcraft:
+
+    git clone https://github.com/openstack-snaps/snap-ceilometer
+    sudo apt install snapcraft
+    cd snap-ceilometer
+    snapcraft
+
+## Support
+
+Please report any bugs related to this snap on
+[Launchpad](https://bugs.launchpad.net/snap-ceilometer/+filebug).
+
+Alternatively you can find the OpenStack Snap team in `#openstack-snaps`
+on Freenode IRC.

bindep.txt

@@ -0,0 +1,2 @@
+libsodium-dev [platform:dpkg]
+libapt-pkg-dev [platform:dpkg]

requirements.txt

@@ -0,0 +1,5 @@
+# Requirements to build snap
+git+https://github.com/openstack-snaps/snapcraft@fixup-install-requires#egg_name=snapcraft
+# PyPi less dependencies
+https://launchpad.net/ubuntu/+archive/primary/+files/python-apt_1.1.0~beta1build1.tar.xz
+https://launchpad.net/python-distutils-extra/trunk/2.39/+download/python-distutils-extra-2.39.tar.gz

snap/snap-openstack.yaml

@@ -0,0 +1,41 @@
+setup:
+  dirs:
+    - "{snap_common}/etc/ceilometer.conf.d"
+    - "{snap_common}/etc/ceilometer"
+    - "{snap_common}/etc/uwsgi"
+    - "{snap_common}/log"
+    - "{snap_common}/lock"
+    - "{snap_common}/run"
+  templates:
+    "ceilometer-snap.conf.j2": "{snap_common}/etc/ceilometer.conf.d/ceilometer-snap.conf"
+    "api.ini.j2": "{snap_common}/etc/uwsgi/api.ini"
+entry_points:
+  ceilometer-collector:
+    binary: ceilometer-collector
+    config-files:
+      - "{snap}/etc/ceilometer/ceilometer.conf"
+      - "{snap_common}/etc/ceilometer/ceilometer.conf"
+    config-dirs:
+      - "{snap_common}/etc/ceilometer.conf.d"
+    log-file: "{snap_common}/log/ceilometer-collector.log"
+  ceilometer-agent-notification:
+    binary: ceilometer-agent-notification
+    config-files:
+      - "{snap}/etc/ceilometer/ceilometer.conf"
+      - "{snap_common}/etc/ceilometer/ceilometer.conf"
+    config-dirs:
+      - "{snap_common}/etc/ceilometer.conf.d"
+    log-file: "{snap_common}/log/ceilometer-agent-notification.log"
+  ceilometer-polling:
+    binary: ceilometer-polling
+    config-files:
+      - "{snap}/etc/ceilometer/ceilometer.conf"
+      - "{snap_common}/etc/ceilometer/ceilometer.conf"
+    config-dirs:
+      - "{snap_common}/etc/ceilometer.conf.d"
+    log-file: "{snap_common}/log/ceilometer-agent-central.log"
+  ceilometer-api:
+    type: uwsgi
+    uwsgi-dir: "{snap_common}/etc/uwsgi"
+    log-file: "{snap_common}/log/ceilometer.log"
+

snap/templates/api.ini.j2

@@ -0,0 +1,12 @@
+[uwsgi]
+wsgi-file = {{ snap }}/bin/ceilometer-api
+uwsgi-socket = {{ snap_common }}/run/ceilometer-admin.sock
+buffer-size = 65535
+http = 0.0.0.0:8777
+master = true
+enable-threads = true
+processes = 4
+thunder-lock = true
+plugins = python
+lazy-apps = true
+pyargv = --config-file={{ snap }}/etc/ceilometer/ceilometer.conf --config-dir={{ snap_common }}/etc/ceilometer.conf.d

snap/templates/ceilometer-snap.conf.j2

@@ -0,0 +1,7 @@
+[DEFAULT]
+# Set state path to writable directory
+state_path = {{ snap_common }}
+
+[oslo_concurrency]
+# Oslo Concurrency lock path
+lock_path = {{ snap_common }}/lock

snapcraft.yaml

@@ -0,0 +1,61 @@
+name: ceilometer
+version: ocata
+summary: OpenStack Data Collection Service (ceilometer)
+description: |
+  collected data to various targets including data stores and message queues.
+confinement: strict
+grade: devel
+
+apps:
+  api:
+    command: snap-openstack ceilometer-api
+    daemon: simple
+    plugs:
+      - network
+      - network-bind
+  collector:
+    command: snap-openstack ceilometer-collector
+    daemon: simple
+    plugs:
+      - network
+      - network-bind
+  agent-notification:
+    command: snap-openstack ceilometer-agent-notification
+    daemon: simple
+    plugs:
+      - network
+  agent-central:
+    command: snap-openstack ceilometer-polling --polling-namespaces central
+    daemon: simple
+    plugs:
+      - network
+      - network-bind
+
+parts:
+  ceilometer:
+    plugin: python
+    python-version: python2
+    source: https://tarballs.openstack.org/ceilometer/ceilometer-master.tar.gz
+    python-packages:
+      - pymysql
+      - python-memcached
+      - oslo.rootwrap
+      - uwsgi
+      - git+https://github.com/openstack-snaps/snap.openstack#egg=snap.openstack
+    constraints: https://raw.githubusercontent.com/openstack/requirements/master/upper-constraints.txt
+    build-packages:
+      - libffi-dev
+      - libssl-dev
+      - libxml2-dev
+      - libxslt1-dev
+      - pkg-config
+      - gcc
+    install: |
+      $SNAPCRAFT_PART_INSTALL/bin/oslo-config-generator --config-file etc/ceilometer/ceilometer-config-generator.conf
+      mv etc/ceilometer/ceilometer.conf $SNAPCRAFT_PART_INSTALL/etc/ceilometer/ceilometer.conf
+  templates:
+    after:
+      - ceilometer
+    plugin: dump
+    source: snap
+

tox.ini

@@ -0,0 +1,14 @@
+[tox]
+envlist = snap
+skipsdist = True
+
+[testenv]
+basepython = python3.5
+install_command = pip install {opts} {packages}
+passenv = HOME TERM
+
+[testenv:snap]
+deps = -r{toxinidir}/requirements.txt
+commands =
+    snapcraft clean
+    snapcraft snap