keystone #541

Supports: xenial bionic focal groovy hirsute
Add to new model

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

The keystone charm deploys Keystone, the core OpenStack service that provides API client authentication, service discovery, and distributed multi-tenant authorization. The charm works alongside other Juju-deployed OpenStack services.

Usage

Configuration

This section covers common and/or important configuration options. See file config.yaml for the full list of options, along with their descriptions and default values. See the Juju documentation for details on configuring applications.

openstack-origin

The openstack-origin option states the software sources. A common value is an OpenStack UCA release (e.g. 'cloud:bionic-ussuri' or 'cloud:focal-victoria'). See Ubuntu Cloud Archive. The underlying host's existing apt sources will be used if this option is not specified (this behaviour can be explicitly chosen by using the value of 'distro').

Deployment

Keystone is often containerised. Here a single unit is deployed to a new container on machine '1':

juju deploy --to lxd:1 keystone

Now connect the keystone application to an existing cloud database. The database application is determined by the series. Prior to focal percona-cluster is used, otherwise it is mysql-innodb-cluster. In the example deployment below mysql-innodb-cluster has been chosen.

juju deploy mysql-router keystone-mysql-router
juju add-relation keystone-mysql-router:db-router mysql-innodb-cluster:db-router
juju add-relation keystone-mysql-router:shared-db keystone:shared-db

Credentials

The keystone:shared-db relation added at deployment time stores the Keystone admin password in the cloud database. By default this password is generated randomly but, for testing purposes, can be set via the admin-password configuration option. This option can also be used to view and change the password post-deployment.

Actions

This section covers Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis. To display action descriptions run juju actions keystone. If the charm is not deployed then see file actions.yaml.

  • openstack-upgrade
  • pause
  • resume
  • security-checklist

High availability

When more than one unit is deployed with the hacluster application the charm will bring up an HA active/active cluster.

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases the hacluster subordinate charm is used to provide the Corosync and Pacemaker backend HA functionality.

See OpenStack high availability in the OpenStack Charms Deployment Guide for details.

TLS

Communication between Keystone and cloud services (as well as the OpenStack client) can be encrypted with TLS. Keystone also publishes API endpoints for the cloud (e.g. cinder, glance, keystone, neutron, nova, and placement), which may be TLS-based.

There are two methods for managing TLS keys and certificates:

  1. with Vault
  2. manually (via charm options)

Vault can set up private keys and server certificates for an application. It can also store a central CA certificate for the cloud. See the vault charm for more information.

Vault is the recommended method and is what will be covered here.

The private key and server certificate (and its signing) are enabled via a relation made to the vault application:

juju add-relation keystone:certificates vault:certificates

Other applications

When Keystone is TLS-enabled every application that talks to Keystone (i.e. there exists a relation between the two) must be in possession of the signing CA cert. This is achieved by adding a relation between the application and Vault. Doing so will also encrypt the application's own endpoint. For example, the Placement API:

juju add-relation placement:certificates vault:certificates

Vault will issue certificates to the application and Keystone will update the corresponding API endpoint from HTTP to HTTPS.

Note: API endpoints can be listed with openstack catalog list.

Spaces

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 (see MAAS spaces).

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

Policy overrides

Policy overrides is an advanced feature that allows an operator to override the default policy of an OpenStack service. The policies that the service supports, the defaults it implements in its code, and the defaults that a charm may include should all be clearly understood before proceeding.

Caution: It is possible to break the system (for tenants and other services) if policies are incorrectly applied to the service.

Policy statements are placed in a YAML file. This file (or files) is then (ZIP) compressed into a single file and used as an application resource. The override is then enabled via a Boolean charm option.

Here are the essential commands (filenames are arbitrary):

zip overrides.zip override-file.yaml
juju attach-resource keystone policyd-override=overrides.zip
juju config keystone use-policyd-override=true

See Policy overrides in the OpenStack Charms Deployment Guide for a thorough treatment of this feature.

Relations

The charm supports the following relations. They are primarily of use to developers:

  • identity-admin: Used by charms to obtain the credentials for the admin user. This is intended for charms that automatically provision users, tenants, etc.

  • identity-credentials: Used by charms to obtain Keystone credentials without creating a service catalogue 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 service's 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.

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

  • identity-service: Used by API endpoints to request an entry in the Keystone service catalogue and the endpoint template catalogue.

Note: The identity-service relation is not used by Horizon (see keystone-service instead).

When a relation is established Keystone receives the following data from the requesting API endpoint:

  • service_name
  • region
  • public_url
  • admin_url
  • internal_url

Keystone verifies that the requested service is supported (the list of supported services should remain updated). The following will occur for a supported service:

  1. an entry in the service catalogue is created
  2. an endpoint template is created
  3. an admin token is generated.

The API endpoint receives the token and is informed of the ports that Keystone is listening on.

  • keystone-service: Used only by Horizon. Horizon requests its configured default role and Keystone responds with a token. Horizon also receives the authentication and admin ports on which Keystone is listening.

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

Further resources

