Update horizon plugin
Update the horizon plugin library that is used to be the one from the openstack-libs pseudo charm. Signed-off-by: Billy Olsen <billy.olsen@gmail.com>
This commit is contained in:
parent
d8019ba12d
commit
3ea81617e5
@ -12,7 +12,7 @@
|
|||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
"""# Horizon Plugin library.
|
"""# Horizon Dashboard Plugin library.
|
||||||
|
|
||||||
This library facilitates interactions with the 'classic' OpenStack Dashboard
|
This library facilitates interactions with the 'classic' OpenStack Dashboard
|
||||||
Machine Charm. This library is used to provide configuration and dependent
|
Machine Charm. This library is used to provide configuration and dependent
|
||||||
@ -37,7 +37,8 @@ class from this library. The simplest scenario is to just instantiate the
|
|||||||
`HorizonPlugin` object and provide the set of debian packages which should be
|
`HorizonPlugin` object and provide the set of debian packages which should be
|
||||||
installed, as below:
|
installed, as below:
|
||||||
|
|
||||||
from charms.openstack.v0.horizon_plugin import HorizonPlugin
|
from charms.openstack_libs.v0.dashboard_plugin_requires \
|
||||||
|
import HorizonPlugin
|
||||||
|
|
||||||
class AwesomeHorizonPluginFoo(CharmBase):
|
class AwesomeHorizonPluginFoo(CharmBase):
|
||||||
def __init__(self, *args):
|
def __init__(self, *args):
|
||||||
@ -57,7 +58,7 @@ installed to. The plugin charm can access these values as attributes on the
|
|||||||
`HorizonPlugin` object.
|
`HorizonPlugin` object.
|
||||||
|
|
||||||
...
|
...
|
||||||
logger.debug(f'Current release is {self.plugin.release}
|
logger.debug(f'Current release is {self.plugin.release}')
|
||||||
...
|
...
|
||||||
|
|
||||||
Note, these values are only returned when the relation between plugin charm
|
Note, these values are only returned when the relation between plugin charm
|
||||||
@ -66,20 +67,14 @@ principal charm.
|
|||||||
"""
|
"""
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from typing import List, Optional
|
from typing import List, Optional
|
||||||
|
|
||||||
import ops.charm
|
import ops.charm
|
||||||
from ops.framework import (
|
from ops.framework import EventBase, EventSource, Object, ObjectEvents
|
||||||
EventBase,
|
|
||||||
EventSource,
|
|
||||||
Object,
|
|
||||||
ObjectEvents,
|
|
||||||
)
|
|
||||||
from ops.model import Relation
|
from ops.model import Relation
|
||||||
|
|
||||||
# The unique Charmhub library identifier, never change it
|
# The unique Charmhub library identifier, never change it
|
||||||
LIBID = "TBD"
|
LIBID = "9317847810c341a1ad80895b5d206b85"
|
||||||
|
|
||||||
# Increment this major API version when introducing breaking changes
|
# Increment this major API version when introducing breaking changes
|
||||||
LIBAPI = 0
|
LIBAPI = 0
|
||||||
@ -93,6 +88,7 @@ logger = logging.getLogger(__name__)
|
|||||||
|
|
||||||
class HorizonConnectedEvent(EventBase):
|
class HorizonConnectedEvent(EventBase):
|
||||||
"""Raised when the OpenStack Horizon Dashboard is connected."""
|
"""Raised when the OpenStack Horizon Dashboard is connected."""
|
||||||
|
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
@ -102,6 +98,7 @@ class HorizonAvailableEvent(EventBase):
|
|||||||
|
|
||||||
class HorizonGoneAwayEvent(EventBase):
|
class HorizonGoneAwayEvent(EventBase):
|
||||||
"""Raised when the OpenStack Horizon Dashboard is no longer available."""
|
"""Raised when the OpenStack Horizon Dashboard is no longer available."""
|
||||||
|
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
@ -124,12 +121,15 @@ class HorizonPlugin(Object):
|
|||||||
|
|
||||||
on = HorizonEvents()
|
on = HorizonEvents()
|
||||||
|
|
||||||
def __init__(self, charm: ops.charm.CharmBase,
|
def __init__(
|
||||||
relation_name: str = 'dashboard',
|
self,
|
||||||
|
charm: ops.charm.CharmBase,
|
||||||
|
relation_name: str = "dashboard",
|
||||||
install_packages: List[str] = None,
|
install_packages: List[str] = None,
|
||||||
conflicting_packages: Optional[List[str]] = None,
|
conflicting_packages: Optional[List[str]] = None,
|
||||||
local_settings: str = "",
|
local_settings: str = "",
|
||||||
priority: str = None,):
|
priority: str = None,
|
||||||
|
):
|
||||||
super().__init__(charm, relation_name)
|
super().__init__(charm, relation_name)
|
||||||
self.charm = charm
|
self.charm = charm
|
||||||
self.relation_name = relation_name
|
self.relation_name = relation_name
|
||||||
@ -161,7 +161,7 @@ class HorizonPlugin(Object):
|
|||||||
:type event: EventBase
|
:type event: EventBase
|
||||||
:return: None
|
:return: None
|
||||||
"""
|
"""
|
||||||
logging.debug(f'{self.relation_name} relation has joined')
|
logging.debug(f"{self.relation_name} relation has joined")
|
||||||
self.publish_plugin_info(
|
self.publish_plugin_info(
|
||||||
self.local_settings,
|
self.local_settings,
|
||||||
self.priority,
|
self.priority,
|
||||||
@ -177,7 +177,7 @@ class HorizonPlugin(Object):
|
|||||||
When the dashboard relation changes, it may be indicating that there's
|
When the dashboard relation changes, it may be indicating that there's
|
||||||
a new OpenStack release or that some other element has changed.
|
a new OpenStack release or that some other element has changed.
|
||||||
"""
|
"""
|
||||||
logging.debug(f'{self.relation_name} relation has changed')
|
logging.debug(f"{self.relation_name} relation has changed")
|
||||||
self.on.available.emit()
|
self.on.available.emit()
|
||||||
|
|
||||||
def _on_dashboard_relation_broken(self, event: EventBase):
|
def _on_dashboard_relation_broken(self, event: EventBase):
|
||||||
@ -190,7 +190,7 @@ class HorizonPlugin(Object):
|
|||||||
:type event: EventBase
|
:type event: EventBase
|
||||||
return: None
|
return: None
|
||||||
"""
|
"""
|
||||||
logging.debug(f'{self.relation_name} relation has departed')
|
logging.debug(f"{self.relation_name} relation has departed")
|
||||||
self.on.goneaway.emit()
|
self.on.goneaway.emit()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@ -235,13 +235,13 @@ class HorizonPlugin(Object):
|
|||||||
return
|
return
|
||||||
|
|
||||||
data = rel.data[self.charm.unit]
|
data = rel.data[self.charm.unit]
|
||||||
data['local-settings'] = local_settings
|
data["local-settings"] = local_settings
|
||||||
if priority:
|
if priority:
|
||||||
data['priority'] = priority
|
data["priority"] = priority
|
||||||
if install_packages:
|
if install_packages:
|
||||||
data['install-packages'] = json.dumps(install_packages)
|
data["install-packages"] = json.dumps(install_packages)
|
||||||
if conflicting_packages:
|
if conflicting_packages:
|
||||||
data['conflicting-packages'] = json.dumps(conflicting_packages)
|
data["conflicting-packages"] = json.dumps(conflicting_packages)
|
||||||
|
|
||||||
rel.data[self.charm.unit].update(data)
|
rel.data[self.charm.unit].update(data)
|
||||||
|
|
||||||
@ -269,23 +269,25 @@ class HorizonPlugin(Object):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def openstack_dir(self) -> Optional[str]:
|
def openstack_dir(self) -> Optional[str]:
|
||||||
"""Retrieves the openstack_dir property from the principal charm
|
"""Retrieves the openstack_dir property from the principal charm.
|
||||||
|
|
||||||
:return: openstack_dir property from principal charm
|
:return: openstack_dir property from principal charm
|
||||||
:rtype: Optional[str]
|
:rtype: Optional[str]
|
||||||
"""
|
"""
|
||||||
return self._get_remote_data('openstack_dir')
|
return self._get_remote_data("openstack_dir")
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def bin_path(self) -> Optional[str]:
|
def bin_path(self) -> Optional[str]:
|
||||||
"""Retrives the bin_path property from the principal charm
|
"""Retrieves the bin_path property from the principal charm.
|
||||||
|
|
||||||
:return: bin_path property from the principal charm"""
|
:return: bin_path property from the principal charm
|
||||||
return self._get_remote_data('bin_path')
|
"""
|
||||||
|
return self._get_remote_data("bin_path")
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def release(self) -> Optional[str]:
|
def release(self) -> Optional[str]:
|
||||||
"""Retrives the release property from the principal charm
|
"""Retrieves the release property from the principal charm.
|
||||||
|
|
||||||
:return: release property from the principal charm"""
|
:return: release property from the principal charm
|
||||||
return self._get_remote_data('release')
|
"""
|
||||||
|
return self._get_remote_data("release")
|
@ -23,7 +23,7 @@ from ops.charm import CharmBase
|
|||||||
from ops.main import main
|
from ops.main import main
|
||||||
from ops.model import ActiveStatus
|
from ops.model import ActiveStatus
|
||||||
|
|
||||||
from charms.openstack.v0.horizon_plugin import (
|
from charms.openstack_libs.v0.dashboard_plugin_requires import (
|
||||||
HorizonPlugin,
|
HorizonPlugin,
|
||||||
HorizonAvailableEvent,
|
HorizonAvailableEvent,
|
||||||
)
|
)
|
||||||
|
Loading…
Reference in New Issue
Block a user