Code Monkey home page Code Monkey logo

manageiq-consumption's Introduction

ManageIQ-consumption

Gem Version Build Status Coverage Status Dependency Status

Gitter

Build history for master branch

ManageIQ Gem plugin for the Consumption.

Introduction

Manageiq-consumption is a gem replacement for chargeback/showback on manageiq.

It is being designed as a complete rewrite of ManageIQ chargeback code in https://github.com/ManageIQ.

The main reason for the effort is to make sure that ManageIQ is capable of understanding and replicating any price plan for the cloud available for customers.

Design principles:

  • Flexibility: capable of supporting telco chargeback(simplified). It is based on TMForum concepts adapted to cloud
  • Performance: reduce the time needed to generate an invoice
  • Automation: generation of invoices should be automated, for new users, groups, or resources
  • Easy integration with 3rd party billing and ERP systems to provide full billing and payments
  • API oriented: Every function should be available through an API. Parts of the system will be suceptible of being substitued by an external billing system via API.

Concepts

Please see the wiki for updated documentation on concepts, architecture and configuration.

Overall project status

All the project status can be followed in:

Pivotal tracker: https://www.pivotaltracker.com/n/projects/1958459 Github issues: https://github.com/ManageIQ/manageiq-consumption/issues

Demo documentation

There are instruction to perform a demo of the new system inside the code, if you want to have a look it simply:

Go to demo section

Development

See the section on pluggable providers in the ManageIQ Developer Setup

Manageiq-consumption is not a provider, so we have adapted the development to create a gem that can be installed.

Development has been divided in phases:

  • Phase 1 (current): We use the old reporting data that is fed into the new chargeback. Old chargeback rating can be deleted. Price plans are migrated into the new chargeback. It should have functional parity with the old chargeback.
  • Phase 2: Reporting is changed into the new showback_event mechanism, to increase the flexibility and speed of the system
  • Phase 3: Extend it into a financial management system

Configuration

  1. cd manageiq
  2. mkdir plugins
  3. git clone [email protected]:ManageIQ/manageiq-consumption.git plugins/manageiq-consumption
  4. echo "gem 'manageiq-consumption', :path => File.expand_path('../plugins/manageiq-consumption', __dir__) " >> bundler.d/manageiq-consumption.rb
  5. bin/update

License

The gem is available as open source under the terms of the Apache License 2.0.

Contributing

Contributions are welcomed and appreciated

  1. Fork the repo. Make sure that you can run the tests (bundle exec rspec)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

manageiq-consumption's People

Contributors

agrare avatar aljesusg avatar astrozzc avatar carbonin avatar chargio avatar chessbyte avatar durandom avatar fryguy avatar gtanzillo avatar jprause avatar jrafanie avatar kbrock avatar lpichler avatar simaishi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.