Skip to content

Latest commit

 

History

History
executable file
·
78 lines (56 loc) · 3.67 KB

README.md

File metadata and controls

executable file
·
78 lines (56 loc) · 3.67 KB
Raw

Bonsai

Bonsai is Sensu's community repository for assets, currently hosted at bonsai.sensu.io.

This is an open source project, with a Ruby on Rails framework. The code is designed to be easy for you to understand and facilitate your contributions. To that end, the goal of this README is to introduce you to the project and get you up and running.

If you want to contribute to Bonsai Asset Index, read the contributor's workflow for license information and helpful tips to get you started.

If you have questions, feature ideas, or other suggestions, please open a GitHub Issue.

Requirements

  • Ruby 2.5.1
  • PostgreSQL 9.2+
  • Redis 2.4+

Development

Setup Using Docker Compose

  1. Make sure Docker and Docker Compose are installed locally.
  2. In the project root, copy the file .env.example to .env and change the keys and secrets to work in your local environment (see below).
  3. From the project root, run "docker-compose build" to create your docker images
  4. Create the database: "docker-compose run web rake db:create"
  5. Run migrations: "docker-compose run web rake db:migrate"
  6. Run seeds: "docker-compose run web rake db:seed"
  7. Launch app & services: "docker-compose up"
  8. The app should now be available at http://localhost:3000
  9. (Optional) To run byebug; docker-compose run --service-ports web. Be aware, the background jobs do not run with this operation.
  10. (Optional) To run tests; docker-compose run -e "RAILS_ENV=test" web rspec

ENV Variable Descriptions

The ENV file allows you to customize your environmental variables. Most work by default, but there are several that require information to function properly. You should copy the env.example file to a file named env and change the variables with your information. The required variables are indicted in the env.example file.

Setting up Admin

  1. In the rails console find your user record user = User.find_by(email: "[email protected]")
  2. Add Admin authority user.roles(:admin)

Production

Setup on Heroku

You can create the Heroku application via the Heroku CLI or use the app.example.json file in the root to generate it. You must copy the app.example.json file to app.json and add your ENV variable values before using it.

API Documents

Once you have set up the environment and have the application running, you will find the API Docs at /apidoc.

Example Bonsai Asset on Github

An example of a github asset with annotated bonsai.yml file can be found at https://github.com/sensu/sensu-slack-handler

Example of the file structure for hosted assets

TBD

License
Copyright: Copyright (c) 2014-2015 Chef Software, Inc.
Copyright: Copyright (c) 2018 Sensu, Inc.
License: Apache License, Version 2.0 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.