Keystone is an OpenStack project that provides Identity, Token, Catalog and
Policy services for use specifically by projects in the OpenStack family. It
implements OpenStack’s Identity API.

Overview

This charm provides Keystone, the Openstack identity service. It's target
platform is (ideally) Ubuntu LTS + Openstack.

Usage

The following interfaces are provided:

- nrpe-external-master: Used to generate Nagios checks.

- identity-service: Openstack API endpoints request an entry in the 
  Keystone service catalog + endpoint template catalog. When a relation
  is established, Keystone receives: service name, region, public_url,
  admin_url and internal_url. It first checks that the requested service
  is listed as a supported service. This list should stay updated to
  support current Openstack core services. If the service is supported,
  an entry in the service catalog is created, an endpoint template is
  created and a admin token is generated. The other end of the relation
  receives the token as well as info on which ports Keystone is listening
  on.

- keystone-service: This is currently only used by Horizon/dashboard
  as its interaction with Keystone is different from other Openstack API
  services. That is, Horizon requests a Keystone role and token exists.
  During a relation, Horizon requests its configured default role and
  Keystone responds with a token and the auth + admin ports on which
  Keystone is listening.

- identity-admin: Charms use this relation to obtain the credentials
  for the admin user. This is intended for charms that automatically
  provision users, tenants, etc. or that otherwise automate using the
  Openstack cluster deployment.

- identity-notifications: Used to broadcast messages to any services
  listening on the interface.

Database

Keystone requires a database. By default, a local sqlite database is used.
The charm supports relations to a shared-db via mysql-shared interface. When
a new data store is configured, the charm ensures the minimum administrator
credentials exist (as configured via charm configuration)

HA/Clustering

VIP is only required if you plan on multi-unit clustering (requires relating
with hacluster charm). The VIP becomes a highly-available API endpoint.

SSL/HTTPS

This charm also supports SSL and HTTPS endpoints. In order to ensure SSL
certificates are only created once and distributed to all units, one unit gets
elected as an ssl-cert-master. One side-effect of this is that as units are
scaled-out the currently elected leader needs to be running in order for nodes
to sync certificates. This 'feature' is to work around the lack of native
leadership election via Juju itself, a feature that is due for release some
time soon but until then we have to rely on this. Also, if a keystone unit does
go down, it must be removed from Juju i.e.

juju destroy-unit keystone/<unit-num>

Otherwise it will be assumed that this unit may come back at some point and
therefore must be know to be in-sync with the rest before continuing.

Deploying from source

The minimum openstack-origin-git config required to deploy from source is:

openstack-origin-git: include-file://keystone-juno.yaml

keystone-juno.yaml
    repositories:
    - {name: requirements,
       repository: 'git://github.com/openstack/requirements',
       branch: stable/juno}
    - {name: keystone,
       repository: 'git://github.com/openstack/keystone',
       branch: stable/juno}

Note that there are only two 'name' values the charm knows about: 'requirements'
and 'keystone'. These repositories must correspond to these 'name' values.
Additionally, the requirements repository must be specified first and the
keystone repository must be specified last. All other repostories are installed
in the order in which they are specified.

The following is a full list of current tip repos (may not be up-to-date):

openstack-origin-git: include-file://keystone-master.yaml

keystone-master.yaml
    repositories:
    - {name: requirements,
       repository: 'git://github.com/openstack/requirements',
       branch: master}
    - {name: oslo-concurrency,
       repository: 'git://github.com/openstack/oslo.concurrency',
       branch: master}
    - {name: oslo-config,
       repository: 'git://github.com/openstack/oslo.config',
       branch: master}
    - {name: oslo-db,
       repository: 'git://github.com/openstack/oslo.db',
       branch: master}
    - {name: oslo-i18n,
       repository: 'git://github.com/openstack/oslo.i18n',
       branch: master}
    - {name: oslo-serialization,
       repository: 'git://github.com/openstack/oslo.serialization',
       branch: master}
    - {name: oslo-utils,
       repository: 'git://github.com/openstack/oslo.utils',
       branch: master}
    - {name: pbr,
       repository: 'git://github.com/openstack-dev/pbr',
       branch: master}
    - {name: python-keystoneclient,
       repository: 'git://github.com/openstack/python-keystoneclient',
       branch: master}
    - {name: sqlalchemy-migrate,
       repository: 'git://github.com/stackforge/sqlalchemy-migrate',
       branch: master}
    - {name: keystonemiddleware,
       repository: 'git://github.com/openstack/keystonemiddleware',
       branch: master}
    - {name: keystone,
       repository: 'git://github.com/openstack/keystone',
       branch: master}

