maas-site-manager-k8s

MAAS Site Manager Operator for Kubernetes

Channel Revision Published Runs on
latest/edge 46 Today
Ubuntu 24.04 Ubuntu 22.04
latest/edge 30 06 Dec 2024
Ubuntu 24.04 Ubuntu 22.04
juju deploy maas-site-manager-k8s --channel edge
Show information

Platform:

charms.maas_site_manager_k8s.v1.enrol

MAAS Site Manager operator library.

Allows MAAS clusters to enrol with Site Manager


class SiteManagerEnrolInterfaceError

Description

Common ancestor for Enrol interface related exceptions. None

class EnrolDatabag

Description

Base class from Enrol databags. None

Methods

EnrolDatabag. load( cls , data )

Description

Load from dictionary. None

EnrolDatabag. dump( self , databag )

Description

Write the contents of this model to Juju databag. None

class EnrolRequirerAppData

Description

The schema for the Requirer side of this relation. None

class EnrolProviderAppData

Description

The schema for the Provider side of this relation. None

Methods

EnrolProviderAppData. get_token( self , model )

Retrieve enrolment token.

Returns

str

the token

class TokenIssuedEvent

Description

Event emitted when Site Manager has emitted a token for this relation. None

Methods

TokenIssuedEvent. __init__( self , handle , token: str )

TokenIssuedEvent. snapshot( self )

Serialize the event to disk.

Description

Not meant to be called by charm code.

TokenIssuedEvent. restore( self , snapshot )

Deserialize the event from disk.

Description

Not meant to be called by charm code.

class TokenWithdrawEvent

Event emitted when the relation with the "site-manager" provider has been severed.

Description

Or when the relation data has been wiped.

class EnrolRequirerEvents

Description

MAAS events. None

class EnrolRequirer

Description

Requires-side of the Enrolment relation. None

Methods

EnrolRequirer. __init__( self , charm , key , endpoint: str )

EnrolRequirer. get_enrol_data( self )

Description

Get enrolment data from databag. None

EnrolRequirer. is_published( self )

Description

Verify that the local side has done all they need to do. None

EnrolRequirer. request_enrol( self , cluster_uuid: str )

Description

Request enrolment. None

class EnrolProvider

Description

Provides-side of the Enrol relation. None

Methods

EnrolProvider. __init__( self , charm , key , endpoint: str )

EnrolProvider. publish_enrol_token( self , relation , token: str )

Publish enrolment data.

Arguments

relation (Relation)

the Relation

token (str)

Enrolment token