foliolib.okapi.kubeClient.KubeClient

class foliolib.okapi.kubeClient.KubeClient(kube_config: Optional[str] = None)

Bases: object

Client for kubernetes to manage Folio modules

Parameters: kube_config (str)) – Path to kube config. Defaults to None.

Methods

`create_configMap`(name, data)
`create_deployment`(data)
`create_persistenVolumeClaim`(data)
`create_secret`(name, data)
`create_service`(data)	Create a service.
`create_stateful_set`(data)
`delete_env`(name)	Delete an enviroment variable.
`deploy`(modId)	Deploy a Folio module
`exists_secret`(name)
`get_api_versions`()
`get_configMaps`()
`get_deployment`(name)
`get_deployments`()
`get_env`()	Get enviroment variables.
`get_secret`(name)
`get_service`(name)	Get a service.
`get_services`()	Get services.
`get_stateful_sets`()
`is_configMap`(name)
`is_deployment`(name)
`is_service`(name)
`is_stateful_set`(name)
`patch`(modId)
`patch_deployment`(name, data)
`patch_stateful_set`(name, data)
`remove_configMap`(name)
`remove_deployment`(name)
`remove_persistenVolumeClaim`(name)
`remove_secret`(name)
`remove_service`(name)	Remove a service.
`remove_stateful_set`(name)
`set_env`(name, value)	Set an enviroment variable.
`undeploy`(modId)	Undeploy a Folio module

create_configMap(name: str, data: dict)

create_deployment(data: dict)

create_persistenVolumeClaim(data: dict)

create_secret(name: str, data: dict)

create_service(data: dict)

Create a service.

Parameters

data (dict) – Dict of the service.
namespace (str, optional) – Namespace. Defaults to “default”.

Returns

Created service.

Return type

dict

create_stateful_set(data: dict)

delete_env(name: str)

Delete an enviroment variable.

Parameters: name (str) – Name of the variable.

deploy(modId: str)

Deploy a Folio module

Parameters: modId (str) – Module id, e.g. mod-users-1.8.0

exists_secret(name: str)

get_api_versions()

get_configMaps()

get_deployment(name: str)

get_deployments()

get_env()

Get enviroment variables.

Returns: List with enviroment variables.
Return type: list

get_secret(name: str)

get_service(name: str)

Get a service.

Parameters

name (str) – Name of the service
namespace (str, optional) – Namespace of the service. Defaults to “default”.

Returns

Dictonary of the service.

Return type

dict

get_services()

Get services.

Returns: List of services.
Return type: list

get_stateful_sets()

is_configMap(name: str)

is_deployment(name: str)

is_service(name: str)

is_stateful_set(name: str)

patch(modId: str)

patch_deployment(name, data: dict)

patch_stateful_set(name: str, data: dict)

remove_configMap(name: str)

remove_deployment(name: str)

remove_persistenVolumeClaim(name: str)

remove_secret(name: str)

remove_service(name: str)

Remove a service.

Parameters

name (str) – Name of the service.
namespace (str, optional) – Namespace. Defaults to “default”.

Returns

_description_

Return type

_type_

remove_stateful_set(name: str)

set_env(name: str, value: str)

Set an enviroment variable.

Parameters

name (str) – Name of the variable.
value (str) – Value of the variable.

undeploy(modId: str)

Undeploy a Folio module

Parameters: modId (str) – Module id, e.g. mod-users-1.8.0