Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nizos/horizon-policies-plugin

Plugin for OpenStack's dashboard Horizon for accessing and managing policies
https://github.com/nizos/horizon-policies-plugin

Last synced: about 2 months ago
JSON representation

Plugin for OpenStack's dashboard Horizon for accessing and managing policies

Awesome Lists containing this project

README 

        
# policies_plugin

Plugin for OpenStack's dashboard Horizon for accessing and managing policies



# Quick Start

Instructions for running the plugin using DevStack, Python3.6, pip 20.0.2 and Django 2.2:

```Bash

cd /opt/stack/

git clone https://github.com/nizos/horizon-policies-plugin

cd horizon-policies-plugin/

bash install.bash

```



# Testing

Instructions for running the tests can be found here in [TESTS.md](https://github.com/nizos/horizon-policies-plugin/blob/master/TESTS.md)

## Development Mode

Inotify-tools allows us to automatically reinstall the plangin when any of changes are made to its file. If you do not have inotify-tools installed you can install it by running the following command:

```Bash

sudo apt install inotify-tools

```

Once installed, simply run the following command to start the development mode:

```Bash

# cd /opt/stack/horizon/horizon-policies-plugin/policies-plugin/

bash develop.bash

```

## Viewing logs

To view Horizon dashboard error logs run the following command:

```Bash

tail -f /var/log/apache2/horizon_error.log

```



# Full Installation



## Configuring the environment



### Update & upgrade OS repo

```Bash

sudo apt update

```



```Bash

sudo apt upgrade

```



## Install DevStack

The full guide for installing DevStack can be found [here](https://docs.openstack.org/devstack/train/) but bellow are the quick steps to get up and running.



### Download DevStack



```Bash

git clone https://opendev.org/openstack/devstack

cd devstack

```

The devstack repo contains a script that installs OpenStack and templates for configuration files.



Create a local.conf file with four passwords preset at the root of the devstack git repo.



### Create a local.conf

```Conf

[[local|localrc]]

ADMIN_PASSWORD=secret

DATABASE_PASSWORD=$ADMIN_PASSWORD

RABBIT_PASSWORD=$ADMIN_PASSWORD

SERVICE_PASSWORD=$ADMIN_PASSWORD

```

This is the minimum required config to get started with DevStack.



### Start the install



```Bash

./stack.sh

```

This will take a 15 - 20 minutes, largely depending on the speed of your internet connection. Many git trees and packages will be installed during this process.



Your devstack will have installed keystone, glance, nova, placement, cinder, neutron, and horizon. Floating IPs will be available, guests have access to the external world.



### Install python3 and python3-pip

```Bash

sudo apt install python3

```



```Bash

sudo apt install python3-pip

```



### Install Django

```Bash

python3 -m pip install Django==2.2

```



### Check versions



```Bash

python3 --version

# Python 3.6.9

```



```Bash

python3 -m pip --version

# pip 20.0.2 from /home//.local/lib/python3.6/site-packages/pip (python 3.6)

```



```Bash

python3 -m django --version

# 2.2

```



## Install the plugin



### Clone the repo

Now its time to install the plugin, we start by navigating to where you would like to store the repository on your machine.



```Bash

# Clone the repository anywhere in your file structure.

# Make sure your PWD is where you want to store the repository.

git clone https://github.com/nizos/horizon-policies-plugin

```



#### Further tips

If you want to be able to view .git/ directories in vscode do the following:



1. Open the settings window by clicking on File -> Preferences -> Settings or by hitting `ctrl+,` on your keyboard.

2. type `files.exclude` in the search bar.

3. Highlight the row with .git by hovering over it with your mouse and clicking on the `x` button to remove it from the list files and folder patterns that vscode will automatically hide.



### Install the plugin



Make sure your PWD is /path/to/repository/horizon-policies-plugin/policies-plugin/



```Bash

bash install.bash

```



Wait for the command to finish, make sure to follow any prompts that may occur.



### Offline Compression

If you run into the error _"You have offline compression enabled but key is missing from offline manifest."_:



```Bash

cd /opt/stack/horizon/openstack_dashboard/local/

```



Open local_settings.py and change

```Bash

COMPRESS_OFFLINE = True

```



to

```Bash

COMPRESS_OFFLINE = False

```



### Restart Memcached and Apache2

```Bash

sudo service memcached restart

sudo service apache2 restart

```



## Uninstalling the plugin



To remove a specific package

```Bash

python3 -m pip uninstall 

```

For example, to remove policies-plugin:

```Bash

python3 -m pip uninstall policies-plugin

```



**WARNING**: The uninstallation may fail if your PWD is */path/to/repository/horizon-policies-plugin/policies-plugin* with the message



```Bash

Found existing installation: policies-plugin 0.0...

# Extra text that you get with the --verbose trigger:

Not sure how to uninstall: policies-plugin 0.0... - Check: /path/to/repository/horizon-policies-plugin/policies-plugin

Can't uninstall 'policies-plugin'. No files were found to uninstall.

```



The solution is to change directory and try the same command again.



#### Further tips

If you want to view a list of all package types:

```Bash

python3 -m pip list

```



To view details about a specific package type:

```Bash

python3 -m pip show policies-plugin

```



These commands can help you verify that the plugin has been uninstalled.



# Contributors

Andreas, Nizar, Rickard, Joel & Wissam.