openstack/sunbeam-charms

History

Liam Young fae0c9c648 Support CA for ldaps Change-Id: I6489bd5f7975daf26f9669e17733071b6eaf4654		2023-11-02 06:49:37 +00:00
..
lib/charms	Support CA for ldaps	2023-11-02 06:49:37 +00:00
src	Support CA for ldaps	2023-11-02 06:49:37 +00:00
tests	Merge "Support LDAP config charm" into main	2023-10-20 11:49:59 +00:00
.flake8	Initial commit just to share	2021-07-06 11:54:32 -07:00
.gitignore	Restore libs	2021-10-15 11:39:39 +01:00
.gitreview	Remove references to old github	2022-08-04 15:24:22 +05:30
.jujuignore	Initial commit just to share	2021-07-06 11:54:32 -07:00
.stestr.conf	Sync global tox, requirement files	2022-07-27 12:50:27 +05:30
.zuul.yaml	Switch charm to Bobcat	2023-10-04 10:44:03 +00:00
actions.yaml	Add actions to regenerate password	2023-03-07 07:57:03 +05:30
charmcraft.yaml	Migrate traefik ingress to v2	2023-09-27 09:39:26 +02:00
config.yaml	Enable notifications	2023-08-30 01:39:18 +00:00
CONTRIBUTING.md	Switch charm to Bobcat	2023-10-04 10:44:03 +00:00
fetch-libs.sh	Migrate traefik ingress to v2	2023-09-27 09:39:26 +02:00
LICENSE	Initial commit just to share	2021-07-06 11:54:32 -07:00
metadata.yaml	Merge "Support LDAP config charm" into main	2023-10-20 11:49:59 +00:00
osci.yaml	Switch charm to Bobcat	2023-10-04 10:44:03 +00:00
pyproject.toml	Remove charmhelpers dependancy and add linters	2022-11-03 15:03:50 +00:00
README.md	Switch charm to Bobcat	2023-10-04 10:44:03 +00:00
rename.sh	Add osci yaml	2022-09-08 15:42:20 +05:30
requirements.txt	Migrate traefik ingress to v2	2023-09-27 09:39:26 +02:00
test-requirements.txt	Add 'extra' test dep	2023-09-18 10:04:31 +00:00
tox.ini	Add py311 in tox file	2023-10-20 05:05:22 +05:30

README.md

keystone-k8s

Description

keystone-k8s is an operator to manage the Keystone identity service on a Kubernetes based environment.

Usage

Deployment

keystone-k8s is deployed using below command:

juju deploy keystone-k8s keystone --trust

Now connect the keystone operator to an existing database.

juju relate mysql:database keystone:database

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.

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.

Relations

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

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.
- domain: Keystone v3 domain the user will be created in. Defaults to the Default domain.
identity-service: Used by API endpoints to request an entry in the Keystone service catalogue and the endpoint template catalogue.

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.

OCI Images

The charm by default uses ghcr.io/canonical/keystone:2023.2 image.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.

Bugs

Please report bugs on Launchpad.