ptctools 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

ptctools/portainer_client/openapi_client/docs/V1RoleRef.md

@@ -0,0 +1,31 @@
+# V1RoleRef
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_group** | **str** | APIGroup is the group for the resource being referenced | [optional] 
+**kind** | **str** | Kind is the type of resource being referenced | [optional] 
+**name** | **str** | Name is the name of resource being referenced | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_role_ref import V1RoleRef
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1RoleRef from a JSON string
+v1_role_ref_instance = V1RoleRef.from_json(json)
+# print the JSON string representation of the object
+print(V1RoleRef.to_json())
+
+# convert the object into a dict
+v1_role_ref_dict = v1_role_ref_instance.to_dict()
+# create an instance of V1RoleRef from a dict
+v1_role_ref_from_dict = V1RoleRef.from_dict(v1_role_ref_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SELinuxOptions.md

@@ -0,0 +1,32 @@
+# V1SELinuxOptions
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **str** | Level is SELinux level label that applies to the container. +optional | [optional] 
+**role** | **str** | Role is a SELinux role label that applies to the container. +optional | [optional] 
+**type** | **str** | Type is a SELinux type label that applies to the container. +optional | [optional] 
+**user** | **str** | User is a SELinux user label that applies to the container. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_se_linux_options import V1SELinuxOptions
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SELinuxOptions from a JSON string
+v1_se_linux_options_instance = V1SELinuxOptions.from_json(json)
+# print the JSON string representation of the object
+print(V1SELinuxOptions.to_json())
+
+# convert the object into a dict
+v1_se_linux_options_dict = v1_se_linux_options_instance.to_dict()
+# create an instance of V1SELinuxOptions from a dict
+v1_se_linux_options_from_dict = V1SELinuxOptions.from_dict(v1_se_linux_options_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ScopeSelector.md

@@ -0,0 +1,29 @@
+# V1ScopeSelector
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**match_expressions** | [**List[V1ScopedResourceSelectorRequirement]**](V1ScopedResourceSelectorRequirement.md) | A list of scope selector requirements by scope of the resources. +optional +listType=atomic | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_scope_selector import V1ScopeSelector
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ScopeSelector from a JSON string
+v1_scope_selector_instance = V1ScopeSelector.from_json(json)
+# print the JSON string representation of the object
+print(V1ScopeSelector.to_json())
+
+# convert the object into a dict
+v1_scope_selector_dict = v1_scope_selector_instance.to_dict()
+# create an instance of V1ScopeSelector from a dict
+v1_scope_selector_from_dict = V1ScopeSelector.from_dict(v1_scope_selector_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ScopeSelectorOperator.md

@@ -0,0 +1,16 @@
+# V1ScopeSelectorOperator
+
+
+## Enum
+
+* `ScopeSelectorOpIn` (value: `'In'`)
+
+* `ScopeSelectorOpNotIn` (value: `'NotIn'`)
+
+* `ScopeSelectorOpExists` (value: `'Exists'`)
+
+* `ScopeSelectorOpDoesNotExist` (value: `'DoesNotExist'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ScopedResourceSelectorRequirement.md

@@ -0,0 +1,31 @@
+# V1ScopedResourceSelectorRequirement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operator** | [**V1ScopeSelectorOperator**](V1ScopeSelectorOperator.md) | Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. | [optional] 
+**scope_name** | [**V1ResourceQuotaScope**](V1ResourceQuotaScope.md) | The name of the scope that the selector applies to. | [optional] 
+**values** | **List[str]** | An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. +optional +listType=atomic | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_scoped_resource_selector_requirement import V1ScopedResourceSelectorRequirement
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ScopedResourceSelectorRequirement from a JSON string
+v1_scoped_resource_selector_requirement_instance = V1ScopedResourceSelectorRequirement.from_json(json)
+# print the JSON string representation of the object
+print(V1ScopedResourceSelectorRequirement.to_json())
+
+# convert the object into a dict
+v1_scoped_resource_selector_requirement_dict = v1_scoped_resource_selector_requirement_instance.to_dict()
+# create an instance of V1ScopedResourceSelectorRequirement from a dict
+v1_scoped_resource_selector_requirement_from_dict = V1ScopedResourceSelectorRequirement.from_dict(v1_scoped_resource_selector_requirement_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SeccompProfile.md

@@ -0,0 +1,30 @@
+# V1SeccompProfile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**localhost_profile** | **str** | localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \"Localhost\". Must NOT be set for any other type. +optional | [optional] 
+**type** | [**V1SeccompProfileType**](V1SeccompProfileType.md) | type indicates which kind of seccomp profile will be applied. Valid options are:  Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. +unionDiscriminator | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_seccomp_profile import V1SeccompProfile
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SeccompProfile from a JSON string
+v1_seccomp_profile_instance = V1SeccompProfile.from_json(json)
+# print the JSON string representation of the object
+print(V1SeccompProfile.to_json())
+
+# convert the object into a dict
+v1_seccomp_profile_dict = v1_seccomp_profile_instance.to_dict()
+# create an instance of V1SeccompProfile from a dict
+v1_seccomp_profile_from_dict = V1SeccompProfile.from_dict(v1_seccomp_profile_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SeccompProfileType.md

@@ -0,0 +1,14 @@
+# V1SeccompProfileType
+
+
+## Enum
+
+* `SeccompProfileTypeUnconfined` (value: `'Unconfined'`)
+
+* `SeccompProfileTypeRuntimeDefault` (value: `'RuntimeDefault'`)
+
+* `SeccompProfileTypeLocalhost` (value: `'Localhost'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SecretEnvSource.md

@@ -0,0 +1,30 @@
+# V1SecretEnvSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default=\"\" +kubebuilder:default=\"\" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | [optional] 
+**optional** | **bool** | Specify whether the Secret must be defined +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_secret_env_source import V1SecretEnvSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SecretEnvSource from a JSON string
+v1_secret_env_source_instance = V1SecretEnvSource.from_json(json)
+# print the JSON string representation of the object
+print(V1SecretEnvSource.to_json())
+
+# convert the object into a dict
+v1_secret_env_source_dict = v1_secret_env_source_instance.to_dict()
+# create an instance of V1SecretEnvSource from a dict
+v1_secret_env_source_from_dict = V1SecretEnvSource.from_dict(v1_secret_env_source_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SecretKeySelector.md

@@ -0,0 +1,31 @@
+# V1SecretKeySelector
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | The key of the secret to select from.  Must be a valid secret key. | [optional] 
+**name** | **str** | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default=\"\" +kubebuilder:default=\"\" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. | [optional] 
+**optional** | **bool** | Specify whether the Secret or its key must be defined +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_secret_key_selector import V1SecretKeySelector
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SecretKeySelector from a JSON string
+v1_secret_key_selector_instance = V1SecretKeySelector.from_json(json)
+# print the JSON string representation of the object
+print(V1SecretKeySelector.to_json())
+
+# convert the object into a dict
+v1_secret_key_selector_dict = v1_secret_key_selector_instance.to_dict()
+# create an instance of V1SecretKeySelector from a dict
+v1_secret_key_selector_from_dict = V1SecretKeySelector.from_dict(v1_secret_key_selector_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SecretReference.md

@@ -0,0 +1,30 @@
+# V1SecretReference
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | name is unique within a namespace to reference a secret resource. +optional | [optional] 
+**namespace** | **str** | namespace defines the space within which the secret name must be unique. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_secret_reference import V1SecretReference
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SecretReference from a JSON string
+v1_secret_reference_instance = V1SecretReference.from_json(json)
+# print the JSON string representation of the object
+print(V1SecretReference.to_json())
+
+# convert the object into a dict
+v1_secret_reference_dict = v1_secret_reference_instance.to_dict()
+# create an instance of V1SecretReference from a dict
+v1_secret_reference_from_dict = V1SecretReference.from_dict(v1_secret_reference_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SecurityContext.md

@@ -0,0 +1,40 @@
+# V1SecurityContext
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allow_privilege_escalation** | **bool** | AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**app_armor_profile** | [**V1AppArmorProfile**](V1AppArmorProfile.md) | appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**capabilities** | [**V1Capabilities**](V1Capabilities.md) | The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**privileged** | **bool** | Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**proc_mount** | [**V1ProcMountType**](V1ProcMountType.md) | procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**read_only_root_filesystem** | **bool** | Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**run_as_group** | **int** | The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**run_as_non_root** | **bool** | Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional | [optional] 
+**run_as_user** | **int** | The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**se_linux_options** | [**V1SELinuxOptions**](V1SELinuxOptions.md) | The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container.  May also be set in PodSecurityContext.  If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**seccomp_profile** | [**V1SeccompProfile**](V1SeccompProfile.md) | The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. +optional | [optional] 
+**windows_options** | [**V1WindowsSecurityContextOptions**](V1WindowsSecurityContextOptions.md) | The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_security_context import V1SecurityContext
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SecurityContext from a JSON string
+v1_security_context_instance = V1SecurityContext.from_json(json)
+# print the JSON string representation of the object
+print(V1SecurityContext.to_json())
+
+# convert the object into a dict
+v1_security_context_dict = v1_security_context_instance.to_dict()
+# create an instance of V1SecurityContext from a dict
+v1_security_context_from_dict = V1SecurityContext.from_dict(v1_security_context_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1Service.md

@@ -0,0 +1,33 @@
+# V1Service
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | [optional] 
+**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | [optional] 
+**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | [optional] 
+**spec** | [**V1ServiceSpec**](V1ServiceSpec.md) | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional | [optional] 
+**status** | [**V1ServiceStatus**](V1ServiceStatus.md) | Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_service import V1Service
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Service from a JSON string
+v1_service_instance = V1Service.from_json(json)
+# print the JSON string representation of the object
+print(V1Service.to_json())
+
+# convert the object into a dict
+v1_service_dict = v1_service_instance.to_dict()
+# create an instance of V1Service from a dict
+v1_service_from_dict = V1Service.from_dict(v1_service_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServiceAffinity.md

@@ -0,0 +1,12 @@
+# V1ServiceAffinity
+
+
+## Enum
+
+* `ServiceAffinityClientIP` (value: `'ClientIP'`)
+
+* `ServiceAffinityNone` (value: `'None'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServiceExternalTrafficPolicy.md

@@ -0,0 +1,16 @@
+# V1ServiceExternalTrafficPolicy
+
+
+## Enum
+
+* `ServiceExternalTrafficPolicyCluster` (value: `'Cluster'`)
+
+* `ServiceExternalTrafficPolicyLocal` (value: `'Local'`)
+
+* `ServiceExternalTrafficPolicyTypeLocal` (value: `'Local'`)
+
+* `ServiceExternalTrafficPolicyTypeCluster` (value: `'Cluster'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServiceInternalTrafficPolicy.md

@@ -0,0 +1,12 @@
+# V1ServiceInternalTrafficPolicy
+
+
+## Enum
+
+* `ServiceInternalTrafficPolicyCluster` (value: `'Cluster'`)
+
+* `ServiceInternalTrafficPolicyLocal` (value: `'Local'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServicePort.md

@@ -0,0 +1,34 @@
+# V1ServicePort
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_protocol** | **str** | The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:  * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).  * Kubernetes-defined prefixed names:   * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-   * 'kubernetes.io/ws'  - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455   * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455  * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. +optional | [optional] 
+**name** | **str** | The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. +optional | [optional] 
+**node_port** | **int** | The port on each node on which this service is exposed when type is NodePort or LoadBalancer.  Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail.  If not specified, a port will be allocated if this Service requires one.  If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport +optional | [optional] 
+**port** | **int** | The port that will be exposed by this service. | [optional] 
+**protocol** | [**V1Protocol**](V1Protocol.md) | The IP protocol for this port. Supports \"TCP\", \"UDP\", and \"SCTP\". Default is TCP. +default=\"TCP\" +optional | [optional] 
+**target_port** | [**IntstrIntOrString**](IntstrIntOrString.md) | Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_service_port import V1ServicePort
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ServicePort from a JSON string
+v1_service_port_instance = V1ServicePort.from_json(json)
+# print the JSON string representation of the object
+print(V1ServicePort.to_json())
+
+# convert the object into a dict
+v1_service_port_dict = v1_service_port_instance.to_dict()
+# create an instance of V1ServicePort from a dict
+v1_service_port_from_dict = V1ServicePort.from_dict(v1_service_port_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServiceSpec.md

@@ -0,0 +1,48 @@
+# V1ServiceSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allocate_load_balancer_node_ports** | **bool** | allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer.  Default is \"true\". It may be set to \"false\" if the cluster load-balancer does not rely on NodePorts.  If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. +optional | [optional] 
+**cluster_ip** | **str** | clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above).  Valid values are \"None\", empty string (\"\"), or a valid IP address. Setting this to \"None\" makes a \"headless service\" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required.  Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +optional | [optional] 
+**cluster_ips** | **List[str]** | ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly.  If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above).  Valid values are \"None\", empty string (\"\"), or a valid IP address.  Setting this to \"None\" makes a \"headless service\" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required.  Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName.  If this field is not specified, it will be initialized from the clusterIP field.  If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value.  This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +listType=atomic +optional | [optional] 
+**external_ips** | **List[str]** | externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service.  These IPs are not managed by Kubernetes.  The user is responsible for ensuring that traffic arrives at a node with this IP.  A common example is external load-balancers that are not part of the Kubernetes system. +optional +listType=atomic | [optional] 
+**external_name** | **str** | externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved.  Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be \"ExternalName\". +optional | [optional] 
+**external_traffic_policy** | [**V1ServiceExternalTrafficPolicy**](V1ServiceExternalTrafficPolicy.md) | externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's \"externally-facing\" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to \"Local\", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, \"Cluster\", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get \"Cluster\" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. +optional | [optional] 
+**health_check_node_port** | **int** | healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used.  If not specified, a value will be automatically allocated.  External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not.  If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. +optional | [optional] 
+**internal_traffic_policy** | [**V1ServiceInternalTrafficPolicy**](V1ServiceInternalTrafficPolicy.md) | InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to \"Local\", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, \"Cluster\", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). +optional | [optional] 
+**ip_families** | [**List[V1IPFamily]**](V1IPFamily.md) | IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are \"IPv4\" and \"IPv6\".  This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to \"headless\" services. This field will be wiped when updating a Service to type ExternalName.  This field may hold a maximum of two entries (dual-stack families, in either order).  These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. +listType=atomic +optional | [optional] 
+**ip_family_policy** | [**V1IPFamilyPolicy**](V1IPFamilyPolicy.md) | IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be \"SingleStack\" (a single IP family), \"PreferDualStack\" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or \"RequireDualStack\" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. +optional | [optional] 
+**load_balancer_class** | **str** | loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. \"internal-vip\" or \"example.com/internal-vip\". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. +optional | [optional] 
+**load_balancer_ip** | **str** | Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available. +optional | [optional] 
+**load_balancer_source_ranges** | **List[str]** | If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.\" More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ +optional +listType=atomic | [optional] 
+**ports** | [**List[V1ServicePort]**](V1ServicePort.md) | The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +patchMergeKey=port +patchStrategy=merge +listType=map +listMapKey=port +listMapKey=protocol | [optional] 
+**publish_not_ready_addresses** | **bool** | publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered \"ready\" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. +optional | [optional] 
+**selector** | **Dict[str, str]** | Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ +optional +mapType=atomic | [optional] 
+**session_affinity** | [**V1ServiceAffinity**](V1ServiceAffinity.md) | Supports \"ClientIP\" and \"None\". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +optional | [optional] 
+**session_affinity_config** | [**V1SessionAffinityConfig**](V1SessionAffinityConfig.md) | sessionAffinityConfig contains the configurations of session affinity. +optional | [optional] 
+**traffic_distribution** | **str** | TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict adherence. If the field is not set, the implementation will apply its default routing strategy. If set to \"PreferClose\", implementations should prioritize endpoints that are in the same zone. +featureGate=ServiceTrafficDistribution +optional | [optional] 
+**type** | [**V1ServiceType**](V1ServiceType.md) | type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. \"ClusterIP\" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is \"None\", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. \"NodePort\" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. \"LoadBalancer\" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. \"ExternalName\" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_service_spec import V1ServiceSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ServiceSpec from a JSON string
+v1_service_spec_instance = V1ServiceSpec.from_json(json)
+# print the JSON string representation of the object
+print(V1ServiceSpec.to_json())
+
+# convert the object into a dict
+v1_service_spec_dict = v1_service_spec_instance.to_dict()
+# create an instance of V1ServiceSpec from a dict
+v1_service_spec_from_dict = V1ServiceSpec.from_dict(v1_service_spec_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServiceStatus.md

@@ -0,0 +1,30 @@
+# V1ServiceStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conditions** | [**List[V1Condition]**](V1Condition.md) | Current service state +optional +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type | [optional] 
+**load_balancer** | [**V1LoadBalancerStatus**](V1LoadBalancerStatus.md) | LoadBalancer contains the current status of the load-balancer, if one is present. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_service_status import V1ServiceStatus
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ServiceStatus from a JSON string
+v1_service_status_instance = V1ServiceStatus.from_json(json)
+# print the JSON string representation of the object
+print(V1ServiceStatus.to_json())
+
+# convert the object into a dict
+v1_service_status_dict = v1_service_status_instance.to_dict()
+# create an instance of V1ServiceStatus from a dict
+v1_service_status_from_dict = V1ServiceStatus.from_dict(v1_service_status_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1ServiceType.md

@@ -0,0 +1,16 @@
+# V1ServiceType
+
+
+## Enum
+
+* `ServiceTypeClusterIP` (value: `'ClusterIP'`)
+
+* `ServiceTypeNodePort` (value: `'NodePort'`)
+
+* `ServiceTypeLoadBalancer` (value: `'LoadBalancer'`)
+
+* `ServiceTypeExternalName` (value: `'ExternalName'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

ptctools/portainer_client/openapi_client/docs/V1SessionAffinityConfig.md

@@ -0,0 +1,29 @@
+# V1SessionAffinityConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_ip** | [**V1ClientIPConfig**](V1ClientIPConfig.md) | clientIP contains the configurations of Client IP based session affinity. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_session_affinity_config import V1SessionAffinityConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1SessionAffinityConfig from a JSON string
+v1_session_affinity_config_instance = V1SessionAffinityConfig.from_json(json)
+# print the JSON string representation of the object
+print(V1SessionAffinityConfig.to_json())
+
+# convert the object into a dict
+v1_session_affinity_config_dict = v1_session_affinity_config_instance.to_dict()
+# create an instance of V1SessionAffinityConfig from a dict
+v1_session_affinity_config_from_dict = V1SessionAffinityConfig.from_dict(v1_session_affinity_config_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+