Network Space support

This charm supports the use of Juju Network Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above.

API endpoints can be bound to distinct network spaces supporting the network separation of public, internal and admin endpoints.

Access to the underlying MySQL instance can also be bound to a specific space using the shared-db relation.

To use this feature, use the --bind option when deploying the charm:

juju deploy keystone --bind "public=public-space internal=internal-space admin=admin-space shared-db=internal-space"

alternatively these can also be provided as part of a juju native bundle configuration:

keystone:
  charm: cs:xenial/keystone
  num_units: 1
  bindings:
    public: public-space
    admin: admin-space
    internal: internal-space
    shared-db: internal-space

NOTE: Spaces must be configured in the underlying provider prior to attempting to use them.

NOTE: Existing deployments using os-*-network configuration options will continue to function; these options are preferred over any network space binding provided if set.

Configuration

ssl_key
(string)
                            SSL key to use with certificate specified as ssl_cert.
                        
admin-token
(string)
                            Admin token. If set, this token will be used for all services instead of
being generated per service.

                        
None
vip_iface
(string)
                            Default network interface to use for HA vip when it cannot be
automatically determined.

                        
eth0
verbose
(boolean)
                            Enable debug logging.
                        
nagios_servicegroups
(string)
                            A comma-separated list of nagios servicegroups.
If left empty, the nagios_context will be used as the servicegroup

                        
haproxy-server-timeout
(int)
                            Server timeout configuration in ms for haproxy, used in HA
configurations. If not provided, default value of 30000ms is used.

                        
service-port
(int)
                            Port the bind the API server to.
                        
5000
ldap-user
(string)
                            Username of the ldap identity server.
                        
None
identity-backend
(string)
                            Keystone identity backend, valid options are: sql, ldap, kvs, pam.

                        
sql
https-service-endpoints
(string)
                            Manage SSL certificates for all service endpoints.
                        
False
vip
(string)
                            Virtual IP(s) to use to front API services in HA configuration.

If multiple networks are being used, a VIP should be provided for each
network, separated by spaces.

                        
config-file
(string)
                            Location of keystone configuration file
                        
/etc/keystone/keystone.conf
worker-multiplier
(int)
                            The CPU core multiplier to use when configuring worker processes for
Keystone.  By default, the number of workers for each daemon is set to
twice the number of CPU cores a service unit has.

                        
2
admin-password
(string)
                            Admin password. To be used *for testing only*. Randomly generated by
default.

                        
None
haproxy-queue-timeout
(int)
                            Queue timeout configuration in ms for haproxy, used in HA
configurations. If not provided, default value of 5000ms is used.

                        
token-expiration
(int)
                            Amount of time a token should remain valid (in seconds).
                        
3600
os-admin-network
(string)
                            The IP address and netmask of the OpenStack Admin network (e.g.,
192.168.0.0/24)
.
This network will be used for admin endpoints.

                        
prefer-ipv6
(boolean)
                            If True enables IPv6 support. The charm will expect network interfaces
to be configured with an IPv6 address. If set to False (default) IPv4
is expected.
.
NOTE: these charms do not currently support IPv6 privacy extension. In
order for this charm to function correctly, the privacy extension must be
disabled and a non-temporary address must be configured/available on
your network interface.

                        
ldap-server
(string)
                            Ldap server address for keystone identity backend.
                        
None
keystone-admin-role
(string)
                            Role that allows admin operations (access to all operations).
                        
Admin
service-tenant
(string)
                            Name of tenant to associate service credentials.
                        
services
os-public-network
(string)
                            The IP address and netmask of the OpenStack Public network (e.g.,
192.168.0.0/24)
.
This network will be used for public endpoints.

                        
ha-mcastport
(int)
                            Default multicast port number that will be used to communicate between
HA Cluster nodes.

                        
5434
use-syslog
(boolean)
                            Setting this to True will allow supporting services to log to syslog.

                        
ha-bindiface
(string)
                            Default network interface on which HA cluster will bind to communication
with the other members of the HA Cluster.

                        
eth0
admin-user
(string)
                            Default admin user to create and manage.
                        
admin
haproxy-client-timeout
(int)
                            Client timeout configuration in ms for haproxy, used in HA
configurations. If not provided, default value of 30000ms is used.

                        
admin-role
(string)
                            Admin role to be associated with admin and service users
                        
Admin
admin-port
(int)
                            Port the bind the Admin API server to.
                        
35357
os-public-hostname
(string)
                            The hostname or address of the public endpoints created for keystone
