Keystone K8S

  • By OpenStack Charmers
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
juju deploy keystone-k8s --channel 2023.2/stable
Show information

Platform:

charms.keystone_k8s.v0.identity_credentials

IdentityCredentialsProvides and Requires module.

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

Import IdentityCredentialsRequires in your charm, with the charm object and the relation name: - self - "identity_credentials"

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.v0.identity_credentials import IdentityCredentialsRequires

class IdentityCredentialsClientCharm(CharmBase):
    def __init__(self, *args):
        super().__init__(*args)
        # IdentityCredentials Requires
        self.identity_credentials = IdentityCredentialsRequires(
            self, "identity_credentials",
            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_credentials.on.connected, self._on_identity_credentials_connected)
        self.framework.observe(
            self.identity_credentials.on.ready, self._on_identity_credentials_ready)
        self.framework.observe(
            self.identity_credentials.on.goneaway, self._on_identity_credentials_goneaway)

    def _on_identity_credentials_connected(self, event):
        '''React to the IdentityCredentials connected event.

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

    def _on_identity_credentials_ready(self, event):
        '''React to the IdentityCredentials ready event.

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

    def _on_identity_credentials_goneaway(self, event):
        '''React to the IdentityCredentials goneaway event.

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

class IdentityCredentialsConnectedEvent

Description

IdentityCredentials connected Event. None

class IdentityCredentialsReadyEvent

Description

IdentityCredentials ready for use Event. None

class IdentityCredentialsGoneAwayEvent

Description

IdentityCredentials relation has gone-away Event None

class IdentityCredentialsServerEvents

Description

Events class for on None

class IdentityCredentialsRequires

Description

IdentityCredentialsRequires class None

Methods

IdentityCredentialsRequires. __init__( self , charm , relation_name: str )

IdentityCredentialsRequires. get_remote_app_data( self , key: str )

Description

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

IdentityCredentialsRequires. api_version( self )

Description

Return the api_version. None

IdentityCredentialsRequires. auth_host( self )

Description

Return the auth_host. None

IdentityCredentialsRequires. auth_port( self )

Description

Return the auth_port. None

IdentityCredentialsRequires. auth_protocol( self )

Description

Return the auth_protocol. None

IdentityCredentialsRequires. internal_host( self )

Description

Return the internal_host. None

IdentityCredentialsRequires. internal_port( self )

Description

Return the internal_port. None

IdentityCredentialsRequires. internal_protocol( self )

Description

Return the internal_protocol. None

IdentityCredentialsRequires. credentials( self )

IdentityCredentialsRequires. username( self )

IdentityCredentialsRequires. password( self )

IdentityCredentialsRequires. project_name( self )

Description

Return the project name. None

IdentityCredentialsRequires. project_id( self )

Description

Return the project id. None

IdentityCredentialsRequires. user_domain_name( self )

Description

Return the name of the user domain. None

IdentityCredentialsRequires. user_domain_id( self )

Description

Return the id of the user domain. None

IdentityCredentialsRequires. project_domain_name( self )

Description

Return the name of the project domain. None

IdentityCredentialsRequires. project_domain_id( self )

Description

Return the id of the project domain. None

IdentityCredentialsRequires. region( self )

Description

Return the region for the auth urls. None

IdentityCredentialsRequires. internal_endpoint( self )

Description

Return the region for the internal auth url. None

IdentityCredentialsRequires. public_endpoint( self )

Description

Return the region for the public auth url. None

IdentityCredentialsRequires. admin_role( self )

Description

Return the admin_role. None

IdentityCredentialsRequires. request_credentials( self )

Description

Request credentials from the IdentityCredentials server. None

class HasIdentityCredentialsClientsEvent

Description

Has IdentityCredentialsClients Event. None

class ReadyIdentityCredentialsClientsEvent

Description

IdentityCredentialsClients Ready Event. None

Methods

ReadyIdentityCredentialsClientsEvent. __init__( self , handle , relation_id , relation_name , username )

ReadyIdentityCredentialsClientsEvent. snapshot( self )

ReadyIdentityCredentialsClientsEvent. restore( self , snapshot )

class IdentityCredentialsClientsGoneAwayEvent

Description

Has IdentityCredentialsClientsGoneAwayEvent Event. None

class IdentityCredentialsClientEvents

Description

Events class for on None

class IdentityCredentialsProvides

Description

IdentityCredentialsProvides class None

Methods

IdentityCredentialsProvides. __init__( self , charm , relation_name )

IdentityCredentialsProvides. set_identity_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 , credentials: str , project_name: str , project_id: str , user_domain_name: str , user_domain_id: str , project_domain_name: str , project_domain_id: str , region: str , admin_role: str )