Process lots of feedback
- Add a lot of docstrings - Add AppStatus class - Remove unused code
This commit is contained in:
Maarten de Waard
parent
8e41705d39
commit
2e55e2fa39
5 changed files with 221 additions and 777 deletions
|
|
@ -12,17 +12,28 @@ from kubernetes.client import api_client
|
|||
from kubernetes.client.exceptions import ApiException
|
||||
from kubernetes.utils import create_from_yaml
|
||||
from kubernetes.utils.create_from_yaml import FailToCreateError
|
||||
from flask import current_app
|
||||
|
||||
# Load the kube config once
|
||||
#
|
||||
# By default this loads whatever we define in the `KUBECONFIG` env variable,
|
||||
# otherwise loads the config from default locations, similar to what kubectl
|
||||
# does.
|
||||
config.load_kube_config()
|
||||
|
||||
def create_variables_secret(app_slug, variables_filepath):
|
||||
"""Checks if a variables secret for app_name already exists, generates it if necessary.
|
||||
|
||||
If a secret already exists, loops through keys from the template, and adds
|
||||
values for keys that miss in the Kubernetes secret, but are available in
|
||||
the template.
|
||||
|
||||
:param app_slug: The slug of the app, used in the oauth secrets
|
||||
:type app_slug: string
|
||||
:param variables_filepath: The path to an existing jinja2 template
|
||||
:type variables_filepath: string
|
||||
:return: returns True, unless an exception gets raised by the Kubernetes API
|
||||
:rtype: boolean
|
||||
"""
|
||||
new_secret_dict = read_template_to_dict(
|
||||
variables_filepath,
|
||||
|
|
@ -37,7 +48,7 @@ def create_variables_secret(app_slug, variables_filepath):
|
|||
elif current_secret_data.keys() != new_secret_dict["data"].keys():
|
||||
# Update current secret with new keys
|
||||
update_secret = True
|
||||
print(
|
||||
current_app.logger.info(
|
||||
f"Secret {secret_name} in namespace {secret_namespace}"
|
||||
" already exists. Merging..."
|
||||
)
|
||||
|
|
@ -45,12 +56,12 @@ def create_variables_secret(app_slug, variables_filepath):
|
|||
new_secret_dict["data"] |= current_secret_data
|
||||
else:
|
||||
# Do Nothing
|
||||
print(
|
||||
current_app.logger.info(
|
||||
f"Secret {secret_name} in namespace {secret_namespace}"
|
||||
" is already in a good state, doing nothing."
|
||||
)
|
||||
return True
|
||||
print(
|
||||
current_app.logger.info(
|
||||
f"Storing secret {secret_name} in namespace"
|
||||
f" {secret_namespace} in cluster."
|
||||
)
|
||||
|
|
@ -61,7 +72,14 @@ def create_variables_secret(app_slug, variables_filepath):
|
|||
|
||||
|
||||
def get_secret_metadata(secret_dict):
|
||||
"""Returns secret name and namespace from metadata field in a yaml string."""
|
||||
"""
|
||||
Returns secret name and namespace from metadata field in a yaml string.
|
||||
|
||||
:param secret_dict: Dictionary of the secret as returned by read_namespaced_secret
|
||||
:type secret_dict: dict
|
||||
:return: Tuple containing secret name and secret namespace
|
||||
:rtype: tuple
|
||||
"""
|
||||
secret_name = secret_dict["metadata"]["name"]
|
||||
# default namespace is flux-system, but other namespace can be
|
||||
# provided in secret metadata
|
||||
|
|
@ -73,7 +91,17 @@ def get_secret_metadata(secret_dict):
|
|||
|
||||
|
||||
def get_kubernetes_secret_data(secret_name, namespace):
|
||||
"""Returns the contents of a kubernetes secret or None if the secret does not exist."""
|
||||
"""
|
||||
Get secret from Kubernetes
|
||||
|
||||
:param secret_name: Name of the secret
|
||||
:type secret_name: string
|
||||
:param namespace: Namespace of the secret
|
||||
:type namespace: string
|
||||
|
||||
:return: The contents of a kubernetes secret or None if the secret does not exist.
|
||||
:rtype: dict or None
|
||||
"""
|
||||
api_client_instance = api_client.ApiClient()
|
||||
api_instance = client.CoreV1Api(api_client_instance)
|
||||
try:
|
||||
|
|
@ -87,7 +115,20 @@ def get_kubernetes_secret_data(secret_name, namespace):
|
|||
|
||||
|
||||
def store_kubernetes_secret(secret_dict, namespace, update=False):
|
||||
"""Stores either a new secret in the cluster, or updates an existing one."""
|
||||
"""
|
||||
Stores either a new secret in the cluster, or updates an existing one.
|
||||
|
||||
:param secret_dict: Dictionary of the secret as returned by read_namespaced_secret
|
||||
:type secret_dict: dict
|
||||
:param namespace: Namespace of the secret
|
||||
:type namespace: string
|
||||
:param update: If True, use `patch_kubernetes_secret`,
|
||||
otherwise use `create_from_yaml` (default: False)
|
||||
:type update: boolean
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
api_client_instance = api_client.ApiClient()
|
||||
if update:
|
||||
verb = "updated"
|
||||
|
|
@ -101,13 +142,23 @@ def store_kubernetes_secret(secret_dict, namespace, update=False):
|
|||
namespace=namespace
|
||||
)
|
||||
except FailToCreateError as ex:
|
||||
print(f"Secret not {verb} because of exception {ex}")
|
||||
current_app.logger.info(f"Secret not created because of exception {ex}")
|
||||
return
|
||||
print(f"Secret {verb} with api response: {api_response}")
|
||||
current_app.logger.info(f"Secret {verb} with api response: {api_response}")
|
||||
|
||||
|
||||
def store_kustomization(kustomization_template_filepath, app_slug):
|
||||
"""Add a kustomization that installs app {app_slug} to the cluster"""
|
||||
"""
|
||||
Add a kustomization that installs app {app_slug} to the cluster.
|
||||
|
||||
:param kustomization_template_filepath: Path to the template that describes
|
||||
the kustomization. The template should have an `{{ app }}` entry.
|
||||
:type kustomization_template_filepath: string
|
||||
:param app_slug: Slug for the app, used to replace `{{ app }}` in the
|
||||
template
|
||||
:return: True on success
|
||||
:rtype: boolean
|
||||
"""
|
||||
kustomization_dict = read_template_to_dict(kustomization_template_filepath,
|
||||
{"app": app_slug})
|
||||
custom_objects_api = client.CustomObjectsApi()
|
||||
|
|
@ -119,14 +170,25 @@ def store_kustomization(kustomization_template_filepath, app_slug):
|
|||
plural="kustomizations",
|
||||
body=kustomization_dict)
|
||||
except FailToCreateError as ex:
|
||||
print(f"Could not create {app_slug} Kustomization because of exception {ex}")
|
||||
return
|
||||
print(f"Kustomization created with api response: {api_response}")
|
||||
current_app.logger.info(
|
||||
f"Could not create {app_slug} Kustomization because of exception {ex}")
|
||||
return False
|
||||
current_app.logger.debug(f"Kustomization created with api response: {api_response}")
|
||||
return True
|
||||
|
||||
def delete_kustomization(kustomization_name):
|
||||
"""Deletes kustomization for an app_slug. Should also result in the
|
||||
deletion of the app's HelmReleases, PVCs, OAuth2Client, etc. Nothing will
|
||||
remain"""
|
||||
"""
|
||||
Deletes a kustomization.
|
||||
|
||||
Note that this can also result in the deletion of an app's HelmReleases,
|
||||
PVCs (user data!), OAuth2Client, etc. Nothing will remain
|
||||
|
||||
:param kustomization_name: name of the kustomization to delete
|
||||
:type kustomization_name: string
|
||||
|
||||
:return: Response of delete API call
|
||||
:rtype: dict
|
||||
"""
|
||||
custom_objects_api = client.CustomObjectsApi()
|
||||
body = client.V1DeleteOptions()
|
||||
try:
|
||||
|
|
@ -138,14 +200,16 @@ def delete_kustomization(kustomization_name):
|
|||
name=kustomization_name,
|
||||
body=body)
|
||||
except ApiException as ex:
|
||||
print(f"Could not delete {kustomization_name} Kustomization because of exception {ex}")
|
||||
current_app.logger.info(
|
||||
f"Could not delete {kustomization_name} Kustomization because of exception {ex}")
|
||||
return False
|
||||
print(f"Kustomization deleted with api response: {api_response}")
|
||||
current_app.logger.debug(f"Kustomization deleted with api response: {api_response}")
|
||||
return api_response
|
||||
|
||||
|
||||
def read_template_to_dict(template_filepath, template_globals):
|
||||
"""Reads a Jinja2 template that contains yaml and turns it into a dict
|
||||
"""
|
||||
Reads a Jinja2 template that contains yaml and turns it into a dict.
|
||||
|
||||
:param template_filepath: The path to an existing Jinja2 template
|
||||
:type template_filepath: string
|
||||
|
|
@ -167,7 +231,17 @@ def read_template_to_dict(template_filepath, template_globals):
|
|||
|
||||
|
||||
def patch_kubernetes_secret(secret_dict, namespace):
|
||||
"""Patches secret in the cluster with new data."""
|
||||
"""
|
||||
Patches secret in the cluster with new data.
|
||||
|
||||
Warning: currently ignores everything that's not in secret_dict["data"]
|
||||
|
||||
:param secret_dict: Dictionary of the secret as returned by read_namespaced_secret
|
||||
:type secret_dict: dict
|
||||
:param namespace: Namespace of the secret
|
||||
:type namespace: string
|
||||
:return: Response of the patch API call
|
||||
"""
|
||||
api_client_instance = api_client.ApiClient()
|
||||
api_instance = client.CoreV1Api(api_client_instance)
|
||||
name = secret_dict["metadata"]["name"]
|
||||
|
|
@ -177,30 +251,32 @@ def patch_kubernetes_secret(secret_dict, namespace):
|
|||
|
||||
|
||||
def generate_password(length):
|
||||
"""Generates a password of "length" characters."""
|
||||
"""
|
||||
Generates a password with letters and digits.
|
||||
|
||||
:param length: The amount of characters in the password
|
||||
:type length: int
|
||||
:return: Generated password
|
||||
:rtype: string
|
||||
"""
|
||||
length = int(length)
|
||||
password = "".join((secrets.choice(string.ascii_letters)
|
||||
password = "".join((secrets.choice(string.ascii_letters + string.digits)
|
||||
for i in range(length)))
|
||||
return password
|
||||
|
||||
|
||||
def gen_htpasswd(user, password):
|
||||
"""Generate htpasswd entry for user with password."""
|
||||
return f"{user}:{crypt.crypt(password, crypt.mksalt(crypt.METHOD_SHA512))}"
|
||||
"""
|
||||
Generate htpasswd entry for user with password.
|
||||
|
||||
def get_all_kustomization_names(namespace='flux-system'):
|
||||
:param user: Username used in the htpasswd entry
|
||||
:type user: string
|
||||
:param password: Password for the user, will get encrypted.
|
||||
:type password: string
|
||||
:return: htpassword line entry
|
||||
:rtype: string
|
||||
"""
|
||||
Returns all flux kustomizations in a namespace.
|
||||
:param namespace: namespace that contains kustomizations. Default: `flux-system`
|
||||
:type namespace: str
|
||||
:return: List of names for kustomizations in namespace
|
||||
:rtype: list
|
||||
"""
|
||||
kustomizations = get_all_kustomizations(namespace)
|
||||
return_kustomizations = []
|
||||
for kustomization in kustomizations['items']:
|
||||
return_kustomizations.append(kustomization['metadata']['name'])
|
||||
return return_kustomizations
|
||||
return f"{user}:{crypt.crypt(password, crypt.mksalt(crypt.METHOD_SHA512))}"
|
||||
|
||||
|
||||
def get_all_kustomizations(namespace='flux-system'):
|
||||
|
|
@ -208,8 +284,8 @@ def get_all_kustomizations(namespace='flux-system'):
|
|||
Returns all flux kustomizations in a namespace.
|
||||
:param namespace: namespace that contains kustomizations. Default: `flux-system`
|
||||
:type namespace: str
|
||||
:return: Kustomizations as returned by CustomObjectsApi.list_namespaced_custom_object()
|
||||
:rtype: object
|
||||
:return: 'items' in dict returned by CustomObjectsApi.list_namespaced_custom_object()
|
||||
:rtype: dict[]
|
||||
"""
|
||||
api = client.CustomObjectsApi()
|
||||
api_response = api.list_namespaced_custom_object(
|
||||
|
|
@ -221,81 +297,17 @@ def get_all_kustomizations(namespace='flux-system'):
|
|||
return api_response
|
||||
|
||||
|
||||
def get_all_helmrelease_names(namespace='stackspin'):
|
||||
def get_all_helmreleases(namespace='stackspin', label_selector=""):
|
||||
"""
|
||||
Returns names of all helmreleases in a namespace.
|
||||
:param namespace: namespace that contains kustomizations. Default: `stackspin`
|
||||
Lists all helmreleases in a certain namespace (stackspin by default)
|
||||
|
||||
:param namespace: namespace that contains helmreleases. Default: `stackspin-apps`
|
||||
:type namespace: str
|
||||
:return: List of names for helmreleases in namespace
|
||||
:rtype: list
|
||||
"""
|
||||
helmreleases = get_all_helmreleases(namespace)
|
||||
return_helmreleases = []
|
||||
for helmrelease in helmreleases['items']:
|
||||
return_helmreleases.append(helmrelease['metadata']['name'])
|
||||
return return_helmreleases
|
||||
:param label_selector: a label selector to limit the list (optional)
|
||||
:type label_selector: str
|
||||
|
||||
def get_all_helmreleases(namespace='stackspin'):
|
||||
"""
|
||||
Returns all helmreleases in a namespace.
|
||||
:param namespace: namespace that contains kustomizations. Default: `stackspin`
|
||||
:type namespace: str
|
||||
:return: Helmreleases as returned by CustomObjectsApi.list_namespaced_custom_object()
|
||||
:rtype: object
|
||||
"""
|
||||
api = client.CustomObjectsApi()
|
||||
api_response = api.list_namespaced_custom_object(
|
||||
group="helm.toolkit.fluxcd.io",
|
||||
version="v2beta1",
|
||||
plural="helmreleases",
|
||||
namespace=namespace,
|
||||
)
|
||||
return api_response
|
||||
|
||||
|
||||
def get_kustomization(name, namespace='flux-system'):
|
||||
"""Returns all info of a Flux kustomization with name 'name'"""
|
||||
api = client.CustomObjectsApi()
|
||||
try:
|
||||
resource = api.get_namespaced_custom_object(
|
||||
group="kustomize.toolkit.fluxcd.io",
|
||||
version="v1beta1",
|
||||
name=name,
|
||||
namespace=namespace,
|
||||
plural="kustomizations",
|
||||
)
|
||||
except client.exceptions.ApiException as error:
|
||||
if error.status == 404:
|
||||
return None
|
||||
# Raise all non-404 errors
|
||||
raise error
|
||||
return resource
|
||||
|
||||
|
||||
def get_helmrelease(name, namespace='stackspin-apps'):
|
||||
"""Returns all info of a Flux helmrelease with name 'name'"""
|
||||
api = client.CustomObjectsApi()
|
||||
try:
|
||||
resource = api.get_namespaced_custom_object(
|
||||
group="helm.toolkit.fluxcd.io",
|
||||
version="v2beta1",
|
||||
name=name,
|
||||
namespace=namespace,
|
||||
plural="helmreleases",
|
||||
)
|
||||
except client.exceptions.ApiException as error:
|
||||
if error.status == 404:
|
||||
return None
|
||||
# Raise all non-404 errors
|
||||
raise error
|
||||
|
||||
return resource
|
||||
|
||||
def list_helmreleases(namespace='stackspin-apps', label_selector=""):
|
||||
"""
|
||||
Lists all helmreleases in a certain namespace (stackspin-apps by default)
|
||||
|
||||
Optionally takes a label selector to limit the list.
|
||||
:return: List of helmreleases
|
||||
:rtype: dict[]
|
||||
"""
|
||||
api_instance = client.CustomObjectsApi()
|
||||
|
||||
|
|
@ -311,17 +323,32 @@ def list_helmreleases(namespace='stackspin-apps', label_selector=""):
|
|||
return None
|
||||
# Raise all non-404 errors
|
||||
raise error
|
||||
return api_response
|
||||
return api_response['items']
|
||||
|
||||
|
||||
def get_readiness(app_status):
|
||||
def get_kustomization(name, namespace='flux-system'):
|
||||
"""
|
||||
Parses an app status's 'conditions' to find a type field called 'Ready' and
|
||||
returns its status. Works for Kustomizations as well as Helmreleases.
|
||||
Returns all info of a Flux kustomization with name 'name'
|
||||
|
||||
:param name: Name of the kustomizatoin
|
||||
:type name: string
|
||||
:param namespace: Namespace of the kustomization
|
||||
:type namespace: string
|
||||
:return: kustomization as returned by the API
|
||||
:rtype: dict
|
||||
"""
|
||||
for condition in app_status['conditions']:
|
||||
if condition['type'] == 'Ready':
|
||||
return condition['status']
|
||||
# If this point is reached, no condition "Ready" exists, so the application
|
||||
# is not ready.
|
||||
return False
|
||||
api = client.CustomObjectsApi()
|
||||
try:
|
||||
resource = api.get_namespaced_custom_object(
|
||||
group="kustomize.toolkit.fluxcd.io",
|
||||
version="v1beta1",
|
||||
name=name,
|
||||
namespace=namespace,
|
||||
plural="kustomizations",
|
||||
)
|
||||
except client.exceptions.ApiException as error:
|
||||
if error.status == 404:
|
||||
return None
|
||||
# Raise all non-404 errors
|
||||
raise error
|
||||
return resource
|
||||
|
|
|
|||
Reference in a new issue