foliolib.okapi.okapiModuleKubernetes.OkapiModuleKubernetes

class foliolib.okapi.okapiModuleKubernetes.OkapiModuleKubernetes(module: Union[dict, str])

Bases: object

Defines an okapi module for Kubernetes.

Parameters

module (Union[dict, str]) – Module id or instance of OkapiModule.

Methods

get_deployment()	Get Kubernetes deployment or statefulset definition for the module.
get_hazelcast_configMap()	Get Kubernetes ConfigMap definition for Hazelcast.
get_kind()	Get resource kind.
get_namespace()	Get namespace of the module
get_persistentVolumeClaim()	Get Kubernetes PersistentVolumeClaim definition.
get_rfc_name()	Get module id as rfc name.
get_service()	Get Kubernetes service definition for the module.
has_hazelcast()	Wether module has hazelcast enabled.
has_volume()	Wether module has a volume defined.

get_deployment()

Get Kubernetes deployment or statefulset definition for the module.

Returns

Kubernetes deployment or statefulset definition.

Return type

dict

get_hazelcast_configMap()

Get Kubernetes ConfigMap definition for Hazelcast.

Returns

Kubernetes ConfigMap definition for Hazelcast.

Return type

dict

get_kind()

Get resource kind.

Returns

Deployment or StatefulSet

Return type

str

get_namespace()

Get namespace of the module

Returns

Namespace

Return type

str

get_persistentVolumeClaim()

Get Kubernetes PersistentVolumeClaim definition.

Returns

Kubernetes PersistentVolumeClaim definition.

Return type

dict

get_rfc_name()

Get module id as rfc name.

Returns

rfc name.

Return type

str

get_service()

Get Kubernetes service definition for the module.

Returns

Kubernetes service definition.

Return type

dict

has_hazelcast()

Wether module has hazelcast enabled.

Returns

Wether module has hazelcast enabled.

Return type

bool

has_volume()

Wether module has a volume defined.

Returns

Wether module has a volume defined.

Return type

bool