KubernetesStorage

class phalanx.storage.kubernetes.KubernetesStorage

Bases: object

Storage layer for direct Kubernetes operations.

Used primarily by the installer. This uses kubectl directly rather than one of the Python Kubernetes libraries since it seemed simpler at the time.

Methods Summary

create_namespace(namespace, *[, ignore_fail])	Create a Kubernetes namespace.
create_vault_secret(name, namespace, credentials)	Create a Kubernetes Secret resource for Vault credentials.
get_current_context()	Get the current context (the default Kubernetes cluster).
wait_for_rollout(name, namespace)	Wait for a Kubernetes rollout to complete.

Methods Documentation

create_namespace(namespace, *, ignore_fail=False)

Create a Kubernetes namespace.

Parameters:

• namespace (str) – Namespace to create.

• ignore_fail (bool, default: False) – If True, ignore failures, such as when the namespace already exists.

Raises:

CommandFailedError – Raised if the namespace creation fails, and ignore_fail was not set to True.

Return type:

None

create_vault_secret(name, namespace, credentials)

Create a Kubernetes Secret resource for Vault credentials.

Parameters:

• name (str) – Name of the secret.

• namespace (str) – Namespace of the secret.

• credentials (VaultCredentials) – Vault credentials to store in the secret.

Return type:

None

get_current_context()

Get the current context (the default Kubernetes cluster).

Returns:

Name of the current Kubernetes context.

Return type:

str

wait_for_rollout(name, namespace)

Wait for a Kubernetes rollout to complete.

Parameters:

• name (str) – Name of the rollout. This should be the type of object (usually either deployment or statefulset, followed by a slash and the name of the object.

• namespace (str) – Namespace in which the rollout is happening.

Return type:

None