openshift-python-wrapper 11.0.93__tar.gz → 11.0.94__tar.gz

{openshift_python_wrapper-11.0.93 → openshift_python_wrapper-11.0.94}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openshift-python-wrapper
-Version: 11.0.93
+Version: 11.0.94
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Project-URL: homepage, https://github.com/RedHatQE/openshift-python-wrapper
 Project-URL: documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/

openshift_python_wrapper-11.0.94/ocp_resources/gateway_class.py

@@ -0,0 +1,88 @@
+# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md
+
+
+from typing import Any
+from ocp_resources.resource import Resource
+from ocp_resources.exceptions import MissingRequiredArgumentError
+
+
+class GatewayClass(Resource):
+    """
+        GatewayClass describes a class of Gateways available to the user for creating
+    Gateway resources.
+
+    It is recommended that this resource be used as a template for Gateways. This
+    means that a Gateway is based on the state of the GatewayClass at the time it
+    was created and changes to the GatewayClass or associated parameters are not
+    propagated down to existing Gateways. This recommendation is intended to
+    limit the blast radius of changes to GatewayClass or associated parameters.
+    If implementations choose to propagate GatewayClass changes to existing
+    Gateways, that MUST be clearly documented by the implementation.
+
+    Whenever one or more Gateways are using a GatewayClass, implementations SHOULD
+    add the `gateway-exists-finalizer.gateway.networking.k8s.io` finalizer on the
+    associated GatewayClass. This ensures that a GatewayClass associated with a
+    Gateway is not deleted while in use.
+
+    GatewayClass is a Cluster level resource.
+    """
+
+    api_group: str = Resource.ApiGroup.GATEWAY_NETWORKING_K8S_IO
+
+    def __init__(
+        self,
+        controller_name: str | None = None,
+        description: str | None = None,
+        parameters_ref: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        r"""
+        Args:
+            controller_name (str): ControllerName is the name of the controller that is managing Gateways
+              of this class. The value of this field MUST be a domain prefixed
+              path.  Example: "example.net/gateway-controller".  This field is
+              not mutable and cannot be empty.  Support: Core
+
+            description (str): Description helps describe a GatewayClass with more details.
+
+            parameters_ref (dict[str, Any]): ParametersRef is a reference to a resource that contains the
+              configuration parameters corresponding to the GatewayClass. This
+              is optional if the controller does not require any additional
+              configuration.  ParametersRef can reference a standard Kubernetes
+              resource, i.e. ConfigMap, or an implementation-specific custom
+              resource. The resource can be cluster-scoped or namespace-scoped.
+              If the referent cannot be found, refers to an unsupported kind, or
+              when the data within that resource is malformed, the GatewayClass
+              SHOULD be rejected with the "Accepted" status condition set to
+              "False" and an "InvalidParameters" reason.  A Gateway for this
+              GatewayClass may provide its own `parametersRef`. When both are
+              specified, the merging behavior is implementation specific. It is
+              generally recommended that GatewayClass provides defaults that can
+              be overridden by a Gateway.  Support: Implementation-specific
+
+        """
+        super().__init__(**kwargs)
+
+        self.controller_name = controller_name
+        self.description = description
+        self.parameters_ref = parameters_ref
+
+    def to_dict(self) -> None:
+        super().to_dict()
+
+        if not self.kind_dict and not self.yaml_file:
+            if self.controller_name is None:
+                raise MissingRequiredArgumentError(argument="self.controller_name")
+
+            self.res["spec"] = {}
+            _spec = self.res["spec"]
+
+            _spec["controllerName"] = self.controller_name
+
+            if self.description is not None:
+                _spec["description"] = self.description
+
+            if self.parameters_ref is not None:
+                _spec["parametersRef"] = self.parameters_ref
+
+    # End of generated code

openshift_python_wrapper-11.0.94/ocp_resources/gateway_gateway_networking_k8s_io.py

@@ -0,0 +1,187 @@
+# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md
+
+
+from typing import Any
+from ocp_resources.resource import NamespacedResource
+from ocp_resources.exceptions import MissingRequiredArgumentError
+
+
+class Gateway(NamespacedResource):
+    """
+        Gateway represents an instance of a service-traffic handling infrastructure
+    by binding Listeners to a set of IP addresses.
+    """
+
+    api_group: str = NamespacedResource.ApiGroup.GATEWAY_NETWORKING_K8S_IO
+
+    def __init__(
+        self,
+        addresses: list[Any] | None = None,
+        gateway_class_name: str | None = None,
+        infrastructure: dict[str, Any] | None = None,
+        listeners: list[Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        r"""
+        Args:
+            addresses (list[Any]): Addresses requested for this Gateway. This is optional and behavior
+              can depend on the implementation. If a value is set in the spec
+              and the requested address is invalid or unavailable, the
+              implementation MUST indicate this in the associated entry in
+              GatewayStatus.Addresses.  The Addresses field represents a request
+              for the address(es) on the "outside of the Gateway", that traffic
+              bound for this Gateway will use. This could be the IP address or
+              hostname of an external load balancer or other networking
+              infrastructure, or some other address that traffic will be sent
+              to.  If no Addresses are specified, the implementation MAY
+              schedule the Gateway in an implementation-specific manner,
+              assigning an appropriate set of Addresses.  The implementation
+              MUST bind all Listeners to every GatewayAddress that it assigns to
+              the Gateway and add a corresponding entry in
+              GatewayStatus.Addresses.  Support: Extended
+
+            gateway_class_name (str): GatewayClassName used for this Gateway. This is the name of a
+              GatewayClass resource.
+
+            infrastructure (dict[str, Any]): Infrastructure defines infrastructure level attributes about this
+              Gateway instance.  Support: Extended
+
+            listeners (list[Any]): Listeners associated with this Gateway. Listeners define logical
+              endpoints that are bound on this Gateway's addresses. At least one
+              Listener MUST be specified.  ## Distinct Listeners  Each Listener
+              in a set of Listeners (for example, in a single Gateway) MUST be
+              _distinct_, in that a traffic flow MUST be able to be assigned to
+              exactly one listener. (This section uses "set of Listeners" rather
+              than "Listeners in a single Gateway" because implementations MAY
+              merge configuration from multiple Gateways onto a single data
+              plane, and these rules _also_ apply in that case).  Practically,
+              this means that each listener in a set MUST have a unique
+              combination of Port, Protocol, and, if supported by the protocol,
+              Hostname.  Some combinations of port, protocol, and TLS settings
+              are considered Core support and MUST be supported by
+              implementations based on the objects they support:  HTTPRoute  1.
+              HTTPRoute, Port: 80, Protocol: HTTP 2. HTTPRoute, Port: 443,
+              Protocol: HTTPS, TLS Mode: Terminate, TLS keypair provided
+              TLSRoute  1. TLSRoute, Port: 443, Protocol: TLS, TLS Mode:
+              Passthrough  "Distinct" Listeners have the following property:
+              **The implementation can match inbound requests to a single
+              distinct Listener**.  When multiple Listeners share values for
+              fields (for example, two Listeners with the same Port value), the
+              implementation can match requests to only one of the Listeners
+              using other Listener fields.  When multiple listeners have the
+              same value for the Protocol field, then each of the Listeners with
+              matching Protocol values MUST have different values for other
+              fields.  The set of fields that MUST be different for a Listener
+              differs per protocol. The following rules define the rules for
+              what fields MUST be considered for Listeners to be distinct with
+              each protocol currently defined in the Gateway API spec.  The set
+              of listeners that all share a protocol value MUST have _different_
+              values for _at least one_ of these fields to be distinct:  *
+              **HTTP, HTTPS, TLS**: Port, Hostname * **TCP, UDP**: Port  One
+              **very** important rule to call out involves what happens when an
+              implementation:  * Supports TCP protocol Listeners, as well as
+              HTTP, HTTPS, or TLS protocol   Listeners, and * sees HTTP, HTTPS,
+              or TLS protocols with the same `port` as one with TCP   Protocol.
+              In this case all the Listeners that share a port with the TCP
+              Listener are not distinct and so MUST NOT be accepted.  If an
+              implementation does not support TCP Protocol Listeners, then the
+              previous rule does not apply, and the TCP Listeners SHOULD NOT be
+              accepted.  Note that the `tls` field is not used for determining
+              if a listener is distinct, because Listeners that _only_ differ on
+              TLS config will still conflict in all cases.  ### Listeners that
+              are distinct only by Hostname  When the Listeners are distinct
+              based only on Hostname, inbound request hostnames MUST match from
+              the most specific to least specific Hostname values to choose the
+              correct Listener and its associated set of Routes.  Exact matches
+              MUST be processed before wildcard matches, and wildcard matches
+              MUST be processed before fallback (empty Hostname value) matches.
+              For example, `"foo.example.com"` takes precedence over
+              `"*.example.com"`, and `"*.example.com"` takes precedence over
+              `""`.  Additionally, if there are multiple wildcard entries, more
+              specific wildcard entries must be processed before less specific
+              wildcard entries. For example, `"*.foo.example.com"` takes
+              precedence over `"*.example.com"`.  The precise definition here is
+              that the higher the number of dots in the hostname to the right of
+              the wildcard character, the higher the precedence.  The wildcard
+              character will match any number of characters _and dots_ to the
+              left, however, so `"*.example.com"` will match both
+              `"foo.bar.example.com"` _and_ `"bar.example.com"`.  ## Handling
+              indistinct Listeners  If a set of Listeners contains Listeners
+              that are not distinct, then those Listeners are _Conflicted_, and
+              the implementation MUST set the "Conflicted" condition in the
+              Listener Status to "True".  The words "indistinct" and
+              "conflicted" are considered equivalent for the purpose of this
+              documentation.  Implementations MAY choose to accept a Gateway
+              with some Conflicted Listeners only if they only accept the
+              partial Listener set that contains no Conflicted Listeners.
+              Specifically, an implementation MAY accept a partial Listener set
+              subject to the following rules:  * The implementation MUST NOT
+              pick one conflicting Listener as the winner.   ALL indistinct
+              Listeners must not be accepted for processing. * At least one
+              distinct Listener MUST be present, or else the Gateway effectively
+              contains _no_ Listeners, and must be rejected from processing as a
+              whole.  The implementation MUST set a "ListenersNotValid"
+              condition on the Gateway Status when the Gateway contains
+              Conflicted Listeners whether or not they accept the Gateway. That
+              Condition SHOULD clearly indicate in the Message which Listeners
+              are conflicted, and which are Accepted. Additionally, the Listener
+              status for those listeners SHOULD indicate which Listeners are
+              conflicted and not Accepted.  ## General Listener behavior  Note
+              that, for all distinct Listeners, requests SHOULD match at most
+              one Listener. For example, if Listeners are defined for
+              "foo.example.com" and "*.example.com", a request to
+              "foo.example.com" SHOULD only be routed using routes attached to
+              the "foo.example.com" Listener (and not the "*.example.com"
+              Listener).  This concept is known as "Listener Isolation", and it
+              is an Extended feature of Gateway API. Implementations that do not
+              support Listener Isolation MUST clearly document this, and MUST
+              NOT claim support for the `GatewayHTTPListenerIsolation` feature.
+              Implementations that _do_ support Listener Isolation SHOULD claim
+              support for the Extended `GatewayHTTPListenerIsolation` feature
+              and pass the associated conformance tests.  ## Compatible
+              Listeners  A Gateway's Listeners are considered _compatible_ if:
+              1. They are distinct. 2. The implementation can serve them in
+              compliance with the Addresses    requirement that all Listeners
+              are available on all assigned    addresses.  Compatible
+              combinations in Extended support are expected to vary across
+              implementations. A combination that is compatible for one
+              implementation may not be compatible for another.  For example, an
+              implementation that cannot serve both TCP and UDP listeners on the
+              same address, or cannot mix HTTPS and generic TLS listens on the
+              same port would not consider those cases compatible, even though
+              they are distinct.  Implementations MAY merge separate Gateways
+              onto a single set of Addresses if all Listeners across all
+              Gateways are compatible.  In a future release the MinItems=1
+              requirement MAY be dropped.  Support: Core
+
+        """
+        super().__init__(**kwargs)
+
+        self.addresses = addresses
+        self.gateway_class_name = gateway_class_name
+        self.infrastructure = infrastructure
+        self.listeners = listeners
+
+    def to_dict(self) -> None:
+        super().to_dict()
+
+        if not self.kind_dict and not self.yaml_file:
+            if self.gateway_class_name is None:
+                raise MissingRequiredArgumentError(argument="self.gateway_class_name")
+
+            if self.listeners is None:
+                raise MissingRequiredArgumentError(argument="self.listeners")
+
+            self.res["spec"] = {}
+            _spec = self.res["spec"]
+
+            _spec["gatewayClassName"] = self.gateway_class_name
+            _spec["listeners"] = self.listeners
+
+            if self.addresses is not None:
+                _spec["addresses"] = self.addresses
+
+            if self.infrastructure is not None:
+                _spec["infrastructure"] = self.infrastructure
+
+    # End of generated code

openshift_python_wrapper-11.0.94/ocp_resources/gateway_networking_istio_io.py

@@ -0,0 +1,46 @@
+# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md
+
+
+from typing import Any
+from ocp_resources.resource import NamespacedResource
+
+
+class Gateway(NamespacedResource):
+    """
+    No field description from API
+    """
+
+    api_group: str = NamespacedResource.ApiGroup.NETWORKING_ISTIO_IO
+
+    def __init__(
+        self,
+        selector: dict[str, Any] | None = None,
+        servers: list[Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        r"""
+        Args:
+            selector (dict[str, Any]): No field description from API
+
+            servers (list[Any]): A list of server specifications.
+
+        """
+        super().__init__(**kwargs)
+
+        self.selector = selector
+        self.servers = servers
+
+    def to_dict(self) -> None:
+        super().to_dict()
+
+        if not self.kind_dict and not self.yaml_file:
+            self.res["spec"] = {}
+            _spec = self.res["spec"]
+
+            if self.selector is not None:
+                _spec["selector"] = self.selector
+
+            if self.servers is not None:
+                _spec["servers"] = self.servers
+
+    # End of generated code

{openshift_python_wrapper-11.0.93 → openshift_python_wrapper-11.0.94}/ocp_resources/guardrails_orchestrator.py

@@ -1,8 +1,9 @@
 # Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md
 
+from ocp_resources.exceptions import MissingRequiredArgumentError
 
 from typing import Any
-from ocp_resources.resource import NamespacedResource, MissingRequiredArgumentError
+from ocp_resources.resource import NamespacedResource
 
 
 class GuardrailsOrchestrator(NamespacedResource):
@@ -14,9 +15,11 @@ class GuardrailsOrchestrator(NamespacedResource):
 
     def __init__(
         self,
+        auto_config: dict[str, Any] | None = None,
         enable_built_in_detectors: bool | None = None,
         enable_guardrails_gateway: bool | None = None,
         guardrails_gateway_config: str | None = None,
+        log_level: str | None = None,
         orchestrator_config: str | None = None,
         otel_exporter: dict[str, Any] | None = None,
         replicas: int | None = None,
@@ -24,25 +27,34 @@ class GuardrailsOrchestrator(NamespacedResource):
     ) -> None:
         r"""
         Args:
+            auto_config (dict[str, Any]): Settings governing the automatic configuration of the orchestrator.
+              Replaces `OrchestratorConfig`.
+
             enable_built_in_detectors (bool): Boolean flag to enable/disable built-in detectors
 
             enable_guardrails_gateway (bool): Boolean flag to enable/disable the guardrails sidecar gateway
 
             guardrails_gateway_config (str):  Name of the configmap containing guadrails sidecar gateway arguments
 
+            log_level (str): Set log level in the orchestrator deployment
+
             orchestrator_config (str): Name of configmap containing generator,detector,and chunker arguments
 
             otel_exporter (dict[str, Any]): List of orchestrator enviroment variables for configuring the OTLP
               exporter
 
-            replicas (int): Number of replicas
+            replicas (int): INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important:
+              Run "make" to regenerate code after modifying this file Number of
+              replicas
 
         """
         super().__init__(**kwargs)
 
+        self.auto_config = auto_config
         self.enable_built_in_detectors = enable_built_in_detectors
         self.enable_guardrails_gateway = enable_guardrails_gateway
         self.guardrails_gateway_config = guardrails_gateway_config
+        self.log_level = log_level
         self.orchestrator_config = orchestrator_config
         self.otel_exporter = otel_exporter
         self.replicas = replicas
@@ -51,18 +63,17 @@ class GuardrailsOrchestrator(NamespacedResource):
         super().to_dict()
 
         if not self.kind_dict and not self.yaml_file:
-            if self.orchestrator_config is None:
-                raise MissingRequiredArgumentError(argument="self.orchestrator_config")
-
             if self.replicas is None:
                 raise MissingRequiredArgumentError(argument="self.replicas")
 
             self.res["spec"] = {}
             _spec = self.res["spec"]
 
-            _spec["orchestratorConfig"] = self.orchestrator_config
             _spec["replicas"] = self.replicas
 
+            if self.auto_config is not None:
+                _spec["autoConfig"] = self.auto_config
+
             if self.enable_built_in_detectors is not None:
                 _spec["enableBuiltInDetectors"] = self.enable_built_in_detectors
 
@@ -72,6 +83,12 @@ class GuardrailsOrchestrator(NamespacedResource):
             if self.guardrails_gateway_config is not None:
                 _spec["guardrailsGatewayConfig"] = self.guardrails_gateway_config
 
+            if self.log_level is not None:
+                _spec["logLevel"] = self.log_level
+
+            if self.orchestrator_config is not None:
+                _spec["orchestratorConfig"] = self.orchestrator_config
+
             if self.otel_exporter is not None:
                 _spec["otelExporter"] = self.otel_exporter
 

{openshift_python_wrapper-11.0.93 → openshift_python_wrapper-11.0.94}/ocp_resources/resource.py

@@ -492,6 +492,7 @@ class Resource(ResourceConstants):
         FENCE_AGENTS_REMEDIATION_MEDIK8S_IO: str = "fence-agents-remediation.medik8s.io"
         FORKLIFT_KONVEYOR_IO: str = "forklift.konveyor.io"
         FRRK8S_METALLB_IO = "frrk8s.metallb.io"
+        GATEWAY_NETWORKING_K8S_IO: str = "gateway.networking.k8s.io"
         HCO_KUBEVIRT_IO: str = "hco.kubevirt.io"
         HELM_MARIADB_MMONTES_IO: str = "helm.mariadb.mmontes.io"
         HIVE_OPENSHIFT_IO: str = "hive.openshift.io"

{openshift_python_wrapper-11.0.93 → openshift_python_wrapper-11.0.94}/pyproject.toml

@@ -68,7 +68,7 @@ dev-dependencies = ["ipdb>=0.13.13", "ipython>=8.12.3"]
 [project]
 requires-python = ">=3.10"
 name = "openshift-python-wrapper"
-version = "11.0.93"
+version = "11.0.94"
 description = "Wrapper around https://github.com/kubernetes-client/python"
 readme = "README.md"
 license = "Apache-2.0"