Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

intelsdi-x/snap-deploy

Repository files navigation

DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project. Go Report Card

snap-deploy

  1. Getting Started
  1. Documentation
  2. Community Support
  3. Contributing
  4. License
  5. Acknowledgements

Getting Started

System Requirements

Linux/MacOS/*BSD system

Download binary:

You can get the pre-built binaries for your OS and architecture from the GitHub Releases page. Download the plugin from the latest release and load it into /opt/local/bin is the default location for user binaries.

To build the snap-deploy binary:

Fork https://github.com/intelsdi-x/snap-deploy Clone repo into $GOPATH/src/github.com/intelsdi-x/:

$ git clone https://github.com/<yourGithubID>/snap-deploy.git

Build the snap-deploy by running make within the cloned repo:

$ make

This builds the executable file in ./build/

Documentation

Examples

For quick snap-deploy test using deployment, you can go through steps below:

  1. Install influxdb on your localhost InfluxDB website
  2. Create database "snap"
  3. Export variables:
export DB_HOST="localhost"
export DB_NAME="snap"
export DB_USER="snap"
export DB_PASS="snap"
export INTERVAL="1s"
export TAGS="datacenter:dublin"
export METRICS="/intel"
export PORT="8181"
export DIRECTORY="/opt/snap"
export PLUGINS="collector-psutil"

  1. Run snap-deploy as root
snap-deploy deploy
  1. Snap should be running on the port 8181 and publishing psutil metrics to the localhost influxdb database named snap.

Roadmap

As we launch this software, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue.

If you have a feature request, please add it as an issue and/or submit a pull request.

Community Support

To reach out to other users, head to the main framework.

Contributing

We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.

License

Snap, along with this application, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

This is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.

This software has been contributed by MIKELANGELO, a Horizon 2020 project co-funded by the European Union. https://www.mikelangelo-project.eu/

Thank You

And thank you! Your contribution, through code and participation, is incredibly important to us.