keystone #272

Description

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.

- identity-credentials: Charms use this relation to obtain keystone
  credentials without creating a service catalog entry. Set 'username'
  only on the relation and keystone will set defaults and return
  authentication details. Possible relation settings:
    username: Username to be created.
    project: Project (tenant) name to be created. Defaults to services
             project.
    requested_roles: Comma delimited list of roles to be created
    requested_grants: Comma delimited list of roles to be granted.
                      Defaults to Admin role.
    domain: Keystone v3 domain the user will be created in. Defaults
            to the Default domain.

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

There are two mutually exclusive high availability options: using virtual
IP(s) or DNS. In both cases, a relationship to hacluster is required which
provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that
the VIP is a valid IP on the subnet for one of the node's interfaces and each
node has an interface in said subnet. The VIP becomes a highly-available API
endpoint.

At a minimum, the config option 'vip' must be set in order to use virtual IP
HA. If multiple networks are being used, a VIP should be provided for each
network, separated by spaces. Optionally, vip_iface or vip_cidr may be
specified.

To use DNS high availability there are several prerequisites. However, DNS HA
does not require the clustered nodes to be on the same subnet.
Currently the DNS HA feature is only available for MAAS 2.0 or greater
environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must
have static or "reserved" IP addresses registered in MAAS. The DNS hostname(s)
must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option 'dns-ha' must be set to true and at least one
of 'os-public-hostname', 'os-internal-hostname' or 'os-internal-hostname' must
be set in order to use DNS HA. One or more of the above hostnames may be set.

The charm will throw an exception in the following circumstances:
If neither 'vip' nor 'dns-ha' is set and the charm is related to hacluster
If both 'vip' and 'dns-ha' are set as they are mutually exclusive
If 'dns-ha' is set and none of the os-{admin,internal,public}-hostname(s) are set

SSL/HTTPS

Support for SSL and https endpoint is provided via a set of configuration
options on the charm. There are two types supported;

use-https - if enabled this option tells Keystone to configure the identity
endpoint as https. Under this model the keystone charm will either use the CA
as provided by the user (see ssl_* options below) or will generate its own and
sync across peers. The cert will be distributed to all service endpoints which
will be configured to use https.

https-service-endpoints - if enabled this option tells Keystone to configure
ALL endpoints as https. Under this model the keystone charm will either use the
CA as provided by the user (see ssl_* options below) or will generate its own
and sync across peers. The cert will be distributed to all service endpoints
which will be configured to use https as well as configuring themselves to be
used as https.

When configuring the charms to use SSL there are three charm config options as
ssl_ca, ssl_cert and ssl_key.

  • The user can provide their own CA, SSL cert and key using the options ssl_ca,
    ssl_cert, ssl_key.

  • The user can provide SSL cert and key using ssl_cert and ssl_key when the cert
    is signed by a trusted CA.

  • If not provided, the keystone charm will automatically generate a CA and certs
    to distribute to endpoints.

When the charm configures itself as a CA (generally only recommended for test
purposes) it will elect an "ssl-cert-master" whose duty is to generate the CA
and certs and ensure they are distributed across all peers. This leader is
distinct from the charm leader as elected by Juju so that if the Juju leader
switches we still have the ability to know which unit held the last-known-good
copy of CA/cert data. If the Juju leader switches the charm should eventually
work it out and migrate the ssl-cert-master to the new leader unit.

One side-effect of this is that if the unit currently elected as
ssl-cert-master goes down, the remaining peer units or indeed any new units
will not be able to sync the ssl data of the master or re-elect a new master.
This does currently require manual intervention to resolve. If no action is
taken, it will be assumed that this unit may come back at some point and
therefore must be known to be in-sync with the rest before continuing.

It is possible to check which unit is the ssl-cert-master with:

~$ juju run --unit keystone/0 "relation-ids cluster"
cluster:6
~$ juju run --unit keystone/0 "relation-get -r cluster:6 ssl-cert-master keystone/0"
keystone/0

If the master unit goes down and you want to manually migrate it to another
unit (that you are 100% sure holds an authoritative copy of the ssl certs)
you can do:

~$ juju run --unit keystone/0 "relation-set -r cluster:6 ssl-cert-master=keystone/1"

Where keystone/1 is known to hold a good copy of the CA/cert info and is
preferrably also the cluster leader.

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) base64-encoded 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 verbose 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. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
None
identity-backend
(string) Keystone identity backend, valid options are: sql, ldap, pam. . NOTE: this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends.
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
(float) 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. When deployed in a LXD container, this default value will be capped to 4 workers unless this configuration option is set.
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 (in seconds) a token should remain valid.
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. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
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.
ssl_cert
(string) base64-encoded 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 certificate and key issued by Keystone (if it is configured to do so).
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
os-admin-hostname
(string) The hostname or address of the admin endpoints created for keystone in the keystone identity provider (itself). . This value will be used for admin endpoints. For example, an os-admin-hostname set to 'keystone.admin.example.com' with ssl enabled will create a admin endpoint for keystone as: . https://keystone.admin.example.com:5000/v2.0
ldap-suffix
(string) Ldap server suffix to be used by keystone. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
None
enable-pki
(string) Enable PKI token signing.
false
ldap-readonly
(boolean) Ldap identity server backend readonly to keystone. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
True
dns-ha
(boolean) Use DNS HA with MAAS 2.0. Note if this is set do not set vip settings below.
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 Ubuntu Cloud Archive e.g. . cloud:<series>-<openstack-release> cloud:<series>-<openstack-release>/updates cloud:<series>-<openstack-release>/staging cloud:<series>-<openstack-release>/proposed . See https://wiki.ubuntu.com/OpenStack/CloudArchive for info on which cloud archives are available and supported. . NOTE: updating this setting to a source that is known to provide a later version of OpenStack will trigger a software upgrade unless action-managed-upgrade is set to True.
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 default OpenStack release name, or a YAML dictionary listing the git repositories to install from. . The default Openstack release name may be one of the following, where the corresponding OpenStack github branch will be used: * liberty * mitaka * newton * master . The YAML must minimally include requirements and keystone repositories, and may also include repositories for other dependencies: repositories: - {name: requirements, repository: 'git://github.com/openstack/requirements', branch: master} - {name: keystone, repository: 'git://github.com/openstack/keystone', branch: master} release: master
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 are 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. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
sql
ssl_ca
(string) base64-encoded 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. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
None
ldap-config-flags
(string) Comma-separated options for ldap configuration. . [DEPRECATED] this option should no longer be used to configure ldap. Instead the cs:keystone-ldap subordinate charm should be used to configure ldap backends. This option will be removed in the next release.
None
debug
(boolean) Enable debug logging.
os-internal-hostname
(string) The hostname or address of the internal endpoints created for keystone in the keystone identity provider (itself). . This value will be used for internal endpoints. For example, an os-internal-hostname set to 'keystone.internal.example.com' with ssl enabled will create a internal endpoint for keystone as: . https://keystone.internal.example.com:5000/v2.0
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