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

ptctools/portainer_client/openapi_client/docs/UsersHelmUserRepositoryResponse.md

@@ -0,0 +1,30 @@
+# UsersHelmUserRepositoryResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**global_repository** | **str** |  | [optional] 
+**user_repositories** | [**List[PortainerHelmUserRepository]**](PortainerHelmUserRepository.md) |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.users_helm_user_repository_response import UsersHelmUserRepositoryResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UsersHelmUserRepositoryResponse from a JSON string
+users_helm_user_repository_response_instance = UsersHelmUserRepositoryResponse.from_json(json)
+# print the JSON string representation of the object
+print(UsersHelmUserRepositoryResponse.to_json())
+
+# convert the object into a dict
+users_helm_user_repository_response_dict = users_helm_user_repository_response_instance.to_dict()
+# create an instance of UsersHelmUserRepositoryResponse from a dict
+users_helm_user_repository_response_from_dict = UsersHelmUserRepositoryResponse.from_dict(users_helm_user_repository_response_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/UsersThemePayload.md

@@ -0,0 +1,29 @@
+# UsersThemePayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**color** | **str** | Color represents the color theme of the UI | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.users_theme_payload import UsersThemePayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UsersThemePayload from a JSON string
+users_theme_payload_instance = UsersThemePayload.from_json(json)
+# print the JSON string representation of the object
+print(UsersThemePayload.to_json())
+
+# convert the object into a dict
+users_theme_payload_dict = users_theme_payload_instance.to_dict()
+# create an instance of UsersThemePayload from a dict
+users_theme_payload_from_dict = UsersThemePayload.from_dict(users_theme_payload_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/UsersUserAccessTokenCreatePayload.md

@@ -0,0 +1,30 @@
+# UsersUserAccessTokenCreatePayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **str** |  | 
+**password** | **str** |  | 
+
+## Example
+
+```python
+from openapi_client.models.users_user_access_token_create_payload import UsersUserAccessTokenCreatePayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UsersUserAccessTokenCreatePayload from a JSON string
+users_user_access_token_create_payload_instance = UsersUserAccessTokenCreatePayload.from_json(json)
+# print the JSON string representation of the object
+print(UsersUserAccessTokenCreatePayload.to_json())
+
+# convert the object into a dict
+users_user_access_token_create_payload_dict = users_user_access_token_create_payload_instance.to_dict()
+# create an instance of UsersUserAccessTokenCreatePayload from a dict
+users_user_access_token_create_payload_from_dict = UsersUserAccessTokenCreatePayload.from_dict(users_user_access_token_create_payload_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/UsersUserCreatePayload.md

@@ -0,0 +1,31 @@
+# UsersUserCreatePayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **str** |  | 
+**role** | **int** | User role (1 for administrator account and 2 for regular account) | 
+**username** | **str** |  | 
+
+## Example
+
+```python
+from openapi_client.models.users_user_create_payload import UsersUserCreatePayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UsersUserCreatePayload from a JSON string
+users_user_create_payload_instance = UsersUserCreatePayload.from_json(json)
+# print the JSON string representation of the object
+print(UsersUserCreatePayload.to_json())
+
+# convert the object into a dict
+users_user_create_payload_dict = users_user_create_payload_instance.to_dict()
+# create an instance of UsersUserCreatePayload from a dict
+users_user_create_payload_from_dict = UsersUserCreatePayload.from_dict(users_user_create_payload_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/UsersUserUpdatePasswordPayload.md

@@ -0,0 +1,30 @@
+# UsersUserUpdatePasswordPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_password** | **str** | New Password | 
+**password** | **str** | Current Password | 
+
+## Example
+
+```python
+from openapi_client.models.users_user_update_password_payload import UsersUserUpdatePasswordPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UsersUserUpdatePasswordPayload from a JSON string
+users_user_update_password_payload_instance = UsersUserUpdatePasswordPayload.from_json(json)
+# print the JSON string representation of the object
+print(UsersUserUpdatePasswordPayload.to_json())
+
+# convert the object into a dict
+users_user_update_password_payload_dict = users_user_update_password_payload_instance.to_dict()
+# create an instance of UsersUserUpdatePasswordPayload from a dict
+users_user_update_password_payload_from_dict = UsersUserUpdatePasswordPayload.from_dict(users_user_update_password_payload_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/UsersUserUpdatePayload.md

@@ -0,0 +1,34 @@
+# UsersUserUpdatePayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_password** | **str** |  | 
+**password** | **str** |  | 
+**role** | **int** | User role (1 for administrator account and 2 for regular account) | 
+**theme** | [**UsersThemePayload**](UsersThemePayload.md) |  | [optional] 
+**use_cache** | **bool** |  | 
+**username** | **str** |  | 
+
+## Example
+
+```python
+from openapi_client.models.users_user_update_payload import UsersUserUpdatePayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UsersUserUpdatePayload from a JSON string
+users_user_update_payload_instance = UsersUserUpdatePayload.from_json(json)
+# print the JSON string representation of the object
+print(UsersUserUpdatePayload.to_json())
+
+# convert the object into a dict
+users_user_update_payload_dict = users_user_update_payload_instance.to_dict()
+# create an instance of UsersUserUpdatePayload from a dict
+users_user_update_payload_from_dict = UsersUserUpdatePayload.from_dict(users_user_update_payload_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/V1AppArmorProfile.md

@@ -0,0 +1,30 @@
+# V1AppArmorProfile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**localhost_profile** | **str** | localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\". +optional | [optional] 
+**type** | [**V1AppArmorProfileType**](V1AppArmorProfileType.md) | type indicates which kind of AppArmor profile will be applied. Valid options are:   Localhost - a profile pre-loaded on the node.   RuntimeDefault - the container runtime's default profile.   Unconfined - no AppArmor enforcement. +unionDiscriminator | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_app_armor_profile import V1AppArmorProfile
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1AppArmorProfile from a JSON string
+v1_app_armor_profile_instance = V1AppArmorProfile.from_json(json)
+# print the JSON string representation of the object
+print(V1AppArmorProfile.to_json())
+
+# convert the object into a dict
+v1_app_armor_profile_dict = v1_app_armor_profile_instance.to_dict()
+# create an instance of V1AppArmorProfile from a dict
+v1_app_armor_profile_from_dict = V1AppArmorProfile.from_dict(v1_app_armor_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/V1AppArmorProfileType.md

@@ -0,0 +1,14 @@
+# V1AppArmorProfileType
+
+
+## Enum
+
+* `AppArmorProfileTypeUnconfined` (value: `'Unconfined'`)
+
+* `AppArmorProfileTypeRuntimeDefault` (value: `'RuntimeDefault'`)
+
+* `AppArmorProfileTypeLocalhost` (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/V1CSIPersistentVolumeSource.md

@@ -0,0 +1,38 @@
+# V1CSIPersistentVolumeSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**controller_expand_secret_ref** | [**V1SecretReference**](V1SecretReference.md) | controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional | [optional] 
+**controller_publish_secret_ref** | [**V1SecretReference**](V1SecretReference.md) | controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional | [optional] 
+**driver** | **str** | driver is the name of the driver to use for this volume. Required. | [optional] 
+**fs_type** | **str** | fsType to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". +optional | [optional] 
+**node_expand_secret_ref** | [**V1SecretReference**](V1SecretReference.md) | nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional | [optional] 
+**node_publish_secret_ref** | [**V1SecretReference**](V1SecretReference.md) | nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional | [optional] 
+**node_stage_secret_ref** | [**V1SecretReference**](V1SecretReference.md) | nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional | [optional] 
+**read_only** | **bool** | readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). +optional | [optional] 
+**volume_attributes** | **Dict[str, str]** | volumeAttributes of the volume to publish. +optional | [optional] 
+**volume_handle** | **str** | volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_csi_persistent_volume_source import V1CSIPersistentVolumeSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1CSIPersistentVolumeSource from a JSON string
+v1_csi_persistent_volume_source_instance = V1CSIPersistentVolumeSource.from_json(json)
+# print the JSON string representation of the object
+print(V1CSIPersistentVolumeSource.to_json())
+
+# convert the object into a dict
+v1_csi_persistent_volume_source_dict = v1_csi_persistent_volume_source_instance.to_dict()
+# create an instance of V1CSIPersistentVolumeSource from a dict
+v1_csi_persistent_volume_source_from_dict = V1CSIPersistentVolumeSource.from_dict(v1_csi_persistent_volume_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/V1Capabilities.md

@@ -0,0 +1,30 @@
+# V1Capabilities
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**add** | **List[str]** | Added capabilities +optional +listType=atomic | [optional] 
+**drop** | **List[str]** | Removed capabilities +optional +listType=atomic | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_capabilities import V1Capabilities
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Capabilities from a JSON string
+v1_capabilities_instance = V1Capabilities.from_json(json)
+# print the JSON string representation of the object
+print(V1Capabilities.to_json())
+
+# convert the object into a dict
+v1_capabilities_dict = v1_capabilities_instance.to_dict()
+# create an instance of V1Capabilities from a dict
+v1_capabilities_from_dict = V1Capabilities.from_dict(v1_capabilities_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/V1ClientIPConfig.md

@@ -0,0 +1,29 @@
+# V1ClientIPConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timeout_seconds** | **int** | timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == \"ClientIP\". Default value is 10800(for 3 hours). +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_client_ip_config import V1ClientIPConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ClientIPConfig from a JSON string
+v1_client_ip_config_instance = V1ClientIPConfig.from_json(json)
+# print the JSON string representation of the object
+print(V1ClientIPConfig.to_json())
+
+# convert the object into a dict
+v1_client_ip_config_dict = v1_client_ip_config_instance.to_dict()
+# create an instance of V1ClientIPConfig from a dict
+v1_client_ip_config_from_dict = V1ClientIPConfig.from_dict(v1_client_ip_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)
+
+

ptctools/portainer_client/openapi_client/docs/V1Condition.md

@@ -0,0 +1,34 @@
+# V1Condition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_transition_time** | **str** | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable. +required +kubebuilder:validation:Required +kubebuilder:validation:Type=string +kubebuilder:validation:Format=date-time | [optional] 
+**message** | **str** | message is a human readable message indicating details about the transition. This may be an empty string. +required +kubebuilder:validation:Required +kubebuilder:validation:MaxLength=32768 | [optional] 
+**observed_generation** | **int** | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. +optional +kubebuilder:validation:Minimum=0 | [optional] 
+**reason** | **str** | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. +required +kubebuilder:validation:Required +kubebuilder:validation:MaxLength=1024 +kubebuilder:validation:MinLength=1 +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$` | [optional] 
+**status** | [**K8sIoApimachineryPkgApisMetaV1ConditionStatus**](K8sIoApimachineryPkgApisMetaV1ConditionStatus.md) | status of the condition, one of True, False, Unknown. +required +kubebuilder:validation:Required +kubebuilder:validation:Enum=True;False;Unknown | [optional] 
+**type** | **str** | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) +required +kubebuilder:validation:Required +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$` +kubebuilder:validation:MaxLength=316 | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_condition import V1Condition
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Condition from a JSON string
+v1_condition_instance = V1Condition.from_json(json)
+# print the JSON string representation of the object
+print(V1Condition.to_json())
+
+# convert the object into a dict
+v1_condition_dict = v1_condition_instance.to_dict()
+# create an instance of V1Condition from a dict
+v1_condition_from_dict = V1Condition.from_dict(v1_condition_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/V1ConfigMapEnvSource.md

@@ -0,0 +1,30 @@
+# V1ConfigMapEnvSource
+
+
+## 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 ConfigMap must be defined +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_config_map_env_source import V1ConfigMapEnvSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ConfigMapEnvSource from a JSON string
+v1_config_map_env_source_instance = V1ConfigMapEnvSource.from_json(json)
+# print the JSON string representation of the object
+print(V1ConfigMapEnvSource.to_json())
+
+# convert the object into a dict
+v1_config_map_env_source_dict = v1_config_map_env_source_instance.to_dict()
+# create an instance of V1ConfigMapEnvSource from a dict
+v1_config_map_env_source_from_dict = V1ConfigMapEnvSource.from_dict(v1_config_map_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/V1ConfigMapKeySelector.md

@@ -0,0 +1,31 @@
+# V1ConfigMapKeySelector
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | The key to select. | [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 ConfigMap or its key must be defined +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_config_map_key_selector import V1ConfigMapKeySelector
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ConfigMapKeySelector from a JSON string
+v1_config_map_key_selector_instance = V1ConfigMapKeySelector.from_json(json)
+# print the JSON string representation of the object
+print(V1ConfigMapKeySelector.to_json())
+
+# convert the object into a dict
+v1_config_map_key_selector_dict = v1_config_map_key_selector_instance.to_dict()
+# create an instance of V1ConfigMapKeySelector from a dict
+v1_config_map_key_selector_from_dict = V1ConfigMapKeySelector.from_dict(v1_config_map_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/V1Container.md

@@ -0,0 +1,52 @@
+# V1Container
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**args** | **List[str]** | Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic | [optional] 
+**command** | **List[str]** | Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic | [optional] 
+**env** | [**List[V1EnvVar]**](V1EnvVar.md) | List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name | [optional] 
+**env_from** | [**List[V1EnvFromSource]**](V1EnvFromSource.md) | List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional +listType=atomic | [optional] 
+**image** | **str** | Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. +optional | [optional] 
+**image_pull_policy** | [**V1PullPolicy**](V1PullPolicy.md) | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images +optional | [optional] 
+**lifecycle** | [**V1Lifecycle**](V1Lifecycle.md) | Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional | [optional] 
+**liveness_probe** | [**V1Probe**](V1Probe.md) | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional | [optional] 
+**name** | **str** | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. | [optional] 
+**ports** | [**List[V1ContainerPort]**](V1ContainerPort.md) | List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol | [optional] 
+**readiness_probe** | [**V1Probe**](V1Probe.md) | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional | [optional] 
+**resize_policy** | [**List[V1ContainerResizePolicy]**](V1ContainerResizePolicy.md) | Resources resize policy for the container. +featureGate=InPlacePodVerticalScaling +optional +listType=atomic | [optional] 
+**resources** | [**V1ResourceRequirements**](V1ResourceRequirements.md) | Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ +optional | [optional] 
+**restart_policy** | [**V1ContainerRestartPolicy**](V1ContainerRestartPolicy.md) | RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. +featureGate=SidecarContainers +optional | [optional] 
+**security_context** | [**V1SecurityContext**](V1SecurityContext.md) | SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +optional | [optional] 
+**startup_probe** | [**V1Probe**](V1Probe.md) | StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional | [optional] 
+**stdin** | **bool** | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional | [optional] 
+**stdin_once** | **bool** | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional | [optional] 
+**termination_message_path** | **str** | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional | [optional] 
+**termination_message_policy** | [**V1TerminationMessagePolicy**](V1TerminationMessagePolicy.md) | Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. +optional | [optional] 
+**tty** | **bool** | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. +optional | [optional] 
+**volume_devices** | [**List[V1VolumeDevice]**](V1VolumeDevice.md) | volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +listType=map +listMapKey=devicePath +optional | [optional] 
+**volume_mounts** | [**List[V1VolumeMount]**](V1VolumeMount.md) | Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath | [optional] 
+**working_dir** | **str** | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_container import V1Container
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Container from a JSON string
+v1_container_instance = V1Container.from_json(json)
+# print the JSON string representation of the object
+print(V1Container.to_json())
+
+# convert the object into a dict
+v1_container_dict = v1_container_instance.to_dict()
+# create an instance of V1Container from a dict
+v1_container_from_dict = V1Container.from_dict(v1_container_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/V1ContainerPort.md

@@ -0,0 +1,33 @@
+# V1ContainerPort
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**container_port** | **int** | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. | [optional] 
+**host_ip** | **str** | What host IP to bind the external port to. +optional | [optional] 
+**host_port** | **int** | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional | [optional] 
+**name** | **str** | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional | [optional] 
+**protocol** | [**V1Protocol**](V1Protocol.md) | Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\". +optional +default=\"TCP\" | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_container_port import V1ContainerPort
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ContainerPort from a JSON string
+v1_container_port_instance = V1ContainerPort.from_json(json)
+# print the JSON string representation of the object
+print(V1ContainerPort.to_json())
+
+# convert the object into a dict
+v1_container_port_dict = v1_container_port_instance.to_dict()
+# create an instance of V1ContainerPort from a dict
+v1_container_port_from_dict = V1ContainerPort.from_dict(v1_container_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/V1ContainerResizePolicy.md

@@ -0,0 +1,30 @@
+# V1ContainerResizePolicy
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource_name** | [**V1ResourceName**](V1ResourceName.md) | Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. | [optional] 
+**restart_policy** | [**V1ResourceResizeRestartPolicy**](V1ResourceResizeRestartPolicy.md) | Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_container_resize_policy import V1ContainerResizePolicy
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1ContainerResizePolicy from a JSON string
+v1_container_resize_policy_instance = V1ContainerResizePolicy.from_json(json)
+# print the JSON string representation of the object
+print(V1ContainerResizePolicy.to_json())
+
+# convert the object into a dict
+v1_container_resize_policy_dict = v1_container_resize_policy_instance.to_dict()
+# create an instance of V1ContainerResizePolicy from a dict
+v1_container_resize_policy_from_dict = V1ContainerResizePolicy.from_dict(v1_container_resize_policy_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/V1ContainerRestartPolicy.md

@@ -0,0 +1,10 @@
+# V1ContainerRestartPolicy
+
+
+## Enum
+
+* `ContainerRestartPolicyAlways` (value: `'Always'`)
+
+[[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/V1Duration.md

@@ -0,0 +1,29 @@
+# V1Duration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_duration** | **int** |  | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_duration import V1Duration
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1Duration from a JSON string
+v1_duration_instance = V1Duration.from_json(json)
+# print the JSON string representation of the object
+print(V1Duration.to_json())
+
+# convert the object into a dict
+v1_duration_dict = v1_duration_instance.to_dict()
+# create an instance of V1Duration from a dict
+v1_duration_from_dict = V1Duration.from_dict(v1_duration_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/V1EnvFromSource.md

@@ -0,0 +1,31 @@
+# V1EnvFromSource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config_map_ref** | [**V1ConfigMapEnvSource**](V1ConfigMapEnvSource.md) | The ConfigMap to select from +optional | [optional] 
+**prefix** | **str** | Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER. +optional | [optional] 
+**secret_ref** | [**V1SecretEnvSource**](V1SecretEnvSource.md) | The Secret to select from +optional | [optional] 
+
+## Example
+
+```python
+from openapi_client.models.v1_env_from_source import V1EnvFromSource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of V1EnvFromSource from a JSON string
+v1_env_from_source_instance = V1EnvFromSource.from_json(json)
+# print the JSON string representation of the object
+print(V1EnvFromSource.to_json())
+
+# convert the object into a dict
+v1_env_from_source_dict = v1_env_from_source_instance.to_dict()
+# create an instance of V1EnvFromSource from a dict
+v1_env_from_source_from_dict = V1EnvFromSource.from_dict(v1_env_from_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)
+
+