branched off for 6.1; removed all 7.0-related material
Change-Id: Id4cb9b872a2df1be598253f6a757d0ff7cdbbf75
52
README.md
|
@ -1,5 +1,4 @@
|
|||
The Openbook Plugin
|
||||
===================
|
||||
# The Openbook Plugin
|
||||
|
||||
This plugin extends Mirantis OpenStack functionality by adding Openbook customer
|
||||
onboarding, self-service, and cloud billing / charge-back services. Openbook is
|
||||
|
@ -7,16 +6,51 @@ a fully-functional, simple to use cloud management solution that has been built
|
|||
specifically for OpenStack. It allows users to measure, manage, and monetize
|
||||
clouds built on OpenStack.
|
||||
|
||||
Requirements
|
||||
++++++++++++
|
||||
## Requirements
|
||||
|
||||
+----------------------------------+-------------------------------------------+
|
||||
| Requirement | Version/Comment |
|
||||
+==================================+===========================================+
|
||||
|----------------------------------|-------------------------------------------|
|
||||
| Mirantis OpenStack compatility | 6.1 or higher |
|
||||
+----------------------------------+-------------------------------------------+
|
||||
| Distribution Supported | Ubuntu |
|
||||
+----------------------------------+-------------------------------------------+
|
||||
| Talligent Sharefile access | Contact openbook@talligent.com for access |
|
||||
+----------------------------------+-------------------------------------------+
|
||||
|
||||
## Installation
|
||||
|
||||
The plugin in not yet distribuited as package. You have to build it
|
||||
yourself.
|
||||
|
||||
### How to build the plugin
|
||||
|
||||
Please refer to the [Fuel Plugins wiki](https://wiki.openstack.org/wiki/Fuel/Plugins)
|
||||
to build the plugin by yourself, version 2.0.0 (or higher) of the Fuel Plugin Builder
|
||||
is required.
|
||||
|
||||
```
|
||||
git clone https://github.com/openstack/fuel-plugin-openbook.git
|
||||
fpb --build fuel-plugin-openbook
|
||||
```
|
||||
|
||||
### How to install the plugin
|
||||
|
||||
Copy the plugin file to the Fuel Master node.
|
||||
|
||||
```
|
||||
cd fuel-plugin-openbook
|
||||
scp fuel-plugin-openbook*rpm root@<Fuel Master node IP address>:
|
||||
```
|
||||
|
||||
Install the plugin using the fuel command line:
|
||||
|
||||
```
|
||||
ssh root@<Fuel Master node IP address>
|
||||
fuel plugins --install fuel-plugin-openbook*.rpm
|
||||
```
|
||||
|
||||
Verify that the plugin is installed correctly:
|
||||
|
||||
```
|
||||
[root@fuel ~]# fuel plugins --list
|
||||
id | name | version | package_version
|
||||
---|----------------------|---------|----------------
|
||||
2 | fuel-plugin-openbook | 1.0.0 | 2.0.0
|
||||
```
|
||||
|
|
|
@ -22,26 +22,9 @@ class openbook::finalize {
|
|||
$keystone_admin_url = "http://${management_vip}:35357/v2.0"
|
||||
$os_auth_url = "http://${management_vip}:5000/v2.0"
|
||||
|
||||
$fuel_version = hiera('fuel_version')
|
||||
|
||||
case $fuel_version {
|
||||
'6.1': {
|
||||
$keystone_client = 'python-keystoneclient'
|
||||
$keystone_command = 'keystone'
|
||||
$keystone_args = 'tenant-get admin'
|
||||
}
|
||||
default: { # or '7.0'
|
||||
$keystone_client = 'python-openstackclient'
|
||||
$keystone_command = 'openstack'
|
||||
$keystone_args = 'project show admin'
|
||||
|
||||
$public_ssl_hash = hiera('public_ssl')
|
||||
$ip = hiera('public_vip')
|
||||
|
||||
# Need to add trust chain so that Openbook can talk to https endpoints
|
||||
class { 'openbook::ssl_add_trust_chain': }
|
||||
}
|
||||
} ->
|
||||
$keystone_client = 'python-keystoneclient'
|
||||
$keystone_command = 'keystone'
|
||||
$keystone_args = 'tenant-get admin'
|
||||
|
||||
package { "$keystone_client":
|
||||
ensure => present
|
||||
|
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 93 KiB |
After Width: | Height: | Size: 207 KiB |
After Width: | Height: | Size: 176 KiB |
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 65 KiB |
After Width: | Height: | Size: 56 KiB |
|
@ -7,7 +7,7 @@ Intro
|
|||
`Contact Talligent <mailto:openbook@talligent.com>`_ to get access to the
|
||||
Talligent Sharefile account for downloading Openbook and the Openbook User Guide.
|
||||
|
||||
#. `Create a new environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#launch-wizard-to-create-new-environment>`_
|
||||
#. `Create a new environment <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#launch-wizard-to-create-new-environment>`_
|
||||
with the Fuel UI wizard. At the moment only the Ubuntu distribution is supported.
|
||||
|
||||
* When stepping through the 'new OpenStack environment' wizard, be sure to enable
|
||||
|
@ -20,17 +20,7 @@ Talligent Sharefile account for downloading Openbook and the Openbook User Guide
|
|||
|
||||
- Click on the Settings tab of the Fuel web UI.
|
||||
|
||||
For fuel version 7.0: select the "Openbook Plugin" tab, enable
|
||||
the plugin by clicking on the “Openbook Plugin” checkbox and
|
||||
fill-in the required fields:
|
||||
|
||||
.. image:: _static/plugin-openbook-config_s.png
|
||||
:alt: A screenshot of the Openbook Plugin settings UI for 7.0
|
||||
:scale: 90%
|
||||
|
||||
|
||||
For fuel version 6.1: scroll down the page, select the Openbook Plugin
|
||||
check-box and fill-in the required fields:
|
||||
Scroll down the page, select the Openbook Plugin check-box and fill-in the required fields:
|
||||
|
||||
.. image:: _static/plugin-openbook-config-61.png
|
||||
:alt: A screenshot of the Openbook Plugin settings UI for 6.1
|
||||
|
@ -46,31 +36,31 @@ Talligent Sharefile account for downloading Openbook and the Openbook User Guide
|
|||
|
||||
- Switch to the *Nodes* tab.
|
||||
|
||||
- After `adding all OpenStack nodes/roles <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#add-nodes-ug>`_
|
||||
, add a base-os node and rename the base-os host as "openbook":
|
||||
- After `adding all OpenStack nodes/roles <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#add-nodes-ug>`_
|
||||
, add an Operating System (base-os) node and rename the base-os host as "openbook":
|
||||
|
||||
.. image:: _static/openbook-node.png
|
||||
.. image:: _static/select-os-openbook.png
|
||||
:alt: A screenshot of the Openbook host name
|
||||
:scale: 90%
|
||||
|
||||
- Select the *Networks* tab, scroll to the bottom, and `Verify Networks <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#verify-networks>`_.
|
||||
- Select the *Networks* tab, scroll to the bottom, and `Verify Networks <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#verify-networks>`_.
|
||||
|
||||
- Then finally, `Deploy Changes <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_
|
||||
- Then finally, `Deploy Changes <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#deploy-changes>`_
|
||||
|
||||
Plugin Install Verification
|
||||
+++++++++++++++++++++++++++
|
||||
|
||||
Once the deployment is finished, the notification icon will show there to be a new notification message.
|
||||
Once the deployment is finished, a 'Success' notification will display.
|
||||
|
||||
.. image:: _static/deploy-finished-notification.png
|
||||
:alt: A screenshot of the notification icon with a message count
|
||||
.. image:: _static/deployment-success.png
|
||||
:alt: A screenshot of the notification message
|
||||
:scale: 90%
|
||||
|
||||
When clicking the notification icon, there will be a message stating that the plugin is deployed and
|
||||
When expanding the success dialog ('Show additional information'), there will be a message stating that the plugin is deployed and
|
||||
will give the URL schema for accessing the Openbook UI.
|
||||
|
||||
.. image:: _static/deployment-finished.png
|
||||
:alt: A screenshot of the "deployment finished" notification message
|
||||
.. image:: _static/deployment-success-full.png
|
||||
:alt: A screenshot of the full notification message
|
||||
:scale: 90%
|
||||
|
||||
Use the fuel command line to retrieve the IP address of the openbook node.
|
||||
|
@ -78,12 +68,12 @@ Use the fuel command line to retrieve the IP address of the openbook node.
|
|||
.. code:: bash
|
||||
|
||||
[root@fuel ~]# fuel nodes
|
||||
id | status | name | cluster | ip | [..] | roles | [..]
|
||||
---|----------|------------------|---------|-----------|------|-------------------|------
|
||||
2 | ready | Untitled (84:d2) | 2 | 10.20.0.4 | | cinder, compute |
|
||||
1 | ready | Untitled (54:19) | 2 | 10.20.0.3 | | controller, mongo |
|
||||
3 | ready | openbook | 2 | 10.20.0.5 | | base-os |
|
||||
.. | ..... | ................ | ... | ......... | | ............... |
|
||||
id | status | name | cluster | ip | [..] | roles | [..]
|
||||
---|----------|----------------|---------|-----------|------|-------------------|------
|
||||
2 | ready | compute-01 | 2 | 10.20.0.4 | | cinder, compute |
|
||||
1 | ready | controller-01 | 2 | 10.20.0.3 | | controller, mongo |
|
||||
3 | ready | openbook | 2 | 10.20.0.5 | | base-os |
|
||||
.. | ..... | .............. | ... | ......... | | ............... |
|
||||
|
||||
In this example, the Openbook UI would be accessed at ``https://10.20.0.5:8443/Openbook``
|
||||
|
||||
|
|
|
@ -19,7 +19,9 @@ required.
|
|||
.. code:: bash
|
||||
|
||||
git clone https://github.com/openstack/fuel-plugin-openbook.git
|
||||
fpb --build fuel-plugin-openbook
|
||||
cd fuel-plugin-openbook
|
||||
git checkout 6.1
|
||||
fpb --build .
|
||||
|
||||
How to install the plugin
|
||||
+++++++++++++++++++++++++
|
||||
|
@ -28,24 +30,23 @@ Copy the plugin file to the Fuel Master node.
|
|||
|
||||
.. code:: bash
|
||||
|
||||
cd fuel-plugin-openbook
|
||||
scp fuel-plugin-openbook*rpm root@<Fuel Master node IP address>:
|
||||
scp openbook*rpm root@<Fuel Master node IP address>:
|
||||
|
||||
Install the plugin using the fuel command line:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
ssh root@<Fuel Master node IP address>
|
||||
fuel plugins --install fuel-plugin-openbook*.rpm
|
||||
fuel plugins --install openbook*.rpm
|
||||
|
||||
Verify that the plugin is installed correctly:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
[root@fuel ~]# fuel plugins --list
|
||||
id | name | version | package_version
|
||||
---|----------------------|---------|----------------
|
||||
2 | fuel-plugin-openbook | 1.0.0 | 2.0.0
|
||||
[root@fuel ~]# fuel plugins
|
||||
id | name | version | package_version
|
||||
---|----------|---------|----------------
|
||||
1 | openbook | 1.0.0 | 2.0.0
|
||||
|
||||
|
||||
**********
|
||||
|
|
|
@ -4,7 +4,7 @@ title: Openbook Plugin
|
|||
version: '1.0.0'
|
||||
description: Deploys Openbook for billing/invoicing and customer lifecycle management for OpenStack. Openbook URL schema is https://<VIP>:8443/Openbook
|
||||
|
||||
fuel_version: ['6.1', '7.0']
|
||||
fuel_version: ['6.1']
|
||||
licenses: ['Apache License Version 2.0']
|
||||
authors: ['Talligent Inc.']
|
||||
homepage: 'https://github.com/openstack/fuel-plugin-openbook'
|
||||
|
@ -12,11 +12,6 @@ groups: ['monitoring']
|
|||
|
||||
# The plugin is compatible with releases in the list
|
||||
releases:
|
||||
- os: ubuntu
|
||||
version: 2015.1.0-7.0
|
||||
mode: ['ha']
|
||||
deployment_scripts_path: deployment_scripts/
|
||||
repository_path: repositories/ubuntu
|
||||
- os: ubuntu
|
||||
version: 2014.2-6.1
|
||||
mode: ['ha', 'multinode']
|
||||
|
|