RETIRED, Rule-based diagnostics of configuration of OpenStack platform
Go to file
Maxim Kulkin 08b8cdc3c5 Updated schema generator to generate YAML 2013-11-12 16:21:08 +04:00
doc/source [doc] Update packages and classes diagrams 2013-11-08 06:00:37 +00:00
joker [joker] no whitespaces 2013-11-06 13:13:26 +04:00
rubick Updated schema generator to generate YAML 2013-11-12 16:21:08 +04:00
static Renamed directory config-validator-ui-concept => static 2013-10-22 19:14:00 +04:00
vagrant/cookbooks/rubick/recipes Simplified Procfiles 2013-10-24 18:43:30 +04:00
.gitignore [pep8] Joker pep8 fixes 2013-10-23 14:26:31 +04:00
.testr.conf Make Joker as a subpackage 2013-10-23 14:50:12 +04:00
Procfile Removed obsolete PYTHONPATH overrides from Procfile 2013-10-28 18:45:02 +04:00
Procfile.production Simplified Procfiles 2013-10-24 18:43:30 +04:00
README.md Added examples of CLI usage. 2013-11-07 18:11:50 +04:00
Vagrantfile Renamed all references to ostack_validator 2013-10-22 19:11:45 +04:00
discover_test.py Fix incorrect number of arguments in discovery_test.py 2013-11-01 12:50:22 +04:00
joker_test.py [joker] using deep knowledge of argsparse and whitespaces fix 2013-11-06 13:37:54 +04:00
openstack-configuration.txt Implemented metadata for services and filesystem, new filesystem snapshot format 2013-09-22 17:34:05 +04:00
requirements.txt Fix version spec in "requests==1.2.0" requirement 2013-11-07 16:06:19 +04:00
setup.cfg Make Joker as a subpackage 2013-10-23 14:50:12 +04:00
setup.py Introduce tox to run PEP8 2013-10-17 13:46:19 +04:00
test-requirements.txt Run unit test for py27 2013-10-17 23:49:05 +04:00
tox.ini Make Joker as a subpackage 2013-10-23 14:50:12 +04:00
webui.py Added glance_api, glance_registry, neutron_dhcp and neutron_server 2013-10-31 18:04:23 +04:00

README.md

Rubick

Rubick is a tool to analyze OpenStack installation for possible problems. It consists of two processes:

  1. Discovery - find all OpenStack components and collect information about them.
  2. Analyze - perform various checks of discovered data to ensure consistency and conformance to best practices.

Installation

Completely environment in VirtualBox via Vagrant

  1. Install vagrant(MacOS, Windows, Ubuntu) - http://downloads.vagrantup.com/tags/v1.3.3 and latest version of Virtualbox
  2. $ vagrant up && vagrant provision
  3. After that you can access application on http://host_machine_ip:8000/
  4. For testing purposes of your application you can install latest-devstack installation via vagrant. We strongly recommend you to use this repo: https://github.com/lorin/devstack-vm. There are a lot of choices for devstack installation for Rubick to validate: with or without neutron\swift\security_groups\tempest etc.
  5. After that youll get full worked environment with Rubick and OpenStack.

Manual installation and running

$ sudo apt-get install build-essential mongodb-server redis-server python-pip
$ sudo pip install -r requirements.txt
$ python webui.py &
$ celery worker --app=rubick.celery:app &

All steps for manual deployment and running the app you can find here: /vagrant/cookbooks/openstack-validator/recipes/default.rb

Rubick usage

Open http://host_machine_ip:8000/ with web-browser, host_machine_ip - address your application is installed. Add new cluster by pushing the button “Add cluster” and fill the fields:

  1. “Cluster name” - with name of your cluster (e.g. local_devstack )
  2. “Description” - with description (e.g. VBox installation of devstack)
  3. “Ip Address“ - with username@host:port (e.g. vagrant@192.168.27.100)
  4. “SSH key“ - with ssh-key to access the virual machine (e.g. can be find in the directory ~/.vagrant.d/insecure_private_key for Vagrant nodes)
  5. Press “Create”

After that you can select your cluster to run validations or select the rulest before validation.

Rubick Command Line usage examples

$ python rubick/cli.py -h
$ python rubick/cli.py -l -v http://<host>:8000
$ python rubick/cli.py -a -n 'New_cluster_name' -d 'New description' -H 'root@10.10.3.1:2022' -k ~/.ssh/id_rsa http://<host>:8008

Note: Your public key must be without passphrase.

Hacking

To check project on compliance to PEP8 run command use: tox -v.