Keystone K8S

By OpenStack Charmers

Architecture:

Channel	Revision	Published	Runs on
yoga/beta	82	10 Mar 2023	Ubuntu 22.04
yoga/edge	99	16 May 2023	Ubuntu 22.04
xena/beta	72	21 Nov 2022	Ubuntu 22.04
xena/edge	76	20 Jan 2023	Ubuntu 22.04
2024.1/edge	172	28 Apr 2024	Ubuntu 22.04
2023.2/stable	148	06 Dec 2023	Ubuntu 22.04
2023.2/candidate	169	05 Apr 2024	Ubuntu 22.04
2023.2/beta	169	05 Apr 2024	Ubuntu 22.04
2023.2/edge	169	03 Apr 2024	Ubuntu 22.04
2023.1/stable	125	26 Sep 2023	Ubuntu 22.04
2023.1/candidate	155	12 Jan 2024	Ubuntu 22.04
2023.1/beta	155	10 Jan 2024	Ubuntu 22.04
2023.1/edge	155	03 Jan 2024	Ubuntu 22.04

Learn to deploy on juju >

Platform:

charms.keystone_k8s.v1.identity_service

Docstrings Source code

IdentityServiceProvides and Requires module.

This library contains the Requires and Provides classes for handling the identity_service interface.

Import IdentityServiceRequires in your charm, with the charm object and the relation name: - self - "identity_service"

Also provide additional parameters to the charm object: - service - internal_url - public_url - admin_url - region - username - vhost

Two events are also available to respond to: - connected - ready - goneaway

A basic example showing the usage of this relation follows:

from charms.keystone_k8s.v1.identity_service import IdentityServiceRequires

class IdentityServiceClientCharm(CharmBase):
    def __init__(self, *args):
        super().__init__(*args)
        # IdentityService Requires
        self.identity_service = IdentityServiceRequires(
            self, "identity_service",
            service = "my-service"
            internal_url = "http://internal-url"
            public_url = "http://public-url"
            admin_url = "http://admin-url"
            region = "region"
        )
        self.framework.observe(
            self.identity_service.on.connected, self._on_identity_service_connected)
        self.framework.observe(
            self.identity_service.on.ready, self._on_identity_service_ready)
        self.framework.observe(
            self.identity_service.on.goneaway, self._on_identity_service_goneaway)

    def _on_identity_service_connected(self, event):
        '''React to the IdentityService connected event.

        This event happens when n IdentityService relation is added to the
        model before credentials etc have been provided.
        '''
        # Do something before the relation is complete
        pass

    def _on_identity_service_ready(self, event):
        '''React to the IdentityService ready event.

        The IdentityService interface will use the provided config for the
        request to the identity server.
        '''
        # IdentityService Relation is ready. Do something with the completed relation.
        pass

    def _on_identity_service_goneaway(self, event):
        '''React to the IdentityService goneaway event.

        This event happens when an IdentityService relation is removed.
        '''
        # IdentityService Relation has goneaway. shutdown services or suchlike
        pass

Index

class IdentityServiceConnectedEvent
class IdentityServiceReadyEvent
class IdentityServiceGoneAwayEvent
class IdentityServiceServerEvents
class IdentityServiceRequires
- def __init__( self, charm, relation_name, service_endpoints, region)
- def get_remote_app_data( self, key)
- def api_version( self)
- def auth_host( self)
- def auth_port( self)
- def auth_protocol( self)
- def internal_host( self)
- def internal_port( self)
- def internal_protocol( self)
- def admin_domain_name( self)
- def admin_domain_id( self)
- def admin_project_name( self)
- def admin_project_id( self)
- def admin_user_name( self)
- def admin_user_id( self)
- def service_domain_name( self)
- def service_domain_id( self)
- def service_host( self)
- def service_credentials( self)
- def service_password( self)
- def service_port( self)
- def service_protocol( self)
- def service_project_name( self)
- def service_project_id( self)
- def service_user_name( self)
- def service_user_id( self)
- def internal_auth_url( self)
- def admin_auth_url( self)
- def public_auth_url( self)
- def admin_role( self)
- def register_services( self, service_endpoints, region)
class HasIdentityServiceClientsEvent
class ReadyIdentityServiceClientsEvent
- def __init__( self, handle, relation_id, relation_name, service_endpoints, region, client_app_name)
- def snapshot( self)
- def restore( self, snapshot)
class IdentityServiceClientEvents
class IdentityServiceProvides
- def __init__( self, charm, relation_name)
- def set_identity_service_credentials( self, relation_name, relation_id, api_version, auth_host, auth_port, auth_protocol, internal_host, internal_port, internal_protocol, service_host, service_port, service_protocol, admin_domain, admin_project, admin_user, service_domain, service_project, service_user, internal_auth_url, admin_auth_url, public_auth_url, service_credentials, admin_role)

