openshift-python-wrapper 4.11.61__py3-none-any.whl

ocp_resources/gateway.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+from ocp_resources.resource import NamespacedResource
+
+
+class Gateway(NamespacedResource):
+    """
+    Gateway object.
+    """
+
+    api_group = NamespacedResource.ApiGroup.NETWORKING_ISTIO_IO

ocp_resources/hook.py

@@ -0,0 +1,52 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.mtv import MTV
+from ocp_resources.resource import NamespacedResource
+
+
+class Hook(NamespacedResource, MTV):
+    """
+    Migration Tool for Virtualization (MTV) Plan's Hook Resource.
+    """
+
+    api_group = NamespacedResource.ApiGroup.FORKLIFT_KONVEYOR_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        image="quay.io/konveyor/hook-runner:latest",
+        playbook=None,
+        client=None,
+        teardown=True,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        """
+        Args:
+            image (str): Path to an ansible image
+            playbook (str): Ansible playbook to be performed
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.image = image
+        self.playbook = playbook
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            self.res.update(
+                {
+                    "spec": {
+                        "image": self.image,
+                        "playbook": self.playbook,
+                    },
+                }
+            )

ocp_resources/host.py

@@ -0,0 +1,64 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.mtv import MTV
+from ocp_resources.resource import NamespacedResource
+
+
+class Host(NamespacedResource, MTV):
+    """
+    Migration Toolkit For Virtualization (MTV) Host resource.
+    """
+
+    api_group = NamespacedResource.ApiGroup.FORKLIFT_KONVEYOR_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        host_id=None,
+        ip_address=None,
+        provider_name=None,
+        provider_namespace=None,
+        secret_name=None,
+        secret_namespace=None,
+        client=None,
+        teardown=True,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.host_id = host_id
+        self.ip_address = ip_address
+        self.provider_name = provider_name
+        self.provider_namespace = provider_namespace
+        self.secret_name = secret_name or f"{self.name}-secret"
+        self.secret_namespace = secret_namespace or self.namespace
+        self.condition_message_ready = self.ConditionMessage.HOST_READY
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            self.res.update(
+                {
+                    "spec": {
+                        "id": self.host_id,
+                        "ipAddress": self.ip_address,
+                        "secret": {
+                            "name": self.secret_name,
+                            "namespace": self.secret_namespace,
+                        },
+                        "provider": {
+                            "name": self.provider_name,
+                            "namespace": self.provider_namespace,
+                        },
+                    }
+                }
+            )

ocp_resources/hostpath_provisioner.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import Resource
+
+
+class HostPathProvisioner(Resource):
+    """
+    HostPathProvisioner Custom Resource Object.
+    """
+
+    api_group = Resource.ApiGroup.HOSTPATHPROVISIONER_KUBEVIRT_IO
+
+    class Name:
+        HOSTPATH_PROVISIONER = "hostpath-provisioner"
+
+    def __init__(
+        self,
+        name=None,
+        path=None,
+        image_pull_policy=None,
+        client=None,
+        teardown=True,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            client=client,
+            teardown=teardown,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.path = path
+        self.image_pull_policy = image_pull_policy
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            spec = self.res.setdefault("spec", {})
+            path_config = spec.setdefault("pathConfig", {})
+            if self.path:
+                path_config["path"] = self.path
+            if self.image_pull_policy:
+                spec["imagePullPolicy"] = self.image_pull_policy
+
+    @property
+    def volume_path(self):
+        return self.instance.spec.pathConfig.path

ocp_resources/hyperconverged.py

@@ -0,0 +1,43 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class HyperConverged(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.HCO_KUBEVIRT_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        infra=None,
+        workloads=None,
+        teardown=True,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.infra = infra
+        self.workloads = workloads
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            if self.infra:
+                self.res.setdefault("spec", {}).setdefault("infra", {}).update(
+                    self.infra
+                )
+
+            if self.workloads:
+                self.res.setdefault("spec", {}).setdefault("workloads", {}).update(
+                    self.workloads
+                )

ocp_resources/image.py

@@ -0,0 +1,9 @@
+from ocp_resources.resource import Resource
+
+
+class Image(Resource):
+    """
+    Image object.
+    """
+
+    api_group = Resource.ApiGroup.IMAGE_OPENSHIFT_IO

ocp_resources/image_content_source_policy.py

@@ -0,0 +1,9 @@
+from ocp_resources.resource import Resource
+
+
+class ImageContentSourcePolicy(Resource):
+    """
+    ICSP object, inherited from Resource.
+    """
+
+    api_group = Resource.ApiGroup.OPERATOR_OPENSHIFT_IO

ocp_resources/image_stream.py

@@ -0,0 +1,48 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class ImageStream(NamespacedResource):
+    """
+    ImageStream object.
+    """
+
+    api_group = NamespacedResource.ApiGroup.IMAGE_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        lookup_policy=False,
+        tags=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.tags = tags
+        self.lookup_policy = lookup_policy
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            self.res.update(
+                {
+                    "spec": {
+                        "lookupPolicy": {"local": self.lookup_policy},
+                        "tags": self.tags,
+                    }
+                }
+            )

ocp_resources/imagestreamtag.py

@@ -0,0 +1,9 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class ImageStreamTag(NamespacedResource):
+    """
+    ImageStreamTag object.
+    """
+
+    api_group = NamespacedResource.ApiGroup.IMAGE_OPENSHIFT_IO

ocp_resources/infrastructure.py

@@ -0,0 +1,18 @@
+from ocp_resources.resource import Resource
+
+
+class Infrastructure(Resource):
+    """
+    Infrastructure object.
+    """
+
+    api_group = Resource.ApiGroup.CONFIG_OPENSHIFT_IO
+
+    class Type:
+        BARE_METAL = "BareMetal"
+        AWS = "AWS"
+        OPENSTACK = "OpenStack"
+
+    @property
+    def platform(self):
+        return self.instance.status.platformStatus.type

ocp_resources/installplan.py

@@ -0,0 +1,8 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class InstallPlan(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.OPERATORS_COREOS_COM
+
+    class Status(NamespacedResource.Status):
+        COMPLETE = "Complete"

ocp_resources/job.py

@@ -0,0 +1,65 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class Job(NamespacedResource):
+    """
+    Job object.
+    """
+
+    api_group = NamespacedResource.ApiGroup.BATCH
+
+    class Condition(NamespacedResource.Condition):
+        COMPLETE = "Complete"
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        client=None,
+        teardown=True,
+        privileged_client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        backoff_limit=None,
+        restart_policy=None,
+        service_account=None,
+        containers=None,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            privileged_client=privileged_client,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.restart_policy = restart_policy
+        self.backoff_limit = backoff_limit
+        self.service_account = service_account
+        self.containers = containers
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            self.res.setdefault("spec", {})
+
+            if self.backoff_limit is not None:
+                self.res["spec"]["backoffLimit"] = self.backoff_limit
+
+            if self.containers:
+                self.res["spec"].setdefault("template", {}).setdefault("spec", {})
+                self.res["spec"]["template"]["spec"]["containers"] = self.containers
+
+                if self.service_account:
+                    self.res["spec"]["template"]["spec"][
+                        "serviceAccount"
+                    ] = self.service_account
+
+                if self.restart_policy:
+                    self.res["spec"]["template"]["spec"][
+                        "restartPolicy"
+                    ] = self.restart_policy

ocp_resources/kube_descheduler.py

@@ -0,0 +1,65 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class KubeDescheduler(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.OPERATOR_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        profiles=None,
+        descheduling_interval=3600,
+        log_level="Normal",
+        management_state="Managed",
+        mode="Predictive",
+        operator_log_level="Normal",
+        teardown=True,
+        client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        """
+        Create Descheduler object.
+
+        Args:
+            profiles (list): list of descheduling profiles. Supported:
+                - AffinityAndTaints
+                - TopologyAndDuplicates
+                - LifecycleAndUtilization
+            log_level (str): logging of a component. Supported: "Normal", "Debug", "Trace", "TraceAll"
+            operator_log_level (str): logging of an operator. Supported: "Normal", "Debug", "Trace", "TraceAll"
+        """
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+        self.profiles = profiles or ["AffinityAndTaints"]
+        self.descheduling_interval = descheduling_interval
+        self.log_level = log_level
+        self.management_state = management_state
+        self.mode = mode
+        self.operator_log_level = operator_log_level
+
+    def to_dict(self):
+        super().to_dict()
+        if not self.yaml_file:
+            self.res.update(
+                {
+                    "spec": {
+                        "deschedulingIntervalSeconds": self.descheduling_interval,
+                        "logLevel": self.log_level,
+                        "managementState": self.management_state,
+                        "mode": self.mode,
+                        "operatorLogLevel": self.operator_log_level,
+                        "profiles": self.profiles,
+                    }
+                }
+            )

ocp_resources/kubevirt.py

@@ -0,0 +1,5 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class KubeVirt(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.KUBEVIRT_IO

ocp_resources/kubevirt_common_templates_bundle.py

@@ -0,0 +1,5 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class KubevirtCommonTemplatesBundle(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.SSP_KUBEVIRT_IO

ocp_resources/kubevirt_metrics_aggregation.py

@@ -0,0 +1,5 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class KubevirtMetricsAggregation(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.SSP_KUBEVIRT_IO

ocp_resources/kubevirt_node_labeller_bundle.py

@@ -0,0 +1,5 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class KubevirtNodeLabellerBundle(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.SSP_KUBEVIRT_IO

ocp_resources/kubevirt_template_validaotr.py

@@ -0,0 +1,5 @@
+from ocp_resources.resource import NamespacedResource
+
+
+class KubevirtTemplateValidator(NamespacedResource):
+    api_group = NamespacedResource.ApiGroup.SSP_KUBEVIRT_IO

ocp_resources/logger.py

@@ -0,0 +1,76 @@
+import logging
+import os
+from datetime import datetime
+from logging.handlers import RotatingFileHandler
+
+from colorlog import ColoredFormatter
+
+
+LOGGER = logging.getLogger(__name__)
+LOGGERS = {}
+
+
+class DuplicateFilter(logging.Filter):
+    def filter(self, record):
+        repeated_number_exists = getattr(self, "repeated_number", None)
+        current_log = (record.module, record.levelno, record.msg)
+        if current_log != getattr(self, "last_log", None):
+            self.last_log = current_log
+            if repeated_number_exists:
+                LOGGER.warning(f"Last log repeated {self.repeated_number} times.")
+
+            self.repeated_number = 0
+            return True
+        if repeated_number_exists:
+            self.repeated_number += 1
+        else:
+            self.repeated_number = 1
+        return False
+
+
+class WrapperLogFormatter(ColoredFormatter):
+    def formatTime(self, record, datefmt=None):  # noqa: N802
+        return datetime.fromtimestamp(record.created).isoformat()
+
+
+def get_logger(name):
+    if LOGGERS.get(name):
+        return LOGGERS.get(name)
+
+    log_level = os.environ.get("OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL", "INFO")
+    log_file = os.environ.get("OPENSHIFT_PYTHON_WRAPPER_LOG_FILE", "")
+    if log_level not in ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]:
+        raise ValueError(f"Invalid log level: {log_level}")
+
+    logger_obj = logging.getLogger(name)
+    log_formatter = WrapperLogFormatter(
+        fmt="%(asctime)s %(name)s %(log_color)s%(levelname)s%(reset)s %(message)s",
+        log_colors={
+            "DEBUG": "cyan",
+            "INFO": "green",
+            "WARNING": "yellow",
+            "ERROR": "red",
+            "CRITICAL": "red,bg_white",
+        },
+        secondary_log_colors={},
+    )
+
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(fmt=log_formatter)
+    console_handler.addFilter(filter=DuplicateFilter())
+
+    logger_obj.addHandler(hdlr=console_handler)
+    logger_obj.setLevel(level=log_level)
+    logger_obj.addFilter(filter=DuplicateFilter())
+
+    if log_file:
+        log_handler = RotatingFileHandler(
+            filename=log_file, maxBytes=100 * 1024 * 1024, backupCount=20
+        )
+        log_handler.setFormatter(fmt=log_formatter)
+        log_handler.setLevel(level=log_level)
+        logger_obj.addHandler(hdlr=log_handler)
+
+    logger_obj.propagate = False
+    LOGGERS[name] = logger_obj
+    return logger_obj

ocp_resources/machine.py

@@ -0,0 +1,50 @@
+from ocp_resources.constants import TIMEOUT_4MINUTES
+from ocp_resources.resource import NamespacedResource
+
+
+class Machine(NamespacedResource):
+    """
+    Machine object.
+    """
+
+    api_group = NamespacedResource.ApiGroup.MACHINE_OPENSHIFT_IO
+
+    def __init__(
+        self,
+        name=None,
+        namespace=None,
+        teardown=True,
+        client=None,
+        yaml_file=None,
+        delete_timeout=TIMEOUT_4MINUTES,
+        **kwargs,
+    ):
+        super().__init__(
+            name=name,
+            namespace=namespace,
+            client=client,
+            teardown=teardown,
+            yaml_file=yaml_file,
+            delete_timeout=delete_timeout,
+            **kwargs,
+        )
+
+    @property
+    def cluster_name(self):
+        return self.instance.metadata.labels[f"{self.api_group}/cluster-api-cluster"]
+
+    @property
+    def machine_role(self):
+        return self.instance.metadata.labels[
+            f"{self.api_group}/cluster-api-machine-role"
+        ]
+
+    @property
+    def machine_type(self):
+        return self.instance.metadata.labels[
+            f"{self.api_group}/cluster-api-machine-type"
+        ]
+
+    @property
+    def machineset_name(self):
+        return self.instance.metadata.labels[f"{self.api_group}/cluster-api-machineset"]

ocp_resources/machine_config.py

@@ -0,0 +1,5 @@
+from ocp_resources.resource import Resource
+
+
+class MachineConfig(Resource):
+    api_group = Resource.ApiGroup.MACHINECONFIGURATION_OPENSHIFT_IO

ocp_resources/machine_config_pool.py

@@ -0,0 +1,9 @@
+from ocp_resources.resource import Resource
+
+
+class MachineConfigPool(Resource):
+    api_group = Resource.ApiGroup.MACHINECONFIGURATION_OPENSHIFT_IO
+
+    class Status(Resource.Status):
+        UPDATED = "Updated"
+        UPDATING = "Updating"