django openstack auth documentation - read the docs · django openstack auth is a pluggable django...
TRANSCRIPT
Django OpenStack AuthDocumentation
Release 1.1.0
Gabriel Hurley
Jun 22, 2017
Contents
1 Getting Started 31.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Running The Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 The User Class 5
3 The Views Module 7
4 The Forms Module 9
5 The Backend Module 11
6 The Utils Module 13
7 Indices and tables 15
i
ii
Django OpenStack Auth Documentation, Release 1.1.0
Django OpenStack Auth is a pluggable Django authentication backend that works with Django’s contrib.authframework to authenticate a user against OpenStack’s Keystone Identity API.
The current version is designed to work with the Keystone V2 API.
Contents 1
Django OpenStack Auth Documentation, Release 1.1.0
2 Contents
CHAPTER 1
Getting Started
Installation
Installing is quick and easy:
1. Run pip install django_openstack_auth.
2. Add openstack_auth to settings.INSTALLED_APPS.
3. Add 'keystone_auth.backend.KeystoneBackend' to your settings.AUTHENTICATION_BACKENDS, e.g.:
AUTHENTICATION_BACKENDS = ('keystone_auth.backend.KeystoneBackend',)
4. Configure your API endpoint(s) in settings.py:
OPENSTACK_KEYSTONE_URL = "http://example.com:5000/v2.0"
5. Include 'keystone_auth.urls' somewhere in your urls.py file.
6. Use it as you would any other Django auth backend.
Running The Tests
Download the repository and run:
python setup.py test
3
Django OpenStack Auth Documentation, Release 1.1.0
4 Chapter 1. Getting Started
CHAPTER 2
The User Class
5
Django OpenStack Auth Documentation, Release 1.1.0
6 Chapter 2. The User Class
CHAPTER 3
The Views Module
7
Django OpenStack Auth Documentation, Release 1.1.0
8 Chapter 3. The Views Module
CHAPTER 4
The Forms Module
9
Django OpenStack Auth Documentation, Release 1.1.0
10 Chapter 4. The Forms Module
CHAPTER 5
The Backend Module
11
Django OpenStack Auth Documentation, Release 1.1.0
12 Chapter 5. The Backend Module
CHAPTER 6
The Utils Module
13
Django OpenStack Auth Documentation, Release 1.1.0
14 Chapter 6. The Utils Module
CHAPTER 7
Indices and tables
• genindex
• modindex
• search
15