Description

IdentityService connected Event. None

Description

IdentityService ready for use Event. None

Description

IdentityService relation has gone-away Event None

Description

Events class for on None

Description

IdentityServiceRequires class None

Methods

IdentityServiceRequires. __init__( self , charm , relation_name: str , service_endpoints: dict , region: str )

IdentityServiceRequires. get_remote_app_data( self , key: str )

Description

Return the value for the given key from remote app data. None

IdentityServiceRequires. api_version( self )

Description

Return the api_version. None

IdentityServiceRequires. auth_host( self )

Description

Return the auth_host. None

IdentityServiceRequires. auth_port( self )

Description

Return the auth_port. None

IdentityServiceRequires. auth_protocol( self )

Description

Return the auth_protocol. None

IdentityServiceRequires. internal_host( self )

Description

Return the internal_host. None

IdentityServiceRequires. internal_port( self )

Description

Return the internal_port. None

IdentityServiceRequires. internal_protocol( self )

Description

Return the internal_protocol. None

IdentityServiceRequires. admin_domain_name( self )

Description

Return the admin_domain_name. None

IdentityServiceRequires. admin_domain_id( self )

Description

Return the admin_domain_id. None

IdentityServiceRequires. admin_project_name( self )

Description

Return the admin_project_name. None

IdentityServiceRequires. admin_project_id( self )

Description

Return the admin_project_id. None

IdentityServiceRequires. admin_user_name( self )

Description

Return the admin_user_name. None

IdentityServiceRequires. admin_user_id( self )

Description

Return the admin_user_id. None

IdentityServiceRequires. service_domain_name( self )

Description

Return the service_domain_name. None

IdentityServiceRequires. service_domain_id( self )

Description

Return the service_domain_id. None

IdentityServiceRequires. service_host( self )

Description

Return the service_host. None

IdentityServiceRequires. service_credentials( self )

Description

Return the service_credentials secret. None

IdentityServiceRequires. service_password( self )

Description

Return the service_password. None

IdentityServiceRequires. service_port( self )

Description

Return the service_port. None

IdentityServiceRequires. service_protocol( self )

Description

Return the service_protocol. None

IdentityServiceRequires. service_project_name( self )

Description

Return the service_project_name. None

IdentityServiceRequires. service_project_id( self )

Description

Return the service_project_id. None

IdentityServiceRequires. service_user_name( self )

Description

Return the service_user_name. None

IdentityServiceRequires. service_user_id( self )

Description

Return the service_user_id. None

IdentityServiceRequires. internal_auth_url( self )

Description

Return the internal_auth_url. None

IdentityServiceRequires. admin_auth_url( self )

Description

Return the admin_auth_url. None

IdentityServiceRequires. public_auth_url( self )

Description

Return the public_auth_url. None

IdentityServiceRequires. admin_role( self )

Description

Return the admin_role. None

IdentityServiceRequires. register_services( self , service_endpoints: dict , region: str )

Description

Request access to the IdentityService server. None

Description

Has IdentityServiceClients Event. None

Description

IdentityServiceClients Ready Event. None

Methods

ReadyIdentityServiceClientsEvent. __init__( self , handle , relation_id , relation_name , service_endpoints , region , client_app_name )

ReadyIdentityServiceClientsEvent. snapshot( self )

ReadyIdentityServiceClientsEvent. restore( self , snapshot )

Description

Events class for on None

Description

IdentityServiceProvides class None

Methods

IdentityServiceProvides. __init__( self , charm , relation_name )

IdentityServiceProvides. set_identity_service_credentials( self , relation_name: int , relation_id: str , api_version: str , auth_host: str , auth_port: str , auth_protocol: str , internal_host: str , internal_port: str , internal_protocol: str , service_host: str , service_port: str , service_protocol: str , admin_domain: dict , admin_project: dict , admin_user: dict , service_domain: dict , service_project: dict , service_user: dict , internal_auth_url: str , admin_auth_url: str , public_auth_url: str , service_credentials: str , admin_role: str )

Keystone K8S

charms.keystone_k8s.v1.identity_service

class IdentityServiceConnectedEvent

class IdentityServiceReadyEvent

class IdentityServiceGoneAwayEvent

class IdentityServiceServerEvents

class IdentityServiceRequires

class HasIdentityServiceClientsEvent

class ReadyIdentityServiceClientsEvent

class IdentityServiceClientEvents

class IdentityServiceProvides