in the keystone identity provider (itself).
.
This value will be used for public endpoints. For example, an
os-public-hostname set to 'keystone.example.com' with ssl enabled will
create a public endpoint for keystone as:
.
https://keystone.example.com:5000/v2.0

                        
action-managed-upgrade
(boolean)
                            If True enables openstack upgrades for this charm via juju actions.
You will still need to set openstack-origin to the new repository but
instead of an upgrade running automatically across all units, it will
wait for you to execute the openstack-upgrade action for this charm on
each unit. If False it will revert to existing behavior of upgrading
all units on config change.

                        
use-https
(string)
                            Use SSL for Keystone itself. Set to 'yes' to enable it.
                        
no
ssl_cert
(string)
                            SSL certificate to install and use for API ports.  Setting this value
and ssl_key will enable reverse proxying, point Keystone's entry in the
Keystone catalog to use https, and override any certficiate and key
issued by Keystone (if it is configured to do so).

                        
ldap-suffix
(string)
                            Ldap server suffix to be used by keystone.
                        
None
enable-pki
(string)
                            Enable PKI token signing (>= Grizzly).
                        
false
ldap-readonly
(boolean)
                            Ldap identity server backend readonly to keystone.
                        
True
keystone-service-admin-role
(string)
                            Role that allows acting as service admin.
                        
KeystoneServiceAdmin
openstack-origin
(string)
                            Repository from which to install.  May be one of the following:
distro (default), ppa:somecustom/ppa, a deb url sources entry,
or a supported Cloud Archive release pocket.

Supported Cloud Archive sources include:

cloud:<series>-<openstack-release>
cloud:<series>-<openstack-release>/updates
cloud:<series>-<openstack-release>/staging
cloud:<series>-<openstack-release>/proposed

For series=Precise we support cloud archives for openstack-release:
   * icehouse

For series=Trusty we support cloud archives for openstack-release:
   * juno
   * kilo
   * ...

NOTE: updating this setting to a source that is known to provide
a later version of OpenStack will trigger a software upgrade.

NOTE: when openstack-origin-git is specified, openstack specific
packages will be installed from source rather than from the
openstack-origin repository.

                        
distro
os-internal-network
(string)
                            The IP address and netmask of the OpenStack Internal network (e.g.,
192.168.0.0/24)
.
This network will be used for internal endpoints.

                        
database
(string)
                            Keystone database name.
                        
keystone
openstack-origin-git
(string)
                            Specifies a YAML-formatted dictionary listing the git
repositories and branches from which to install OpenStack and
its dependencies.

Note that the installed config files will be determined based on
the OpenStack release of the openstack-origin option.

For more details see README.md.

                        
region
(string)
                            Space-separated list of Openstack regions.

                        
RegionOne
nagios_context
(string)
                            Used by the nrpe-external-master subordinate charm.
A string that will be prepended to instance name to set the host name
in nagios. So for instance the hostname would be something like:
    juju-myservice-0
If you're running multiple environments with the same services in them
this allows you to differentiate between them.

                        
juju
service-admin-prefix
(string)
                            When service relations are joined they provide a name used to create a
service admin_username in keystone. The name used may be too crude for
some situations e.g. pre-populated LDAP identity backend. If set, this
option will be prepended to each service admin_username.

                        
assignment-backend
(string)
                            Keystone assignment backend, valid options are sql, ldap, kvs.

                        
sql
ssl_ca
(string)
                            SSL CA to use with the certificate and key provided - this is only
required if you are providing a privately signed ssl_cert and ssl_key.

                        
harden
(string)
                            Apply system hardening. Supports a space-delimited list of modules
to run. Supported modules currently include os, ssh, apache and mysql.

                        
log-level
(string)
                            Log level (WARNING, INFO, DEBUG, ERROR)
                        
WARNING
ldap-password
(string)
                            Password of the ldap identity server.
                        
None
ldap-config-flags
(string)
                            comma sperated options for ldap configuration.
                        
None
debug
(boolean)
                            Enable verbose logging.
                        
haproxy-connect-timeout
(int)
                            Connect timeout configuration in ms for haproxy, used in HA
configurations. If not provided, default value of 5000ms is used.

                        
database-user
(string)
                            Username used for connecting to the Keystone database.
                        
keystone
vip_cidr
(int)
                            Default CIDR netmask to use for HA vip when it cannot be automatically
determined.

                        
24
preferred-api-version
(int)
                            Use this keystone api version for keystone endpoints and advertise this
version to identity client charms

                        
2