Catalogue

  • By Canonical Observability
Channel Revision Published Runs on
latest/stable 43 28 Jun 2024
Ubuntu 20.04
latest/candidate 59 28 Jun 2024
Ubuntu 20.04
latest/beta 59 21 Jun 2024
Ubuntu 20.04
latest/edge 59 20 Jun 2024
Ubuntu 20.04
1.0/stable 33 16 Feb 2024
Ubuntu 20.04
1.0/candidate 33 12 Dec 2023
Ubuntu 20.04
1.0/beta 33 12 Dec 2023
Ubuntu 20.04
1.0/edge 33 12 Dec 2023
Ubuntu 20.04
juju deploy catalogue-k8s
Show information

Platform:

charms.catalogue_k8s.v1.catalogue

Charm for providing services catalogues to bundles or sets of charms.


class CatalogueItem

CatalogueItem represents an application entry sent to a catalogue.

Description

The icon is an iconify mdi string; see https://icon-sets.iconify.design/mdi.

Methods

CatalogueItem. __init__( self , name: str , url: str , icon: str , description: str )

class CatalogueConsumer

Description

CatalogueConsumer is used to send over a CatalogueItem. None

Methods

CatalogueConsumer. __init__( self , charm , relation_name: str , item )

CatalogueConsumer. update_item( self , item: CatalogueItem )

Description

Update the catalogue item. None

CatalogueConsumer. unit_address( self , relation )

The unit address of the consumer, on which it is reachable.

Description

Requires ingress to be connected for it to be routable.

class CatalogueItemsChangedEvent

Description

Event emitted when the catalogue entries change. None

Methods

CatalogueItemsChangedEvent. __init__( self , handle , items )

CatalogueItemsChangedEvent. snapshot( self )

Description

Save catalogue entries information. None

CatalogueItemsChangedEvent. restore( self , snapshot )

Description

Restore catalogue entries information. None

class CatalogueEvents

Description

Events raised by CatalogueConsumer. None

class CatalogueProvider

Description

CatalogueProvider is the side of the relation that serves the actual service catalogue. None

Methods

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

CatalogueProvider. items( self )

Description

A list of apps sent over relation data. None