Heat K8S

  • OpenStack Charmers
Channel Revision Published Runs on
latest/edge 4 26 Jul 2023
Ubuntu 22.04
2024.1/beta 79 11 Dec 2024
Ubuntu 24.04 Ubuntu 22.04
2024.1/beta 74 22 Nov 2024
Ubuntu 24.04 Ubuntu 22.04
2024.1/edge 79 09 Dec 2024
Ubuntu 24.04 Ubuntu 22.04
2024.1/edge 74 08 Oct 2024
Ubuntu 24.04 Ubuntu 22.04
2023.2/stable 31 06 Dec 2023
Ubuntu 22.04
2023.2/candidate 44 25 Mar 2024
Ubuntu 22.04
2023.2/beta 44 25 Mar 2024
Ubuntu 22.04
2023.2/edge 44 23 Feb 2024
Ubuntu 22.04
2023.1/stable 15 26 Sep 2023
Ubuntu 22.04
2023.1/candidate 34 12 Jan 2024
Ubuntu 22.04
2023.1/beta 34 10 Jan 2024
Ubuntu 22.04
2023.1/edge 34 12 Dec 2023
Ubuntu 22.04
juju deploy heat-k8s --channel edge
Show information

Platform:

charms.heat_k8s.v0.heat_shared_config

HeatSharedConfig Provides and Requires module.

This library contains the Requires and Provides classes for handling the heat-shared-config interface.

Import HeatSharedConfigRequires in your charm, with the charm object and the relation name: - self - "heat_config"

Two events are also available to respond to: - config_changed - goneaway

A basic example showing the usage of this relation follows:

from charms.heat_k8s.v0.heat_shared_config import (
    HeatSharedConfigRequires
)

class HeatSharedConfigClientCharm(CharmBase):
    def __init__(self, *args):
        super().__init__(*args)
        #  HeatSharedConfig Requires
        self.heat_config = HeatSharedConfigRequires(
            self, "heat_config",
        )
        self.framework.observe(
            self.heat_config.on.config_changed,
            self._on_heat_shared_config_changed
        )
        self.framework.observe(
            self.heat_config.on.goneaway,
            self._on_heat_shared_config_goneaway
        )

    def _on_heat_shared_config_changed(self, event):
        '''React to the Heat shared config changed event.

        This event happens when Heat shared config relation is added to the
        model and relation data is changed.
        '''
        # Do something with the configuration provided by relation.
        pass

    def _on_heat_shared_config_goneaway(self, event):
        '''React to the HeatSharedConfig goneaway event.

        This event happens when Heat shared config relation is removed.
        '''
        # HeatSharedConfig Relation has goneaway.
        pass

class HeatSharedConfigRequestEvent

Description

HeatConfigRequest Event. None

class HeatSharedConfigProviderEvents

Description

Events class for on. None

class HeatSharedConfigProvides

Description

HeatSharedConfigProvides class. None

Methods

HeatSharedConfigProvides. __init__( self , charm: CharmBase , relation_name: str )

HeatSharedConfigProvides. set_config( self , relation: Relation , auth_encryption_key: str )

Description

Set heat configuration on the relation. None

class HeatSharedConfigChangedEvent

Description

HeatSharedConfigChanged Event. None

class HeatSharedConfigGoneAwayEvent

Description

HeatSharedConfigGoneAway Event. None

class HeatSharedConfigRequirerEvents

Description

Events class for on. None

class HeatSharedConfigRequires

Description

HeatSharedConfigRequires class. None

Methods

HeatSharedConfigRequires. __init__( self , charm: CharmBase , relation_name: str )

HeatSharedConfigRequires. get_remote_app_data( self , key: str )

Description

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

HeatSharedConfigRequires. auth_encryption_key( self )

Description

Return the auth_encryption_key. None