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.v0.enroll

MAAS Site Manager operator library.

Allows MAAS clusters to enroll with Site Manager


class SiteManagerEnrollInterfaceError

Description

Common ancestor for Enroll interface related exceptions. None

class EnrollDatabag

Description

Base class from Enroll databags. None

Methods

EnrollDatabag. load( cls , data )

Description

Load from dictionary. None

EnrollDatabag. dump( self , databag )

Description

Write the contents of this model to Juju databag. None

class EnrollRequirerAppData

Description

The schema for the Requirer side of this relation. None

class EnrollProviderAppData

Description

The schema for the Provider side of this relation. None

Methods

EnrollProviderAppData. get_token( self , model )

Retrieve enrollment 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 EnrollRequirerEvents

Description

MAAS events. None

class EnrollRequirer

Description

Requires-side of the Enrollment relation. None

Methods

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

EnrollRequirer. get_enroll_data( self )

Description

Get enrollment data from databag. None

EnrollRequirer. is_published( self )

Description

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

EnrollRequirer. request_enroll( self , cluster_uuid: str )

Description

Request enrollment. None

class EnrollProvider

Description

Provides-side of the Enroll relation. None

Methods

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

EnrollProvider. publish_enroll_token( self , relation , token: str )

Publish enrollment data.

Arguments

relation (Relation)

the Relation

token (str)

Enrollment token