The below topics are covered in the OpenStack Charms Deployment Guide.

  • Security compliance: Shows how to use the password-security-compliance charm option to set Keystone's security compliance configuration.

  • Token support: Provides a background of Keystone keys and tokens. It explains key rotation, and how to use the fernet-max-active-keys and token-expiration charm options.

Documentation

The OpenStack Charms project maintains two documentation guides:

Bugs

Please report bugs on Launchpad.


Configuration

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.
admin-password
(string) Admin password. To be used *for testing only*. Randomly generated by default. To retrieve the generated password run: . juju run --unit keystone/0 leader-get admin_passwd
None
admin-port
(int) Port the bind the Admin API server to.
35357
admin-role
(string) Admin role to be associated with admin and service users.
Admin
admin-user
(string) Default admin user to create and manage.
admin
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
catalog-cache-expiration
(int) Amount of time (in seconds) the catalog should be cached for.
60
database
(string) Keystone database name.
keystone
database-user
(string) Username used for connecting to the Keystone database.
keystone
debug
(boolean) Enable debug logging.
dns-ha
(boolean) Use DNS HA with MAAS 2.0. Note if this is set do not set vip settings below.
dogpile-cache-expiration
(int) Amount of time (in seconds) to cache items in the dogpile.cache. This only applies to cached methods that do not have an explicitly defined cache expiration time.
600
fernet-max-active-keys
(int) This is the maximum number of active keys when `token-provider` is set to "fernet". If has a minimum of 3, which includes the spare and staging keys. When set to 3, the rotation time for the keys is the same as the token expiration time. When set to a higher value, the rotation time is less than the `token-expiration` time as calculated by: . rotation-time = token-expiration / (fernet-max-active-keys - 2) . Please see the charm documentation for further details about how to use the Fernet token parameters to achieve a key strategy appropriate for the system in question.
3
ha-bindiface
(string) Default network interface on which HA cluster will bind to communication with the other members of the HA Cluster.
eth0
ha-mcastport
(int) Default multicast port number that will be used to communicate between HA Cluster nodes.
5434
haproxy-client-timeout
(int) Client timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used.
haproxy-connect-timeout
(int) Connect timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used.
haproxy-queue-timeout
(int) Queue timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 9000ms is used.
haproxy-server-timeout
(int) Server timeout configuration in ms for haproxy, used in HA configurations. If not provided, default value of 90000ms is used.
harden
(string) Apply system hardening. Supports a space-delimited list of modules to run. Supported modules currently include os, ssh, apache and mysql.
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
keystone-admin-role
(string) Role that allows admin operations (access to all operations).
Admin
keystone-service-admin-role
(string) Role that allows acting as service admin.
KeystoneServiceAdmin
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
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-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
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
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
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
log-level
(string) Log level (WARNING, INFO, DEBUG, ERROR)
WARNING
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
nagios_servicegroups
(string) A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup
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. NOTE: a corresponding public key from keyserver.ubuntu.com can be used when specifying a repository by appending the key separated by a | when entering the deb url sources entry, i.e. openstack-origin="deb <DEB URL>|<PUB KEY>"
distro
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
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.
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
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.
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
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.
password-security-compliance
(string) This config item, if set, is used to configure the [security_compliance] section of the keystone.conf file. This is used to control how the security around passwords is manged. Please refer to the charm README for full details. . The config item should be a YAML complaint string that sets the various allowed options in [security_compliance]. The settings are checked by the charm, but it's possible that it may break things unexpectedly. Please ensure that the the README and relevant documentation is consulted before setting this configuration option.
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.
preferred-api-version
(int) Use this keystone api version for keystone endpoints and advertise this version to identity client charms. For OpenStack releases < Queens this option defaults to 2; for Queens or later it defaults to 3.
region
(string) Space-separated list of Openstack regions.
RegionOne
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.
service-port
(int) Port the bind the API server to.
5000
service-tenant
(string) Name of tenant to associate service credentials.
services
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.
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).
ssl_key
(string) base64-encoded SSL key to use with certificate specified as ssl_cert.
token-expiration
(int) Amount of time (in seconds) a token should remain valid.
3600
token-provider
(string) Transitional configuration option to enable migration to Fernet tokens prior to upgrade to OpenStack Rocky. . Supported values are 'uuid' and 'fernet'. . NOTE: This configuration option is honoured on OpenStack versions Ocata through Queens. For OpenStack Rocky it is a unconfigurable default. Silently ignored for all other versions.
use-policyd-override
(boolean) If True then use the resource file named 'policyd-override' to install override YAML files in the service's policy.d directory. The resource file should be a ZIP file containing at least one yaml file with a .yaml or .yml extension. If False then remove the overrides.
use-syslog
(boolean) Setting this to True will allow supporting services to log to syslog.
verbose
(boolean) Enable verbose logging.
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.
vip_cidr
(int) Default CIDR netmask to use for HA vip when it cannot be automatically determined.
24
vip_iface
(string) Default network interface to use for HA vip when it cannot be automatically determined.
eth0
worker-multiplier
(float) The CPU core multiplier to use when configuring worker processes for this service. By default, the number of workers for each daemon is set to twice the number of CPU cores a service unit has. This default value will be capped to 4 workers unless this configuration option is set.