Skip to content
This repository has been archived by the owner on Dec 15, 2021. It is now read-only.

Commit

Permalink
README.md restructure
Browse files Browse the repository at this point in the history
  • Loading branch information
propyless committed May 22, 2016
1 parent 110da67 commit 1aea0b1
Showing 1 changed file with 22 additions and 30 deletions.
52 changes: 22 additions & 30 deletions README.md
Expand Up @@ -62,16 +62,11 @@ will need to make a wrapper that enables SCL python3.
- [Supported OS](#supported-operating-systems)
- [Future plans](#future-plans)
- [Introduction](#introduction)
- [Issues](#issues)
- [QueryBuilder](#querybuilder)
- [Screenshots](#screenshots)
- [LDAP Permissions](#ldap-permissions)
- [Multiple Groups](#member-of-multiple-groups)
- [Installation](#installation)
- [Problems with python-ldap python 3 fork.](#problems-with-python-ldap-python-3-fork)
- [RHEL/CentOS 6](#rhelcentos-6)
- [CentOS 7](#centos-7)
- [Upgrading](#upgrading)
- [QueryBuilder](#querybuilder)
- [LDAP Permissions](#ldap-permissions)
- [Multiple Groups](#member-of-multiple-groups)
- [Configuration Options](#configuration-options)
- [Available branches](#available-branches)
- [Contact Me](#contact-me)
Expand Down Expand Up @@ -121,8 +116,25 @@ have over 20k puppetized nodes you need something fast.

This was written for a multi-tenant site across several datacenters.

# Issues
##QueryBuilder
# Installation
For install instructions they can be found in either INSTALL.md or at the PanoPuppet Wiki hosted at Github.
https://github.com/propyless/panopuppet/wiki/Installation-Guides

# Upgrading
Upgrading PanoPuppet should be no harder than doing a git pull origin/master in the /srv/repo/panopuppet directory.
But its recommended to run the `python manage.py collectstatic` command again in case new css/javascripts have been added so that they
are served to your clients. Also make sure to read the config.yaml.example file and see if any new variables have been
implemented!

Upgrading PanoPuppet has a few new steps now as user profiles and permissions has been implemented.
Now you should always run the following commands when updating panopuppet.
`python manage.py collectstatic`
`python manage.py makemigration`
`python manage.py syncdb`
If it doesnt apply any changes, that just means that no changes were done to the database for those latest commits.


## QueryBuilder notes
* I have seen some issues with the querybuilder and the usage of comparison operators. If you have stringify_facts enabled
you may not be able to use the less/less or equal/greater/greater or equal operators since its not possible to
compare string values "123" with "124". You will only be able to use the equal operator for these values.
Expand All @@ -138,9 +150,6 @@ See the below examples:

![Querybuilder Example Query 2](screenshots/querybuilder_example2.png)




# LDAP Permissions
If you have enabled Permissions on users via the config file `ENABLE_PERMISSIONS: true`
By default no normal user (user that is not superuser or staff) will be able to see any servers
Expand Down Expand Up @@ -170,23 +179,6 @@ You can specify them as a normal string or by specifying them as a list.
If a user is a member of multiple groups which have restrictions set for each one
each rule found will be added in an puppetDB OR operator, like so. `["and", ["or", [rule1],[rule2]]]`

# Installation
For install instructions they can be found in either INSTALL.md or at the PanoPuppet Wiki hosted at Github.
https://github.com/propyless/panopuppet/wiki/Installation-Guides

# Upgrading
Upgrading PanoPuppet should be no harder than doing a git pull origin/master in the /srv/repo/panopuppet directory.
But its recommended to run the `python manage.py collectstatic` command again in case new css/javascripts have been added so that they
are served to your clients. Also make sure to read the config.yaml.example file and see if any new variables have been
implemented!

Upgrading PanoPuppet has a few new steps now as user profiles and permissions has been implemented.
Now you should always run the following commands when updating panopuppet.
`python manage.py collectstatic`
`python manage.py makemigration`
`python manage.py syncdb`
If it doesnt apply any changes, that just means that no changes were done to the database for those latest commits.

# Configuration Options
NODES_DEFAULT_FACTS - Is a list of facts to be shown on the node report page.
Default value is: ['operatingsystem', 'operatingsystemrelease', 'puppetversion', 'kernel', 'kernelrelease', 'ipaddress', 'uptime']
Expand Down

0 comments on commit 1aea0b1

Please sign in to comment.