From f58f7eddfc370a246f984568a76b0c77d9df45b9 Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Mon, 29 Jul 2024 15:49:47 +0100 Subject: [PATCH 1/8] CH-91 Updated the harness model to add an envmap deprecating the env property --- .gitignore | 3 +- docs/model/ApiTestsConfig.md | 46 ----- docs/model/ApplicationAccountsConfig.md | 44 ----- docs/model/ApplicationConfig.md | 17 -- docs/model/ApplicationDependenciesConfig.md | 72 -------- docs/model/ApplicationHarnessConfig.md | 93 ---------- docs/model/ApplicationProbe.md | 20 --- docs/model/ApplicationTestConfig.md | 17 -- docs/model/ApplicationUser.md | 44 ----- docs/model/ApplicationsConfigsMap.md | 14 -- docs/model/AutoArtifactSpec.md | 16 -- docs/model/BackupConfig.md | 23 --- docs/model/CDCEvent.md | 21 --- docs/model/CDCEventMeta.md | 33 ---- docs/model/CpuMemoryConfig.md | 16 -- docs/model/DatabaseDeploymentConfig.md | 37 ---- docs/model/DeploymentAutoArtifactConfig.md | 33 ---- docs/model/DeploymentResourcesConf.md | 16 -- docs/model/DeploymentVolumeSpec.md | 33 ---- docs/model/E2ETestsConfig.md | 18 -- docs/model/FileResourcesConfig.md | 17 -- docs/model/Filename.md | 9 - docs/model/FreeObject.md | 14 -- docs/model/GitDependencyConfig.md | 19 -- docs/model/HarnessMainConfig.md | 42 ----- docs/model/IngressConfig.md | 43 ----- docs/model/JupyterHubConfig.md | 32 ---- docs/model/NameValue.md | 16 -- docs/model/PathSpecifier.md | 9 - docs/model/Quota.md | 14 -- docs/model/RegistryConfig.md | 16 -- docs/model/ServiceAutoArtifactConfig.md | 29 ---- docs/model/SimpleMap.md | 14 -- docs/model/URL.md | 9 - docs/model/UnitTestsConfig.md | 30 ---- docs/model/UriRoleMappingConfig.md | 32 ---- docs/model/User.md | 129 -------------- docs/model/UserCredential.md | 23 --- docs/model/UserGroup.md | 82 --------- docs/model/UserRole.md | 33 ---- libraries/models/api/openapi.yaml | 92 +++++----- .../cloudharness_model/models/__init__.py | 8 - .../models/api_tests_config.py | 21 +-- .../models/application_accounts_config.py | 13 +- .../models/application_config.py | 9 +- .../models/application_dependencies_config.py | 21 +-- .../models/application_harness_config.py | 89 +++++----- .../models/application_probe.py | 21 +-- .../models/application_test_config.py | 17 +- .../models/application_user.py | 21 +-- .../models/auto_artifact_spec.py | 13 +- .../models/backup_config.py | 41 ++--- .../cloudharness_model/models/base_model.py | 68 ++++++++ .../cloudharness_model/models/cdc_event.py | 25 ++- .../models/cdc_event_meta.py | 33 ++-- .../models/cpu_memory_config.py | 13 +- .../models/database_deployment_config.py | 163 +++++++++--------- .../models/deployment_auto_artifact_config.py | 147 ++++++++-------- .../models/deployment_resources_conf.py | 13 +- .../models/deployment_volume_spec.py | 139 ++++++++------- .../models/e2_e_tests_config.py | 21 +-- .../models/file_resources_config.py | 17 +- .../models/git_dependency_config.py | 17 +- .../models/harness_main_config.py | 99 +++++++---- .../models/ingress_config.py | 127 +++++++------- .../ingress_config_all_of_letsencrypt.py | 9 +- .../models/jupyter_hub_config.py | 21 +-- .../cloudharness_model/models/name_value.py | 13 +- .../models/registry_config.py | 13 +- .../models/service_auto_artifact_config.py | 75 ++++---- .../models/unit_tests_config.py | 13 +- .../models/uri_role_mapping_config.py | 13 +- .../models/cloudharness_model/models/user.py | 81 +++++---- .../models/user_credential.py | 41 ++--- .../cloudharness_model/models/user_group.py | 37 ++-- .../cloudharness_model/models/user_role.py | 33 ++-- .../models/cloudharness_model/typing_utils.py | 2 - libraries/models/tox.ini | 2 +- 78 files changed, 798 insertions(+), 2031 deletions(-) delete mode 100644 docs/model/ApiTestsConfig.md delete mode 100644 docs/model/ApplicationAccountsConfig.md delete mode 100644 docs/model/ApplicationConfig.md delete mode 100644 docs/model/ApplicationDependenciesConfig.md delete mode 100644 docs/model/ApplicationHarnessConfig.md delete mode 100644 docs/model/ApplicationProbe.md delete mode 100644 docs/model/ApplicationTestConfig.md delete mode 100644 docs/model/ApplicationUser.md delete mode 100644 docs/model/ApplicationsConfigsMap.md delete mode 100644 docs/model/AutoArtifactSpec.md delete mode 100644 docs/model/BackupConfig.md delete mode 100644 docs/model/CDCEvent.md delete mode 100644 docs/model/CDCEventMeta.md delete mode 100644 docs/model/CpuMemoryConfig.md delete mode 100644 docs/model/DatabaseDeploymentConfig.md delete mode 100644 docs/model/DeploymentAutoArtifactConfig.md delete mode 100644 docs/model/DeploymentResourcesConf.md delete mode 100644 docs/model/DeploymentVolumeSpec.md delete mode 100644 docs/model/E2ETestsConfig.md delete mode 100644 docs/model/FileResourcesConfig.md delete mode 100644 docs/model/Filename.md delete mode 100644 docs/model/FreeObject.md delete mode 100644 docs/model/GitDependencyConfig.md delete mode 100644 docs/model/HarnessMainConfig.md delete mode 100644 docs/model/IngressConfig.md delete mode 100644 docs/model/JupyterHubConfig.md delete mode 100644 docs/model/NameValue.md delete mode 100644 docs/model/PathSpecifier.md delete mode 100644 docs/model/Quota.md delete mode 100644 docs/model/RegistryConfig.md delete mode 100644 docs/model/ServiceAutoArtifactConfig.md delete mode 100644 docs/model/SimpleMap.md delete mode 100644 docs/model/URL.md delete mode 100644 docs/model/UnitTestsConfig.md delete mode 100644 docs/model/UriRoleMappingConfig.md delete mode 100644 docs/model/User.md delete mode 100644 docs/model/UserCredential.md delete mode 100644 docs/model/UserGroup.md delete mode 100644 docs/model/UserRole.md create mode 100644 libraries/models/cloudharness_model/models/base_model.py diff --git a/.gitignore b/.gitignore index 90f643c0..774c7315 100644 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,5 @@ skaffold.yaml /deployment.yaml .hypothesis __pycache__ -.env \ No newline at end of file +.env +/.venv \ No newline at end of file diff --git a/docs/model/ApiTestsConfig.md b/docs/model/ApiTestsConfig.md deleted file mode 100644 index fab49ebc..00000000 --- a/docs/model/ApiTestsConfig.md +++ /dev/null @@ -1,46 +0,0 @@ -# cloudharness_model.model.api_tests_config.ApiTestsConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[checks](#checks)** | list, tuple, | tuple, | One of the Schemathesis checks: - not_a_server_error. The response has 5xx HTTP status; - status_code_conformance. The response status is not defined in the API schema; - content_type_conformance. The response content type is not defined in the API schema; - response_schema_conformance. The response content does not conform to the schema defined for this specific response; - response_headers_conformance. The response headers does not contain all defined headers. | -**autotest** | bool, | BoolClass, | Specify whether to run the common smoke tests | -**enabled** | bool, | BoolClass, | Enables api tests for this application (default: false) | -**[runParams](#runParams)** | list, tuple, | tuple, | Additional schemathesis parameters | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# checks - -One of the Schemathesis checks: - not_a_server_error. The response has 5xx HTTP status; - status_code_conformance. The response status is not defined in the API schema; - content_type_conformance. The response content type is not defined in the API schema; - response_schema_conformance. The response content does not conform to the schema defined for this specific response; - response_headers_conformance. The response headers does not contain all defined headers. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | One of the Schemathesis checks: - not_a_server_error. The response has 5xx HTTP status; - status_code_conformance. The response status is not defined in the API schema; - content_type_conformance. The response content type is not defined in the API schema; - response_schema_conformance. The response content does not conform to the schema defined for this specific response; - response_headers_conformance. The response headers does not contain all defined headers. | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# runParams - -Additional schemathesis parameters - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Additional schemathesis parameters | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationAccountsConfig.md b/docs/model/ApplicationAccountsConfig.md deleted file mode 100644 index 5cbbdf7d..00000000 --- a/docs/model/ApplicationAccountsConfig.md +++ /dev/null @@ -1,44 +0,0 @@ -# cloudharness_model.model.application_accounts_config.ApplicationAccountsConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[roles](#roles)** | list, tuple, | tuple, | Specify roles to be created in this deployment specific for this application | [optional] -**[users](#users)** | list, tuple, | tuple, | Defines test users to be added to the deployment, specific for this application | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# roles - -Specify roles to be created in this deployment specific for this application - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Specify roles to be created in this deployment specific for this application | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# users - -Defines test users to be added to the deployment, specific for this application - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Defines test users to be added to the deployment, specific for this application | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**ApplicationUser**](ApplicationUser.md) | [**ApplicationUser**](ApplicationUser.md) | [**ApplicationUser**](ApplicationUser.md) | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationConfig.md b/docs/model/ApplicationConfig.md deleted file mode 100644 index 667d4b9a..00000000 --- a/docs/model/ApplicationConfig.md +++ /dev/null @@ -1,17 +0,0 @@ -# cloudharness_model.model.application_config.ApplicationConfig - -Place here the values to configure your application helm templates. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Place here the values to configure your application helm templates. | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**harness** | [**ApplicationHarnessConfig**](ApplicationHarnessConfig.md) | [**ApplicationHarnessConfig**](ApplicationHarnessConfig.md) | | -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationDependenciesConfig.md b/docs/model/ApplicationDependenciesConfig.md deleted file mode 100644 index a59b2cec..00000000 --- a/docs/model/ApplicationDependenciesConfig.md +++ /dev/null @@ -1,72 +0,0 @@ -# cloudharness_model.model.application_dependencies_config.ApplicationDependenciesConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[hard](#hard)** | list, tuple, | tuple, | Hard dependencies indicate that the application may not start without these other applications. | [optional] -**[soft](#soft)** | list, tuple, | tuple, | Soft dependencies indicate that the application will work partially without these other applications. | [optional] -**[build](#build)** | list, tuple, | tuple, | Hard dependencies indicate that the application Docker image build requires these base/common images | [optional] -**[git](#git)** | list, tuple, | tuple, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# hard - -Hard dependencies indicate that the application may not start without these other applications. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Hard dependencies indicate that the application may not start without these other applications. | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# soft - -Soft dependencies indicate that the application will work partially without these other applications. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Soft dependencies indicate that the application will work partially without these other applications. | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# build - -Hard dependencies indicate that the application Docker image build requires these base/common images - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Hard dependencies indicate that the application Docker image build requires these base/common images | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# git - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**GitDependencyConfig**](GitDependencyConfig.md) | [**GitDependencyConfig**](GitDependencyConfig.md) | [**GitDependencyConfig**](GitDependencyConfig.md) | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationHarnessConfig.md b/docs/model/ApplicationHarnessConfig.md deleted file mode 100644 index 8e8a251d..00000000 --- a/docs/model/ApplicationHarnessConfig.md +++ /dev/null @@ -1,93 +0,0 @@ -# cloudharness_model.model.application_harness_config.ApplicationHarnessConfig - -Define helm variables that allow CloudHarness to enable and configure your application's deployment - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Define helm variables that allow CloudHarness to enable and configure your application's deployment | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**deployment** | [**DeploymentAutoArtifactConfig**](DeploymentAutoArtifactConfig.md) | [**DeploymentAutoArtifactConfig**](DeploymentAutoArtifactConfig.md) | | [optional] -**service** | [**ServiceAutoArtifactConfig**](ServiceAutoArtifactConfig.md) | [**ServiceAutoArtifactConfig**](ServiceAutoArtifactConfig.md) | | [optional] -**subdomain** | str, | str, | If specified, an ingress will be created at [subdomain].[.Values.domain] | [optional] -**[aliases](#aliases)** | list, tuple, | tuple, | If specified, an ingress will be created at [alias].[.Values.domain] for each alias | [optional] -**domain** | str, | str, | If specified, an ingress will be created at [domain] | [optional] -**dependencies** | [**ApplicationDependenciesConfig**](ApplicationDependenciesConfig.md) | [**ApplicationDependenciesConfig**](ApplicationDependenciesConfig.md) | | [optional] -**secured** | bool, | BoolClass, | When true, the application is shielded with a getekeeper | [optional] -**[uri_role_mapping](#uri_role_mapping)** | list, tuple, | tuple, | Map uri/roles to secure with the Gatekeeper (if `secured: true`) | [optional] -**secrets** | [**SimpleMap**](SimpleMap.md) | [**SimpleMap**](SimpleMap.md) | | [optional] -**[use_services](#use_services)** | list, tuple, | tuple, | Specify which services this application uses in the frontend to create proxy ingresses. e.g. ``` - name: samples ``` | [optional] -**database** | [**DatabaseDeploymentConfig**](DatabaseDeploymentConfig.md) | [**DatabaseDeploymentConfig**](DatabaseDeploymentConfig.md) | | [optional] -**[resources](#resources)** | list, tuple, | tuple, | Application file resources. Maps from deploy/resources folder and mounts as configmaps | [optional] -**readinessProbe** | [**ApplicationProbe**](ApplicationProbe.md) | [**ApplicationProbe**](ApplicationProbe.md) | | [optional] -**startupProbe** | [**ApplicationProbe**](ApplicationProbe.md) | [**ApplicationProbe**](ApplicationProbe.md) | | [optional] -**livenessProbe** | [**ApplicationProbe**](ApplicationProbe.md) | [**ApplicationProbe**](ApplicationProbe.md) | | [optional] -**sourceRoot** | [**Filename**](Filename.md) | [**Filename**](Filename.md) | | [optional] -**name** | str, | str, | Application's name. Do not edit, the value is automatically set from the application directory's name | [optional] -**jupyterhub** | [**JupyterHubConfig**](JupyterHubConfig.md) | [**JupyterHubConfig**](JupyterHubConfig.md) | | [optional] -**accounts** | [**ApplicationAccountsConfig**](ApplicationAccountsConfig.md) | [**ApplicationAccountsConfig**](ApplicationAccountsConfig.md) | | [optional] -**test** | [**ApplicationTestConfig**](ApplicationTestConfig.md) | [**ApplicationTestConfig**](ApplicationTestConfig.md) | | [optional] -**quotas** | [**Quota**](Quota.md) | [**Quota**](Quota.md) | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# aliases - -If specified, an ingress will be created at [alias].[.Values.domain] for each alias - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | If specified, an ingress will be created at [alias].[.Values.domain] for each alias | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# uri_role_mapping - -Map uri/roles to secure with the Gatekeeper (if `secured: true`) - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Map uri/roles to secure with the Gatekeeper (if `secured: true`) | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**UriRoleMappingConfig**](UriRoleMappingConfig.md) | [**UriRoleMappingConfig**](UriRoleMappingConfig.md) | [**UriRoleMappingConfig**](UriRoleMappingConfig.md) | | - -# use_services - -Specify which services this application uses in the frontend to create proxy ingresses. e.g. ``` - name: samples ``` - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Specify which services this application uses in the frontend to create proxy ingresses. e.g. ``` - name: samples ``` | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# resources - -Application file resources. Maps from deploy/resources folder and mounts as configmaps - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Application file resources. Maps from deploy/resources folder and mounts as configmaps | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**FileResourcesConfig**](FileResourcesConfig.md) | [**FileResourcesConfig**](FileResourcesConfig.md) | [**FileResourcesConfig**](FileResourcesConfig.md) | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationProbe.md b/docs/model/ApplicationProbe.md deleted file mode 100644 index a3375c46..00000000 --- a/docs/model/ApplicationProbe.md +++ /dev/null @@ -1,20 +0,0 @@ -# cloudharness_model.model.application_probe.ApplicationProbe - -Define a Kubernetes probe See also the [official documentation](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Define a Kubernetes probe See also the [official documentation](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**path** | str, | str, | | -**periodSeconds** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] -**failureThreshold** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] -**initialDelaySeconds** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationTestConfig.md b/docs/model/ApplicationTestConfig.md deleted file mode 100644 index 96aced5a..00000000 --- a/docs/model/ApplicationTestConfig.md +++ /dev/null @@ -1,17 +0,0 @@ -# cloudharness_model.model.application_test_config.ApplicationTestConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**unit** | [**UnitTestsConfig**](UnitTestsConfig.md) | [**UnitTestsConfig**](UnitTestsConfig.md) | | -**e2e** | [**E2ETestsConfig**](E2ETestsConfig.md) | [**E2ETestsConfig**](E2ETestsConfig.md) | | -**api** | [**ApiTestsConfig**](ApiTestsConfig.md) | [**ApiTestsConfig**](ApiTestsConfig.md) | | -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationUser.md b/docs/model/ApplicationUser.md deleted file mode 100644 index c55a18e8..00000000 --- a/docs/model/ApplicationUser.md +++ /dev/null @@ -1,44 +0,0 @@ -# cloudharness_model.model.application_user.ApplicationUser - -Defines a user - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Defines a user | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**username** | str, | str, | | -**password** | str, | str, | | [optional] -**[clientRoles](#clientRoles)** | list, tuple, | tuple, | | [optional] -**[realmRoles](#realmRoles)** | list, tuple, | tuple, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# clientRoles - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# realmRoles - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ApplicationsConfigsMap.md b/docs/model/ApplicationsConfigsMap.md deleted file mode 100644 index 7bfc31e5..00000000 --- a/docs/model/ApplicationsConfigsMap.md +++ /dev/null @@ -1,14 +0,0 @@ -# cloudharness_model.model.applications_configs_map.ApplicationsConfigsMap - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | [**ApplicationConfig**](ApplicationConfig.md) | [**ApplicationConfig**](ApplicationConfig.md) | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/AutoArtifactSpec.md b/docs/model/AutoArtifactSpec.md deleted file mode 100644 index 7d149b70..00000000 --- a/docs/model/AutoArtifactSpec.md +++ /dev/null @@ -1,16 +0,0 @@ -# cloudharness_model.model.auto_artifact_spec.AutoArtifactSpec - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**auto** | bool, | BoolClass, | When true, enables automatic template | -**name** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/BackupConfig.md b/docs/model/BackupConfig.md deleted file mode 100644 index 29cbce3b..00000000 --- a/docs/model/BackupConfig.md +++ /dev/null @@ -1,23 +0,0 @@ -# cloudharness_model.model.backup_config.BackupConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**resources** | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | | -**dir** | [**Filename**](Filename.md) | [**Filename**](Filename.md) | | -**active** | bool, | BoolClass, | | [optional] -**keep_days** | decimal.Decimal, int, | decimal.Decimal, | | [optional] -**keep_weeks** | decimal.Decimal, int, | decimal.Decimal, | | [optional] -**keep_months** | decimal.Decimal, int, | decimal.Decimal, | | [optional] -**schedule** | str, | str, | Cron expression | [optional] -**suffix** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The file suffix added to backup files | [optional] -**volumesize** | str, | str, | The volume size for backups (all backups share the same volume) | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/CDCEvent.md b/docs/model/CDCEvent.md deleted file mode 100644 index c33e1081..00000000 --- a/docs/model/CDCEvent.md +++ /dev/null @@ -1,21 +0,0 @@ -# cloudharness_model.model.cdc_event.CDCEvent - -A message sent to the orchestration queue. Applications can listen to these events to react to data change events happening on other applications. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | A message sent to the orchestration queue. Applications can listen to these events to react to data change events happening on other applications. | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**uid** | str, | str, | the unique identifier attribute of the object | -**meta** | [**CDCEventMeta**](CDCEventMeta.md) | [**CDCEventMeta**](CDCEventMeta.md) | | -**message_type** | str, | str, | the type of the message (relates to the object type) e.g. jobs | -**operation** | str, | str, | the operation on the object e.g. create / update / delete | must be one of ["create", "update", "delete", "other", ] -**resource** | [**FreeObject**](FreeObject.md) | [**FreeObject**](FreeObject.md) | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/CDCEventMeta.md b/docs/model/CDCEventMeta.md deleted file mode 100644 index 747246d3..00000000 --- a/docs/model/CDCEventMeta.md +++ /dev/null @@ -1,33 +0,0 @@ -# cloudharness_model.model.cdc_event_meta.CDCEventMeta - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**app_name** | str, | str, | The name of the application/microservice sending the message | -**user** | [**User**](User.md) | [**User**](User.md) | | [optional] -**[args](#args)** | list, tuple, | tuple, | the caller function arguments | [optional] -**kwargs** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | the caller function keyword arguments | [optional] -**description** | str, | str, | General description -- for human consumption | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# args - -the caller function arguments - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | the caller function arguments | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**FreeObject**](FreeObject.md) | [**FreeObject**](FreeObject.md) | [**FreeObject**](FreeObject.md) | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/CpuMemoryConfig.md b/docs/model/CpuMemoryConfig.md deleted file mode 100644 index f64cd7d3..00000000 --- a/docs/model/CpuMemoryConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# cloudharness_model.model.cpu_memory_config.CpuMemoryConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**cpu** | str, | str, | | [optional] -**memory** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/DatabaseDeploymentConfig.md b/docs/model/DatabaseDeploymentConfig.md deleted file mode 100644 index 864d5ef1..00000000 --- a/docs/model/DatabaseDeploymentConfig.md +++ /dev/null @@ -1,37 +0,0 @@ -# cloudharness_model.model.database_deployment_config.DatabaseDeploymentConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Composed Schemas (allOf/anyOf/oneOf/not) -#### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | -[AutoArtifactSpec](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | | - -# all_of_0 - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**type** | str, | str, | Define the database type. One of (mongo, postgres, neo4j, sqlite3) | [optional] -**size** | str, | str, | Specify database disk size | [optional] -**user** | str, | str, | database username | [optional] -**pass** | str, | str, | Database password | [optional] -**image_ref** | str, | str, | Used for referencing images from the build | [optional] -**mongo** | [**FreeObject**](FreeObject.md) | [**FreeObject**](FreeObject.md) | | [optional] -**postgres** | [**FreeObject**](FreeObject.md) | [**FreeObject**](FreeObject.md) | | [optional] -**neo4j** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Neo4j database specific configuration | [optional] -**resources** | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/DeploymentAutoArtifactConfig.md b/docs/model/DeploymentAutoArtifactConfig.md deleted file mode 100644 index 4367e949..00000000 --- a/docs/model/DeploymentAutoArtifactConfig.md +++ /dev/null @@ -1,33 +0,0 @@ -# cloudharness_model.model.deployment_auto_artifact_config.DeploymentAutoArtifactConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Composed Schemas (allOf/anyOf/oneOf/not) -#### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | -[AutoArtifactSpec](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | | - -# all_of_0 - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**port** | str, | str, | Deployment port | [optional] -**replicas** | decimal.Decimal, int, | decimal.Decimal, | Number of replicas | [optional] -**image** | str, | str, | Image name to use in the deployment. Leave it blank to set from the application's Docker file | [optional] -**resources** | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | | [optional] -**volume** | [**DeploymentVolumeSpec**](DeploymentVolumeSpec.md) | [**DeploymentVolumeSpec**](DeploymentVolumeSpec.md) | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/DeploymentResourcesConf.md b/docs/model/DeploymentResourcesConf.md deleted file mode 100644 index 6ca517a3..00000000 --- a/docs/model/DeploymentResourcesConf.md +++ /dev/null @@ -1,16 +0,0 @@ -# cloudharness_model.model.deployment_resources_conf.DeploymentResourcesConf - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**requests** | [**CpuMemoryConfig**](CpuMemoryConfig.md) | [**CpuMemoryConfig**](CpuMemoryConfig.md) | | [optional] -**limits** | [**CpuMemoryConfig**](CpuMemoryConfig.md) | [**CpuMemoryConfig**](CpuMemoryConfig.md) | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/DeploymentVolumeSpec.md b/docs/model/DeploymentVolumeSpec.md deleted file mode 100644 index 14900102..00000000 --- a/docs/model/DeploymentVolumeSpec.md +++ /dev/null @@ -1,33 +0,0 @@ -# cloudharness_model.model.deployment_volume_spec.DeploymentVolumeSpec - -Defines a volume attached to the deployment. Automatically created the volume claim and mounts. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Defines a volume attached to the deployment. Automatically created the volume claim and mounts. | - -### Composed Schemas (allOf/anyOf/oneOf/not) -#### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | -[AutoArtifactSpec](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | | - -# all_of_0 - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**mountpath** | str, | str, | The mount path for the volume | -**size** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The volume size. E.g. 5Gi | [optional] -**usenfs** | bool, | BoolClass, | Set to `true` to use the nfs on the created volume and mount as ReadWriteMany. | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/E2ETestsConfig.md b/docs/model/E2ETestsConfig.md deleted file mode 100644 index 8b7383d1..00000000 --- a/docs/model/E2ETestsConfig.md +++ /dev/null @@ -1,18 +0,0 @@ -# cloudharness_model.model.e2_e_tests_config.E2ETestsConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**smoketest** | bool, | BoolClass, | Specify whether to run the common smoke tests | -**enabled** | bool, | BoolClass, | Enables end to end testing for this application (default: false) | -**ignoreConsoleErrors** | bool, | BoolClass, | | [optional] -**ignoreRequestErrors** | bool, | BoolClass, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/FileResourcesConfig.md b/docs/model/FileResourcesConfig.md deleted file mode 100644 index 6936d87c..00000000 --- a/docs/model/FileResourcesConfig.md +++ /dev/null @@ -1,17 +0,0 @@ -# cloudharness_model.model.file_resources_config.FileResourcesConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**dst** | str, | str, | | -**src** | [**Filename**](Filename.md) | [**Filename**](Filename.md) | | -**name** | [**Filename**](Filename.md) | [**Filename**](Filename.md) | | -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/Filename.md b/docs/model/Filename.md deleted file mode 100644 index ccbf7b0e..00000000 --- a/docs/model/Filename.md +++ /dev/null @@ -1,9 +0,0 @@ -# cloudharness_model.model.filename.Filename - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/FreeObject.md b/docs/model/FreeObject.md deleted file mode 100644 index e131e846..00000000 --- a/docs/model/FreeObject.md +++ /dev/null @@ -1,14 +0,0 @@ -# cloudharness_model.model.free_object.FreeObject - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/GitDependencyConfig.md b/docs/model/GitDependencyConfig.md deleted file mode 100644 index 5faef206..00000000 --- a/docs/model/GitDependencyConfig.md +++ /dev/null @@ -1,19 +0,0 @@ -# cloudharness_model.model.git_dependency_config.GitDependencyConfig - -Defines a git repo to be cloned inside the application path - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Defines a git repo to be cloned inside the application path | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**branch_tag** | str, | str, | | -**url** | str, | str, | | -**path** | str, | str, | Defines the path where the repo is cloned. default: /git | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/HarnessMainConfig.md b/docs/model/HarnessMainConfig.md deleted file mode 100644 index fc0f29da..00000000 --- a/docs/model/HarnessMainConfig.md +++ /dev/null @@ -1,42 +0,0 @@ -# cloudharness_model.model.harness_main_config.HarnessMainConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**mainapp** | str, | str, | Defines the app to map to the root domain | -**domain** | str, | str, | The root domain | -**namespace** | str, | str, | The K8s namespace. | -**secured_gatekeepers** | bool, | BoolClass, | Enables/disables Gatekeepers on secured applications. Set to false for testing/development | -**local** | bool, | BoolClass, | If set to true, local DNS mapping is added to pods. | -**apps** | [**ApplicationsConfigsMap**](ApplicationsConfigsMap.md) | [**ApplicationsConfigsMap**](ApplicationsConfigsMap.md) | | -**registry** | [**RegistryConfig**](RegistryConfig.md) | [**RegistryConfig**](RegistryConfig.md) | | [optional] -**tag** | str, | str, | Docker tag used to push/pull the built images. | [optional] -**[env](#env)** | list, tuple, | tuple, | Environmental variables added to all pods | [optional] -**privenv** | [**NameValue**](NameValue.md) | [**NameValue**](NameValue.md) | | [optional] -**backup** | [**BackupConfig**](BackupConfig.md) | [**BackupConfig**](BackupConfig.md) | | [optional] -**name** | str, | str, | Base name | [optional] -**task-images** | [**SimpleMap**](SimpleMap.md) | [**SimpleMap**](SimpleMap.md) | | [optional] -**build_hash** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# env - -Environmental variables added to all pods - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Environmental variables added to all pods | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**NameValue**](NameValue.md) | [**NameValue**](NameValue.md) | [**NameValue**](NameValue.md) | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/IngressConfig.md b/docs/model/IngressConfig.md deleted file mode 100644 index fcdc67ea..00000000 --- a/docs/model/IngressConfig.md +++ /dev/null @@ -1,43 +0,0 @@ -# cloudharness_model.model.ingress_config.IngressConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Composed Schemas (allOf/anyOf/oneOf/not) -#### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | -[AutoArtifactSpec](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | | - -# all_of_0 - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**ssl_redirect** | bool, | BoolClass, | | [optional] -**[letsencrypt](#letsencrypt)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# letsencrypt - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**email** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/JupyterHubConfig.md b/docs/model/JupyterHubConfig.md deleted file mode 100644 index 59ac9c84..00000000 --- a/docs/model/JupyterHubConfig.md +++ /dev/null @@ -1,32 +0,0 @@ -# cloudharness_model.model.jupyter_hub_config.JupyterHubConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[args](#args)** | list, tuple, | tuple, | arguments passed to the container | [optional] -**extraConfig** | [**SimpleMap**](SimpleMap.md) | [**SimpleMap**](SimpleMap.md) | | [optional] -**spawnerExtraConfig** | [**FreeObject**](FreeObject.md) | [**FreeObject**](FreeObject.md) | | [optional] -**applicationHook** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | change the hook function (advanced) Specify the Python name of the function (full module path, the module must be installed in the Docker image) | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# args - -arguments passed to the container - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | arguments passed to the container | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/NameValue.md b/docs/model/NameValue.md deleted file mode 100644 index deb57553..00000000 --- a/docs/model/NameValue.md +++ /dev/null @@ -1,16 +0,0 @@ -# cloudharness_model.model.name_value.NameValue - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**name** | str, | str, | | -**value** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/PathSpecifier.md b/docs/model/PathSpecifier.md deleted file mode 100644 index e8062e36..00000000 --- a/docs/model/PathSpecifier.md +++ /dev/null @@ -1,9 +0,0 @@ -# cloudharness_model.model.path_specifier.PathSpecifier - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/Quota.md b/docs/model/Quota.md deleted file mode 100644 index 8124fe92..00000000 --- a/docs/model/Quota.md +++ /dev/null @@ -1,14 +0,0 @@ -# cloudharness_model.model.quota.Quota - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/RegistryConfig.md b/docs/model/RegistryConfig.md deleted file mode 100644 index c63d22b6..00000000 --- a/docs/model/RegistryConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# cloudharness_model.model.registry_config.RegistryConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**name** | str, | str, | | -**secret** | str, | str, | Optional secret used for pulling from docker registry. | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/ServiceAutoArtifactConfig.md b/docs/model/ServiceAutoArtifactConfig.md deleted file mode 100644 index 6ac6050c..00000000 --- a/docs/model/ServiceAutoArtifactConfig.md +++ /dev/null @@ -1,29 +0,0 @@ -# cloudharness_model.model.service_auto_artifact_config.ServiceAutoArtifactConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Composed Schemas (allOf/anyOf/oneOf/not) -#### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | | -[AutoArtifactSpec](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | [**AutoArtifactSpec**](AutoArtifactSpec.md) | | - -# all_of_0 - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**port** | decimal.Decimal, int, | decimal.Decimal, | Service port | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/SimpleMap.md b/docs/model/SimpleMap.md deleted file mode 100644 index 37074b56..00000000 --- a/docs/model/SimpleMap.md +++ /dev/null @@ -1,14 +0,0 @@ -# cloudharness_model.model.simple_map.SimpleMap - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/URL.md b/docs/model/URL.md deleted file mode 100644 index ac2bc6d8..00000000 --- a/docs/model/URL.md +++ /dev/null @@ -1,9 +0,0 @@ -# cloudharness_model.model.url.URL - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/UnitTestsConfig.md b/docs/model/UnitTestsConfig.md deleted file mode 100644 index 1c2f16d6..00000000 --- a/docs/model/UnitTestsConfig.md +++ /dev/null @@ -1,30 +0,0 @@ -# cloudharness_model.model.unit_tests_config.UnitTestsConfig - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[commands](#commands)** | list, tuple, | tuple, | Commands to run unit tests | -**enabled** | bool, | BoolClass, | Enables unit tests for this application (default: true) | -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# commands - -Commands to run unit tests - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Commands to run unit tests | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/UriRoleMappingConfig.md b/docs/model/UriRoleMappingConfig.md deleted file mode 100644 index ff645e73..00000000 --- a/docs/model/UriRoleMappingConfig.md +++ /dev/null @@ -1,32 +0,0 @@ -# cloudharness_model.model.uri_role_mapping_config.UriRoleMappingConfig - -Defines the application Gatekeeper configuration, if enabled (i.e. `secured: true`. - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | Defines the application Gatekeeper configuration, if enabled (i.e. `secured: true`. | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[roles](#roles)** | list, tuple, | tuple, | Roles allowed to access the present uri | -**uri** | [**PathSpecifier**](PathSpecifier.md) | [**PathSpecifier**](PathSpecifier.md) | | -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# roles - -Roles allowed to access the present uri - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | Roles allowed to access the present uri | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/User.md b/docs/model/User.md deleted file mode 100644 index cd49ceaa..00000000 --- a/docs/model/User.md +++ /dev/null @@ -1,129 +0,0 @@ -# cloudharness_model.model.user.User - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[access](#access)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**[clientRoles](#clientRoles)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**createdTimestamp** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer -**[credentials](#credentials)** | list, tuple, | tuple, | | [optional] -**[disableableCredentialTypes](#disableableCredentialTypes)** | list, tuple, | tuple, | | [optional] -**email** | str, | str, | | [optional] -**emailVerified** | bool, | BoolClass, | | [optional] -**enabled** | bool, | BoolClass, | | [optional] -**federationLink** | str, | str, | | [optional] -**firstName** | str, | str, | | [optional] -**[groups](#groups)** | list, tuple, | tuple, | | [optional] -**id** | str, | str, | | [optional] -**lastName** | str, | str, | | [optional] -**[realmRoles](#realmRoles)** | list, tuple, | tuple, | | [optional] -**[requiredActions](#requiredActions)** | list, tuple, | tuple, | | [optional] -**serviceAccountClientId** | str, | str, | | [optional] -**username** | str, | str, | | [optional] -**additionalProperties** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# access - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# attributes - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# clientRoles - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# credentials - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**UserCredential**](UserCredential.md) | [**UserCredential**](UserCredential.md) | [**UserCredential**](UserCredential.md) | | - -# disableableCredentialTypes - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# groups - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# realmRoles - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# requiredActions - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/UserCredential.md b/docs/model/UserCredential.md deleted file mode 100644 index d29edc20..00000000 --- a/docs/model/UserCredential.md +++ /dev/null @@ -1,23 +0,0 @@ -# cloudharness_model.model.user_credential.UserCredential - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**createdDate** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer -**credentialData** | str, | str, | | [optional] -**id** | str, | str, | | [optional] -**priority** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer -**secretData** | str, | str, | | [optional] -**temporary** | bool, | BoolClass, | | [optional] -**type** | str, | str, | | [optional] -**userLabel** | str, | str, | | [optional] -**value** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/UserGroup.md b/docs/model/UserGroup.md deleted file mode 100644 index 87aee711..00000000 --- a/docs/model/UserGroup.md +++ /dev/null @@ -1,82 +0,0 @@ -# cloudharness_model.model.user_group.UserGroup - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[access](#access)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**[clientRoles](#clientRoles)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**id** | str, | str, | | [optional] -**name** | str, | str, | | [optional] -**path** | str, | str, | | [optional] -**[realmRoles](#realmRoles)** | list, tuple, | tuple, | | [optional] -**[subGroups](#subGroups)** | list, tuple, | tuple, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# access - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# attributes - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# clientRoles - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# realmRoles - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str, | str, | | - -# subGroups - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple, | tuple, | | - -### Tuple Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[**UserGroup**](UserGroup.md) | [**UserGroup**](UserGroup.md) | [**UserGroup**](UserGroup.md) | | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/docs/model/UserRole.md b/docs/model/UserRole.md deleted file mode 100644 index ba0d5fe0..00000000 --- a/docs/model/UserRole.md +++ /dev/null @@ -1,33 +0,0 @@ -# cloudharness_model.model.user_role.UserRole - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**[attributes](#attributes)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional] -**clientRole** | bool, | BoolClass, | | [optional] -**composite** | bool, | BoolClass, | | [optional] -**containerId** | str, | str, | | [optional] -**description** | str, | str, | | [optional] -**id** | str, | str, | | [optional] -**name** | str, | str, | | [optional] -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -# attributes - -## Model Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, | frozendict.frozendict, | | - -### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - diff --git a/libraries/models/api/openapi.yaml b/libraries/models/api/openapi.yaml index 8b961031..3b115091 100644 --- a/libraries/models/api/openapi.yaml +++ b/libraries/models/api/openapi.yaml @@ -163,49 +163,6 @@ components: description: '' type: object additionalProperties: true - DatabaseDeploymentConfig: - description: '' - type: object - allOf: - - - type: object - properties: - type: - description: |- - Define the database type. - - One of (mongo, postgres, neo4j, sqlite3) - pattern: ^(mongo|postgres|neo4j|sqlite3)$ - type: string - example: '"neo4j"' - size: - description: Specify database disk size - type: string - example: 1Gi - user: - description: database username - type: string - pass: - format: password - description: Database password - type: string - image_ref: - description: Used for referencing images from the build - type: string - example: 'image_ref: myownpgimage' - mongo: - $ref: '#/components/schemas/FreeObject' - description: Mongo db specific configuration - postgres: - $ref: '#/components/schemas/FreeObject' - description: Postgres database specific configuration - neo4j: - description: Neo4j database specific configuration - resources: - $ref: '#/components/schemas/DeploymentResourcesConf' - description: Database deployment resources - - - $ref: '#/components/schemas/AutoArtifactSpec' ApplicationsConfigsMap: description: '' type: object @@ -823,7 +780,7 @@ components: $ref: '#/components/schemas/ApplicationsConfigsMap' description: '' env: - description: Environmental variables added to all pods + description: 'Environmental variables added to all pods (deprecated, please use envmap)' type: array items: $ref: '#/components/schemas/NameValue' @@ -842,6 +799,9 @@ components: build_hash: description: '' type: string + envmap: + $ref: '#/components/schemas/SimpleMap' + description: Environmental variables added to all pods additionalProperties: true SimpleMap: description: '' @@ -873,3 +833,47 @@ components: url: 'https://github.com/MetaCell/nwb-explorer.git' branch_tag: master path: /git + DatabaseDeploymentConfig: + description: '' + type: object + allOf: + - + type: object + properties: + type: + description: |- + Define the database type. + + One of (mongo, postgres, neo4j, sqlite3) + pattern: ^(mongo|postgres|neo4j|sqlite3)$ + type: string + example: '"neo4j"' + size: + description: Specify database disk size + type: string + example: 1Gi + user: + description: database username + type: string + pass: + format: password + description: Database password + type: string + image_ref: + description: Used for referencing images from the build + type: string + example: 'image_ref: myownpgimage' + mongo: + $ref: '#/components/schemas/FreeObject' + description: Mongo db specific configuration + postgres: + $ref: '#/components/schemas/FreeObject' + description: Postgres database specific configuration + neo4j: + description: Neo4j database specific configuration + resources: + $ref: '#/components/schemas/DeploymentResourcesConf' + description: Database deployment resources + - + $ref: '#/components/schemas/AutoArtifactSpec' + additionalAttributes: true diff --git a/libraries/models/cloudharness_model/models/__init__.py b/libraries/models/cloudharness_model/models/__init__.py index dbfb1175..488c3e6f 100644 --- a/libraries/models/cloudharness_model/models/__init__.py +++ b/libraries/models/cloudharness_model/models/__init__.py @@ -1,7 +1,4 @@ -# coding: utf-8 - # flake8: noqa -from __future__ import absolute_import # import models into model package from cloudharness_model.models.api_tests_config import ApiTestsConfig from cloudharness_model.models.application_accounts_config import ApplicationAccountsConfig @@ -17,24 +14,19 @@ from cloudharness_model.models.cdc_event_meta import CDCEventMeta from cloudharness_model.models.cpu_memory_config import CpuMemoryConfig from cloudharness_model.models.database_deployment_config import DatabaseDeploymentConfig -from cloudharness_model.models.database_deployment_config_all_of import DatabaseDeploymentConfigAllOf from cloudharness_model.models.deployment_auto_artifact_config import DeploymentAutoArtifactConfig -from cloudharness_model.models.deployment_auto_artifact_config_all_of import DeploymentAutoArtifactConfigAllOf from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf from cloudharness_model.models.deployment_volume_spec import DeploymentVolumeSpec -from cloudharness_model.models.deployment_volume_spec_all_of import DeploymentVolumeSpecAllOf from cloudharness_model.models.e2_e_tests_config import E2ETestsConfig from cloudharness_model.models.file_resources_config import FileResourcesConfig from cloudharness_model.models.git_dependency_config import GitDependencyConfig from cloudharness_model.models.harness_main_config import HarnessMainConfig from cloudharness_model.models.ingress_config import IngressConfig -from cloudharness_model.models.ingress_config_all_of import IngressConfigAllOf from cloudharness_model.models.ingress_config_all_of_letsencrypt import IngressConfigAllOfLetsencrypt from cloudharness_model.models.jupyter_hub_config import JupyterHubConfig from cloudharness_model.models.name_value import NameValue from cloudharness_model.models.registry_config import RegistryConfig from cloudharness_model.models.service_auto_artifact_config import ServiceAutoArtifactConfig -from cloudharness_model.models.service_auto_artifact_config_all_of import ServiceAutoArtifactConfigAllOf from cloudharness_model.models.unit_tests_config import UnitTestsConfig from cloudharness_model.models.uri_role_mapping_config import UriRoleMappingConfig from cloudharness_model.models.user import User diff --git a/libraries/models/cloudharness_model/models/api_tests_config.py b/libraries/models/cloudharness_model/models/api_tests_config.py index d5b2bdf6..a4476c08 100644 --- a/libraries/models/cloudharness_model/models/api_tests_config.py +++ b/libraries/models/cloudharness_model/models/api_tests_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -58,7 +55,7 @@ def from_dict(cls, dikt) -> 'ApiTestsConfig': return util.deserialize_model(dikt, cls) @property - def enabled(self): + def enabled(self) -> bool: """Gets the enabled of this ApiTestsConfig. Enables api tests for this application (default: false) # noqa: E501 @@ -69,7 +66,7 @@ def enabled(self): return self._enabled @enabled.setter - def enabled(self, enabled): + def enabled(self, enabled: bool): """Sets the enabled of this ApiTestsConfig. Enables api tests for this application (default: false) # noqa: E501 @@ -83,7 +80,7 @@ def enabled(self, enabled): self._enabled = enabled @property - def autotest(self): + def autotest(self) -> bool: """Gets the autotest of this ApiTestsConfig. Specify whether to run the common smoke tests # noqa: E501 @@ -94,7 +91,7 @@ def autotest(self): return self._autotest @autotest.setter - def autotest(self, autotest): + def autotest(self, autotest: bool): """Sets the autotest of this ApiTestsConfig. Specify whether to run the common smoke tests # noqa: E501 @@ -108,7 +105,7 @@ def autotest(self, autotest): self._autotest = autotest @property - def run_params(self): + def run_params(self) -> List[str]: """Gets the run_params of this ApiTestsConfig. Additional schemathesis parameters # noqa: E501 @@ -119,7 +116,7 @@ def run_params(self): return self._run_params @run_params.setter - def run_params(self, run_params): + def run_params(self, run_params: List[str]): """Sets the run_params of this ApiTestsConfig. Additional schemathesis parameters # noqa: E501 @@ -131,7 +128,7 @@ def run_params(self, run_params): self._run_params = run_params @property - def checks(self): + def checks(self) -> List[str]: """Gets the checks of this ApiTestsConfig. One of the Schemathesis checks: - not_a_server_error. The response has 5xx HTTP status; - status_code_conformance. The response status is not defined in the API schema; - content_type_conformance. The response content type is not defined in the API schema; - response_schema_conformance. The response content does not conform to the schema defined for this specific response; - response_headers_conformance. The response headers does not contain all defined headers. # noqa: E501 @@ -142,7 +139,7 @@ def checks(self): return self._checks @checks.setter - def checks(self, checks): + def checks(self, checks: List[str]): """Sets the checks of this ApiTestsConfig. One of the Schemathesis checks: - not_a_server_error. The response has 5xx HTTP status; - status_code_conformance. The response status is not defined in the API schema; - content_type_conformance. The response content type is not defined in the API schema; - response_schema_conformance. The response content does not conform to the schema defined for this specific response; - response_headers_conformance. The response headers does not contain all defined headers. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/application_accounts_config.py b/libraries/models/cloudharness_model/models/application_accounts_config.py index 082f6853..9a97db85 100644 --- a/libraries/models/cloudharness_model/models/application_accounts_config.py +++ b/libraries/models/cloudharness_model/models/application_accounts_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.application_user import ApplicationUser from cloudharness_model import util @@ -50,7 +47,7 @@ def from_dict(cls, dikt) -> 'ApplicationAccountsConfig': return util.deserialize_model(dikt, cls) @property - def roles(self): + def roles(self) -> List[str]: """Gets the roles of this ApplicationAccountsConfig. Specify roles to be created in this deployment specific for this application # noqa: E501 @@ -61,7 +58,7 @@ def roles(self): return self._roles @roles.setter - def roles(self, roles): + def roles(self, roles: List[str]): """Sets the roles of this ApplicationAccountsConfig. Specify roles to be created in this deployment specific for this application # noqa: E501 @@ -73,7 +70,7 @@ def roles(self, roles): self._roles = roles @property - def users(self): + def users(self) -> List[ApplicationUser]: """Gets the users of this ApplicationAccountsConfig. Defines test users to be added to the deployment, specific for this application # noqa: E501 @@ -84,7 +81,7 @@ def users(self): return self._users @users.setter - def users(self, users): + def users(self, users: List[ApplicationUser]): """Sets the users of this ApplicationAccountsConfig. Defines test users to be added to the deployment, specific for this application # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/application_config.py b/libraries/models/cloudharness_model/models/application_config.py index 2ea86d6e..f423ee3b 100644 --- a/libraries/models/cloudharness_model/models/application_config.py +++ b/libraries/models/cloudharness_model/models/application_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.application_harness_config import ApplicationHarnessConfig from cloudharness_model import util @@ -45,7 +42,7 @@ def from_dict(cls, dikt) -> 'ApplicationConfig': return util.deserialize_model(dikt, cls) @property - def harness(self): + def harness(self) -> ApplicationHarnessConfig: """Gets the harness of this ApplicationConfig. @@ -55,7 +52,7 @@ def harness(self): return self._harness @harness.setter - def harness(self, harness): + def harness(self, harness: ApplicationHarnessConfig): """Sets the harness of this ApplicationConfig. diff --git a/libraries/models/cloudharness_model/models/application_dependencies_config.py b/libraries/models/cloudharness_model/models/application_dependencies_config.py index 7f4df0ba..a09df86f 100644 --- a/libraries/models/cloudharness_model/models/application_dependencies_config.py +++ b/libraries/models/cloudharness_model/models/application_dependencies_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.git_dependency_config import GitDependencyConfig from cloudharness_model import util @@ -60,7 +57,7 @@ def from_dict(cls, dikt) -> 'ApplicationDependenciesConfig': return util.deserialize_model(dikt, cls) @property - def hard(self): + def hard(self) -> List[str]: """Gets the hard of this ApplicationDependenciesConfig. Hard dependencies indicate that the application may not start without these other applications. # noqa: E501 @@ -71,7 +68,7 @@ def hard(self): return self._hard @hard.setter - def hard(self, hard): + def hard(self, hard: List[str]): """Sets the hard of this ApplicationDependenciesConfig. Hard dependencies indicate that the application may not start without these other applications. # noqa: E501 @@ -83,7 +80,7 @@ def hard(self, hard): self._hard = hard @property - def soft(self): + def soft(self) -> List[str]: """Gets the soft of this ApplicationDependenciesConfig. Soft dependencies indicate that the application will work partially without these other applications. # noqa: E501 @@ -94,7 +91,7 @@ def soft(self): return self._soft @soft.setter - def soft(self, soft): + def soft(self, soft: List[str]): """Sets the soft of this ApplicationDependenciesConfig. Soft dependencies indicate that the application will work partially without these other applications. # noqa: E501 @@ -106,7 +103,7 @@ def soft(self, soft): self._soft = soft @property - def build(self): + def build(self) -> List[str]: """Gets the build of this ApplicationDependenciesConfig. Hard dependencies indicate that the application Docker image build requires these base/common images # noqa: E501 @@ -117,7 +114,7 @@ def build(self): return self._build @build.setter - def build(self, build): + def build(self, build: List[str]): """Sets the build of this ApplicationDependenciesConfig. Hard dependencies indicate that the application Docker image build requires these base/common images # noqa: E501 @@ -129,7 +126,7 @@ def build(self, build): self._build = build @property - def git(self): + def git(self) -> List[GitDependencyConfig]: """Gets the git of this ApplicationDependenciesConfig. # noqa: E501 @@ -140,7 +137,7 @@ def git(self): return self._git @git.setter - def git(self, git): + def git(self, git: List[GitDependencyConfig]): """Sets the git of this ApplicationDependenciesConfig. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/application_harness_config.py b/libraries/models/cloudharness_model/models/application_harness_config.py index ba287654..ad85a40b 100644 --- a/libraries/models/cloudharness_model/models/application_harness_config.py +++ b/libraries/models/cloudharness_model/models/application_harness_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.application_accounts_config import ApplicationAccountsConfig from cloudharness_model.models.application_dependencies_config import ApplicationDependenciesConfig from cloudharness_model.models.application_probe import ApplicationProbe @@ -165,7 +162,7 @@ def from_dict(cls, dikt) -> 'ApplicationHarnessConfig': return util.deserialize_model(dikt, cls) @property - def deployment(self): + def deployment(self) -> DeploymentAutoArtifactConfig: """Gets the deployment of this ApplicationHarnessConfig. @@ -175,7 +172,7 @@ def deployment(self): return self._deployment @deployment.setter - def deployment(self, deployment): + def deployment(self, deployment: DeploymentAutoArtifactConfig): """Sets the deployment of this ApplicationHarnessConfig. @@ -186,7 +183,7 @@ def deployment(self, deployment): self._deployment = deployment @property - def service(self): + def service(self) -> ServiceAutoArtifactConfig: """Gets the service of this ApplicationHarnessConfig. @@ -196,7 +193,7 @@ def service(self): return self._service @service.setter - def service(self, service): + def service(self, service: ServiceAutoArtifactConfig): """Sets the service of this ApplicationHarnessConfig. @@ -207,7 +204,7 @@ def service(self, service): self._service = service @property - def subdomain(self): + def subdomain(self) -> str: """Gets the subdomain of this ApplicationHarnessConfig. If specified, an ingress will be created at [subdomain].[.Values.domain] # noqa: E501 @@ -218,7 +215,7 @@ def subdomain(self): return self._subdomain @subdomain.setter - def subdomain(self, subdomain): + def subdomain(self, subdomain: str): """Sets the subdomain of this ApplicationHarnessConfig. If specified, an ingress will be created at [subdomain].[.Values.domain] # noqa: E501 @@ -230,7 +227,7 @@ def subdomain(self, subdomain): self._subdomain = subdomain @property - def aliases(self): + def aliases(self) -> List[str]: """Gets the aliases of this ApplicationHarnessConfig. If specified, an ingress will be created at [alias].[.Values.domain] for each alias # noqa: E501 @@ -241,7 +238,7 @@ def aliases(self): return self._aliases @aliases.setter - def aliases(self, aliases): + def aliases(self, aliases: List[str]): """Sets the aliases of this ApplicationHarnessConfig. If specified, an ingress will be created at [alias].[.Values.domain] for each alias # noqa: E501 @@ -253,7 +250,7 @@ def aliases(self, aliases): self._aliases = aliases @property - def domain(self): + def domain(self) -> str: """Gets the domain of this ApplicationHarnessConfig. If specified, an ingress will be created at [domain] # noqa: E501 @@ -264,7 +261,7 @@ def domain(self): return self._domain @domain.setter - def domain(self, domain): + def domain(self, domain: str): """Sets the domain of this ApplicationHarnessConfig. If specified, an ingress will be created at [domain] # noqa: E501 @@ -276,7 +273,7 @@ def domain(self, domain): self._domain = domain @property - def dependencies(self): + def dependencies(self) -> ApplicationDependenciesConfig: """Gets the dependencies of this ApplicationHarnessConfig. @@ -286,7 +283,7 @@ def dependencies(self): return self._dependencies @dependencies.setter - def dependencies(self, dependencies): + def dependencies(self, dependencies: ApplicationDependenciesConfig): """Sets the dependencies of this ApplicationHarnessConfig. @@ -297,7 +294,7 @@ def dependencies(self, dependencies): self._dependencies = dependencies @property - def secured(self): + def secured(self) -> bool: """Gets the secured of this ApplicationHarnessConfig. When true, the application is shielded with a getekeeper # noqa: E501 @@ -308,7 +305,7 @@ def secured(self): return self._secured @secured.setter - def secured(self, secured): + def secured(self, secured: bool): """Sets the secured of this ApplicationHarnessConfig. When true, the application is shielded with a getekeeper # noqa: E501 @@ -320,7 +317,7 @@ def secured(self, secured): self._secured = secured @property - def uri_role_mapping(self): + def uri_role_mapping(self) -> List[UriRoleMappingConfig]: """Gets the uri_role_mapping of this ApplicationHarnessConfig. Map uri/roles to secure with the Gatekeeper (if `secured: true`) # noqa: E501 @@ -331,7 +328,7 @@ def uri_role_mapping(self): return self._uri_role_mapping @uri_role_mapping.setter - def uri_role_mapping(self, uri_role_mapping): + def uri_role_mapping(self, uri_role_mapping: List[UriRoleMappingConfig]): """Sets the uri_role_mapping of this ApplicationHarnessConfig. Map uri/roles to secure with the Gatekeeper (if `secured: true`) # noqa: E501 @@ -343,7 +340,7 @@ def uri_role_mapping(self, uri_role_mapping): self._uri_role_mapping = uri_role_mapping @property - def secrets(self): + def secrets(self) -> Dict[str, object]: """Gets the secrets of this ApplicationHarnessConfig. # noqa: E501 @@ -354,7 +351,7 @@ def secrets(self): return self._secrets @secrets.setter - def secrets(self, secrets): + def secrets(self, secrets: Dict[str, object]): """Sets the secrets of this ApplicationHarnessConfig. # noqa: E501 @@ -366,7 +363,7 @@ def secrets(self, secrets): self._secrets = secrets @property - def use_services(self): + def use_services(self) -> List[str]: """Gets the use_services of this ApplicationHarnessConfig. Specify which services this application uses in the frontend to create proxy ingresses. e.g. ``` - name: samples ``` # noqa: E501 @@ -377,7 +374,7 @@ def use_services(self): return self._use_services @use_services.setter - def use_services(self, use_services): + def use_services(self, use_services: List[str]): """Sets the use_services of this ApplicationHarnessConfig. Specify which services this application uses in the frontend to create proxy ingresses. e.g. ``` - name: samples ``` # noqa: E501 @@ -389,7 +386,7 @@ def use_services(self, use_services): self._use_services = use_services @property - def database(self): + def database(self) -> DatabaseDeploymentConfig: """Gets the database of this ApplicationHarnessConfig. @@ -399,7 +396,7 @@ def database(self): return self._database @database.setter - def database(self, database): + def database(self, database: DatabaseDeploymentConfig): """Sets the database of this ApplicationHarnessConfig. @@ -410,7 +407,7 @@ def database(self, database): self._database = database @property - def resources(self): + def resources(self) -> List[FileResourcesConfig]: """Gets the resources of this ApplicationHarnessConfig. Application file resources. Maps from deploy/resources folder and mounts as configmaps # noqa: E501 @@ -421,7 +418,7 @@ def resources(self): return self._resources @resources.setter - def resources(self, resources): + def resources(self, resources: List[FileResourcesConfig]): """Sets the resources of this ApplicationHarnessConfig. Application file resources. Maps from deploy/resources folder and mounts as configmaps # noqa: E501 @@ -433,7 +430,7 @@ def resources(self, resources): self._resources = resources @property - def readiness_probe(self): + def readiness_probe(self) -> ApplicationProbe: """Gets the readiness_probe of this ApplicationHarnessConfig. @@ -443,7 +440,7 @@ def readiness_probe(self): return self._readiness_probe @readiness_probe.setter - def readiness_probe(self, readiness_probe): + def readiness_probe(self, readiness_probe: ApplicationProbe): """Sets the readiness_probe of this ApplicationHarnessConfig. @@ -454,7 +451,7 @@ def readiness_probe(self, readiness_probe): self._readiness_probe = readiness_probe @property - def startup_probe(self): + def startup_probe(self) -> ApplicationProbe: """Gets the startup_probe of this ApplicationHarnessConfig. @@ -464,7 +461,7 @@ def startup_probe(self): return self._startup_probe @startup_probe.setter - def startup_probe(self, startup_probe): + def startup_probe(self, startup_probe: ApplicationProbe): """Sets the startup_probe of this ApplicationHarnessConfig. @@ -475,7 +472,7 @@ def startup_probe(self, startup_probe): self._startup_probe = startup_probe @property - def liveness_probe(self): + def liveness_probe(self) -> ApplicationProbe: """Gets the liveness_probe of this ApplicationHarnessConfig. @@ -485,7 +482,7 @@ def liveness_probe(self): return self._liveness_probe @liveness_probe.setter - def liveness_probe(self, liveness_probe): + def liveness_probe(self, liveness_probe: ApplicationProbe): """Sets the liveness_probe of this ApplicationHarnessConfig. @@ -496,7 +493,7 @@ def liveness_probe(self, liveness_probe): self._liveness_probe = liveness_probe @property - def source_root(self): + def source_root(self) -> str: """Gets the source_root of this ApplicationHarnessConfig. # noqa: E501 @@ -507,7 +504,7 @@ def source_root(self): return self._source_root @source_root.setter - def source_root(self, source_root): + def source_root(self, source_root: str): """Sets the source_root of this ApplicationHarnessConfig. # noqa: E501 @@ -521,7 +518,7 @@ def source_root(self, source_root): self._source_root = source_root @property - def name(self): + def name(self) -> str: """Gets the name of this ApplicationHarnessConfig. Application's name. Do not edit, the value is automatically set from the application directory's name # noqa: E501 @@ -532,7 +529,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this ApplicationHarnessConfig. Application's name. Do not edit, the value is automatically set from the application directory's name # noqa: E501 @@ -544,7 +541,7 @@ def name(self, name): self._name = name @property - def jupyterhub(self): + def jupyterhub(self) -> JupyterHubConfig: """Gets the jupyterhub of this ApplicationHarnessConfig. @@ -554,7 +551,7 @@ def jupyterhub(self): return self._jupyterhub @jupyterhub.setter - def jupyterhub(self, jupyterhub): + def jupyterhub(self, jupyterhub: JupyterHubConfig): """Sets the jupyterhub of this ApplicationHarnessConfig. @@ -565,7 +562,7 @@ def jupyterhub(self, jupyterhub): self._jupyterhub = jupyterhub @property - def accounts(self): + def accounts(self) -> ApplicationAccountsConfig: """Gets the accounts of this ApplicationHarnessConfig. @@ -575,7 +572,7 @@ def accounts(self): return self._accounts @accounts.setter - def accounts(self, accounts): + def accounts(self, accounts: ApplicationAccountsConfig): """Sets the accounts of this ApplicationHarnessConfig. @@ -586,7 +583,7 @@ def accounts(self, accounts): self._accounts = accounts @property - def test(self): + def test(self) -> ApplicationTestConfig: """Gets the test of this ApplicationHarnessConfig. @@ -596,7 +593,7 @@ def test(self): return self._test @test.setter - def test(self, test): + def test(self, test: ApplicationTestConfig): """Sets the test of this ApplicationHarnessConfig. @@ -607,7 +604,7 @@ def test(self, test): self._test = test @property - def quotas(self): + def quotas(self) -> Dict[str, object]: """Gets the quotas of this ApplicationHarnessConfig. # noqa: E501 @@ -618,7 +615,7 @@ def quotas(self): return self._quotas @quotas.setter - def quotas(self, quotas): + def quotas(self, quotas: Dict[str, object]): """Sets the quotas of this ApplicationHarnessConfig. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/application_probe.py b/libraries/models/cloudharness_model/models/application_probe.py index b1819df4..75864acc 100644 --- a/libraries/models/cloudharness_model/models/application_probe.py +++ b/libraries/models/cloudharness_model/models/application_probe.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -58,7 +55,7 @@ def from_dict(cls, dikt) -> 'ApplicationProbe': return util.deserialize_model(dikt, cls) @property - def path(self): + def path(self) -> str: """Gets the path of this ApplicationProbe. # noqa: E501 @@ -69,7 +66,7 @@ def path(self): return self._path @path.setter - def path(self, path): + def path(self, path: str): """Sets the path of this ApplicationProbe. # noqa: E501 @@ -83,7 +80,7 @@ def path(self, path): self._path = path @property - def period_seconds(self): + def period_seconds(self) -> float: """Gets the period_seconds of this ApplicationProbe. # noqa: E501 @@ -94,7 +91,7 @@ def period_seconds(self): return self._period_seconds @period_seconds.setter - def period_seconds(self, period_seconds): + def period_seconds(self, period_seconds: float): """Sets the period_seconds of this ApplicationProbe. # noqa: E501 @@ -106,7 +103,7 @@ def period_seconds(self, period_seconds): self._period_seconds = period_seconds @property - def failure_threshold(self): + def failure_threshold(self) -> float: """Gets the failure_threshold of this ApplicationProbe. # noqa: E501 @@ -117,7 +114,7 @@ def failure_threshold(self): return self._failure_threshold @failure_threshold.setter - def failure_threshold(self, failure_threshold): + def failure_threshold(self, failure_threshold: float): """Sets the failure_threshold of this ApplicationProbe. # noqa: E501 @@ -129,7 +126,7 @@ def failure_threshold(self, failure_threshold): self._failure_threshold = failure_threshold @property - def initial_delay_seconds(self): + def initial_delay_seconds(self) -> float: """Gets the initial_delay_seconds of this ApplicationProbe. # noqa: E501 @@ -140,7 +137,7 @@ def initial_delay_seconds(self): return self._initial_delay_seconds @initial_delay_seconds.setter - def initial_delay_seconds(self, initial_delay_seconds): + def initial_delay_seconds(self, initial_delay_seconds: float): """Sets the initial_delay_seconds of this ApplicationProbe. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/application_test_config.py b/libraries/models/cloudharness_model/models/application_test_config.py index a9133dd0..3ad31523 100644 --- a/libraries/models/cloudharness_model/models/application_test_config.py +++ b/libraries/models/cloudharness_model/models/application_test_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.api_tests_config import ApiTestsConfig from cloudharness_model.models.e2_e_tests_config import E2ETestsConfig from cloudharness_model.models.unit_tests_config import UnitTestsConfig @@ -59,7 +56,7 @@ def from_dict(cls, dikt) -> 'ApplicationTestConfig': return util.deserialize_model(dikt, cls) @property - def unit(self): + def unit(self) -> UnitTestsConfig: """Gets the unit of this ApplicationTestConfig. @@ -69,7 +66,7 @@ def unit(self): return self._unit @unit.setter - def unit(self, unit): + def unit(self, unit: UnitTestsConfig): """Sets the unit of this ApplicationTestConfig. @@ -82,7 +79,7 @@ def unit(self, unit): self._unit = unit @property - def api(self): + def api(self) -> ApiTestsConfig: """Gets the api of this ApplicationTestConfig. @@ -92,7 +89,7 @@ def api(self): return self._api @api.setter - def api(self, api): + def api(self, api: ApiTestsConfig): """Sets the api of this ApplicationTestConfig. @@ -105,7 +102,7 @@ def api(self, api): self._api = api @property - def e2e(self): + def e2e(self) -> E2ETestsConfig: """Gets the e2e of this ApplicationTestConfig. @@ -115,7 +112,7 @@ def e2e(self): return self._e2e @e2e.setter - def e2e(self, e2e): + def e2e(self, e2e: E2ETestsConfig): """Sets the e2e of this ApplicationTestConfig. diff --git a/libraries/models/cloudharness_model/models/application_user.py b/libraries/models/cloudharness_model/models/application_user.py index 823be12b..991d8ea3 100644 --- a/libraries/models/cloudharness_model/models/application_user.py +++ b/libraries/models/cloudharness_model/models/application_user.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -58,7 +55,7 @@ def from_dict(cls, dikt) -> 'ApplicationUser': return util.deserialize_model(dikt, cls) @property - def username(self): + def username(self) -> str: """Gets the username of this ApplicationUser. # noqa: E501 @@ -69,7 +66,7 @@ def username(self): return self._username @username.setter - def username(self, username): + def username(self, username: str): """Sets the username of this ApplicationUser. # noqa: E501 @@ -83,7 +80,7 @@ def username(self, username): self._username = username @property - def password(self): + def password(self) -> str: """Gets the password of this ApplicationUser. # noqa: E501 @@ -94,7 +91,7 @@ def password(self): return self._password @password.setter - def password(self, password): + def password(self, password: str): """Sets the password of this ApplicationUser. # noqa: E501 @@ -106,7 +103,7 @@ def password(self, password): self._password = password @property - def client_roles(self): + def client_roles(self) -> List[str]: """Gets the client_roles of this ApplicationUser. # noqa: E501 @@ -117,7 +114,7 @@ def client_roles(self): return self._client_roles @client_roles.setter - def client_roles(self, client_roles): + def client_roles(self, client_roles: List[str]): """Sets the client_roles of this ApplicationUser. # noqa: E501 @@ -129,7 +126,7 @@ def client_roles(self, client_roles): self._client_roles = client_roles @property - def realm_roles(self): + def realm_roles(self) -> List[str]: """Gets the realm_roles of this ApplicationUser. # noqa: E501 @@ -140,7 +137,7 @@ def realm_roles(self): return self._realm_roles @realm_roles.setter - def realm_roles(self, realm_roles): + def realm_roles(self, realm_roles: List[str]): """Sets the realm_roles of this ApplicationUser. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/auto_artifact_spec.py b/libraries/models/cloudharness_model/models/auto_artifact_spec.py index 9aebfd4f..c0c89ac3 100644 --- a/libraries/models/cloudharness_model/models/auto_artifact_spec.py +++ b/libraries/models/cloudharness_model/models/auto_artifact_spec.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -48,7 +45,7 @@ def from_dict(cls, dikt) -> 'AutoArtifactSpec': return util.deserialize_model(dikt, cls) @property - def auto(self): + def auto(self) -> bool: """Gets the auto of this AutoArtifactSpec. When true, enables automatic template # noqa: E501 @@ -59,7 +56,7 @@ def auto(self): return self._auto @auto.setter - def auto(self, auto): + def auto(self, auto: bool): """Sets the auto of this AutoArtifactSpec. When true, enables automatic template # noqa: E501 @@ -73,7 +70,7 @@ def auto(self, auto): self._auto = auto @property - def name(self): + def name(self) -> str: """Gets the name of this AutoArtifactSpec. # noqa: E501 @@ -84,7 +81,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this AutoArtifactSpec. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/backup_config.py b/libraries/models/cloudharness_model/models/backup_config.py index 254c52f7..0613c70d 100644 --- a/libraries/models/cloudharness_model/models/backup_config.py +++ b/libraries/models/cloudharness_model/models/backup_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf import re from cloudharness_model import util @@ -87,7 +84,7 @@ def from_dict(cls, dikt) -> 'BackupConfig': return util.deserialize_model(dikt, cls) @property - def active(self): + def active(self) -> bool: """Gets the active of this BackupConfig. # noqa: E501 @@ -98,7 +95,7 @@ def active(self): return self._active @active.setter - def active(self, active): + def active(self, active: bool): """Sets the active of this BackupConfig. # noqa: E501 @@ -110,7 +107,7 @@ def active(self, active): self._active = active @property - def keep_days(self): + def keep_days(self) -> int: """Gets the keep_days of this BackupConfig. # noqa: E501 @@ -121,7 +118,7 @@ def keep_days(self): return self._keep_days @keep_days.setter - def keep_days(self, keep_days): + def keep_days(self, keep_days: int): """Sets the keep_days of this BackupConfig. # noqa: E501 @@ -133,7 +130,7 @@ def keep_days(self, keep_days): self._keep_days = keep_days @property - def keep_weeks(self): + def keep_weeks(self) -> int: """Gets the keep_weeks of this BackupConfig. # noqa: E501 @@ -144,7 +141,7 @@ def keep_weeks(self): return self._keep_weeks @keep_weeks.setter - def keep_weeks(self, keep_weeks): + def keep_weeks(self, keep_weeks: int): """Sets the keep_weeks of this BackupConfig. # noqa: E501 @@ -156,7 +153,7 @@ def keep_weeks(self, keep_weeks): self._keep_weeks = keep_weeks @property - def keep_months(self): + def keep_months(self) -> int: """Gets the keep_months of this BackupConfig. # noqa: E501 @@ -167,7 +164,7 @@ def keep_months(self): return self._keep_months @keep_months.setter - def keep_months(self, keep_months): + def keep_months(self, keep_months: int): """Sets the keep_months of this BackupConfig. # noqa: E501 @@ -179,7 +176,7 @@ def keep_months(self, keep_months): self._keep_months = keep_months @property - def schedule(self): + def schedule(self) -> str: """Gets the schedule of this BackupConfig. Cron expression # noqa: E501 @@ -190,7 +187,7 @@ def schedule(self): return self._schedule @schedule.setter - def schedule(self, schedule): + def schedule(self, schedule: str): """Sets the schedule of this BackupConfig. Cron expression # noqa: E501 @@ -204,7 +201,7 @@ def schedule(self, schedule): self._schedule = schedule @property - def suffix(self): + def suffix(self) -> object: """Gets the suffix of this BackupConfig. The file suffix added to backup files # noqa: E501 @@ -215,7 +212,7 @@ def suffix(self): return self._suffix @suffix.setter - def suffix(self, suffix): + def suffix(self, suffix: object): """Sets the suffix of this BackupConfig. The file suffix added to backup files # noqa: E501 @@ -227,7 +224,7 @@ def suffix(self, suffix): self._suffix = suffix @property - def volumesize(self): + def volumesize(self) -> str: """Gets the volumesize of this BackupConfig. The volume size for backups (all backups share the same volume) # noqa: E501 @@ -238,7 +235,7 @@ def volumesize(self): return self._volumesize @volumesize.setter - def volumesize(self, volumesize): + def volumesize(self, volumesize: str): """Sets the volumesize of this BackupConfig. The volume size for backups (all backups share the same volume) # noqa: E501 @@ -250,7 +247,7 @@ def volumesize(self, volumesize): self._volumesize = volumesize @property - def dir(self): + def dir(self) -> str: """Gets the dir of this BackupConfig. # noqa: E501 @@ -261,7 +258,7 @@ def dir(self): return self._dir @dir.setter - def dir(self, dir): + def dir(self, dir: str): """Sets the dir of this BackupConfig. # noqa: E501 @@ -277,7 +274,7 @@ def dir(self, dir): self._dir = dir @property - def resources(self): + def resources(self) -> DeploymentResourcesConf: """Gets the resources of this BackupConfig. @@ -287,7 +284,7 @@ def resources(self): return self._resources @resources.setter - def resources(self, resources): + def resources(self, resources: DeploymentResourcesConf): """Sets the resources of this BackupConfig. diff --git a/libraries/models/cloudharness_model/models/base_model.py b/libraries/models/cloudharness_model/models/base_model.py new file mode 100644 index 00000000..0938bbc9 --- /dev/null +++ b/libraries/models/cloudharness_model/models/base_model.py @@ -0,0 +1,68 @@ +import pprint + +import typing + +from cloudharness_model import util + +T = typing.TypeVar('T') + + +class Model: + # openapiTypes: The key is attribute name and the + # value is attribute type. + openapi_types: typing.Dict[str, type] = {} + + # attributeMap: The key is attribute name and the + # value is json key in definition. + attribute_map: typing.Dict[str, str] = {} + + @classmethod + def from_dict(cls: typing.Type[T], dikt) -> T: + """Returns the dict as a model""" + return util.deserialize_model(dikt, cls) + + def to_dict(self): + """Returns the model properties as a dict + + :rtype: dict + """ + result = {} + + for attr in self.openapi_types: + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model + + :rtype: str + """ + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/libraries/models/cloudharness_model/models/cdc_event.py b/libraries/models/cloudharness_model/models/cdc_event.py index 1ba4f017..b8861ad1 100644 --- a/libraries/models/cloudharness_model/models/cdc_event.py +++ b/libraries/models/cloudharness_model/models/cdc_event.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.cdc_event_meta import CDCEventMeta from cloudharness_model import util @@ -65,7 +62,7 @@ def from_dict(cls, dikt) -> 'CDCEvent': return util.deserialize_model(dikt, cls) @property - def operation(self): + def operation(self) -> str: """Gets the operation of this CDCEvent. the operation on the object e.g. create / update / delete # noqa: E501 @@ -76,7 +73,7 @@ def operation(self): return self._operation @operation.setter - def operation(self, operation): + def operation(self, operation: str): """Sets the operation of this CDCEvent. the operation on the object e.g. create / update / delete # noqa: E501 @@ -94,7 +91,7 @@ def operation(self, operation): self._operation = operation @property - def uid(self): + def uid(self) -> str: """Gets the uid of this CDCEvent. the unique identifier attribute of the object # noqa: E501 @@ -105,7 +102,7 @@ def uid(self): return self._uid @uid.setter - def uid(self, uid): + def uid(self, uid: str): """Sets the uid of this CDCEvent. the unique identifier attribute of the object # noqa: E501 @@ -119,7 +116,7 @@ def uid(self, uid): self._uid = uid @property - def message_type(self): + def message_type(self) -> str: """Gets the message_type of this CDCEvent. the type of the message (relates to the object type) e.g. jobs # noqa: E501 @@ -130,7 +127,7 @@ def message_type(self): return self._message_type @message_type.setter - def message_type(self, message_type): + def message_type(self, message_type: str): """Sets the message_type of this CDCEvent. the type of the message (relates to the object type) e.g. jobs # noqa: E501 @@ -144,7 +141,7 @@ def message_type(self, message_type): self._message_type = message_type @property - def resource(self): + def resource(self) -> Dict[str, object]: """Gets the resource of this CDCEvent. # noqa: E501 @@ -155,7 +152,7 @@ def resource(self): return self._resource @resource.setter - def resource(self, resource): + def resource(self, resource: Dict[str, object]): """Sets the resource of this CDCEvent. # noqa: E501 @@ -167,7 +164,7 @@ def resource(self, resource): self._resource = resource @property - def meta(self): + def meta(self) -> CDCEventMeta: """Gets the meta of this CDCEvent. @@ -177,7 +174,7 @@ def meta(self): return self._meta @meta.setter - def meta(self, meta): + def meta(self, meta: CDCEventMeta): """Sets the meta of this CDCEvent. diff --git a/libraries/models/cloudharness_model/models/cdc_event_meta.py b/libraries/models/cloudharness_model/models/cdc_event_meta.py index d88e57d1..78db4e05 100644 --- a/libraries/models/cloudharness_model/models/cdc_event_meta.py +++ b/libraries/models/cloudharness_model/models/cdc_event_meta.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.user import User from cloudharness_model import util @@ -25,7 +22,7 @@ def __init__(self, app_name=None, user=None, args=None, kwargs=None, description :param user: The user of this CDCEventMeta. # noqa: E501 :type user: User :param args: The args of this CDCEventMeta. # noqa: E501 - :type args: List[Dict] + :type args: List[Dict[str, object]] :param kwargs: The kwargs of this CDCEventMeta. # noqa: E501 :type kwargs: object :param description: The description of this CDCEventMeta. # noqa: E501 @@ -34,7 +31,7 @@ def __init__(self, app_name=None, user=None, args=None, kwargs=None, description self.openapi_types = { 'app_name': str, 'user': User, - 'args': List[Dict], + 'args': List[Dict[str, object]], 'kwargs': object, 'description': str } @@ -65,7 +62,7 @@ def from_dict(cls, dikt) -> 'CDCEventMeta': return util.deserialize_model(dikt, cls) @property - def app_name(self): + def app_name(self) -> str: """Gets the app_name of this CDCEventMeta. The name of the application/microservice sending the message # noqa: E501 @@ -76,7 +73,7 @@ def app_name(self): return self._app_name @app_name.setter - def app_name(self, app_name): + def app_name(self, app_name: str): """Sets the app_name of this CDCEventMeta. The name of the application/microservice sending the message # noqa: E501 @@ -90,7 +87,7 @@ def app_name(self, app_name): self._app_name = app_name @property - def user(self): + def user(self) -> User: """Gets the user of this CDCEventMeta. @@ -100,7 +97,7 @@ def user(self): return self._user @user.setter - def user(self, user): + def user(self, user: User): """Sets the user of this CDCEventMeta. @@ -111,30 +108,30 @@ def user(self, user): self._user = user @property - def args(self): + def args(self) -> List[Dict[str, object]]: """Gets the args of this CDCEventMeta. the caller function arguments # noqa: E501 :return: The args of this CDCEventMeta. - :rtype: List[Dict] + :rtype: List[Dict[str, object]] """ return self._args @args.setter - def args(self, args): + def args(self, args: List[Dict[str, object]]): """Sets the args of this CDCEventMeta. the caller function arguments # noqa: E501 :param args: The args of this CDCEventMeta. - :type args: List[Dict] + :type args: List[Dict[str, object]] """ self._args = args @property - def kwargs(self): + def kwargs(self) -> object: """Gets the kwargs of this CDCEventMeta. the caller function keyword arguments # noqa: E501 @@ -145,7 +142,7 @@ def kwargs(self): return self._kwargs @kwargs.setter - def kwargs(self, kwargs): + def kwargs(self, kwargs: object): """Sets the kwargs of this CDCEventMeta. the caller function keyword arguments # noqa: E501 @@ -157,7 +154,7 @@ def kwargs(self, kwargs): self._kwargs = kwargs @property - def description(self): + def description(self) -> str: """Gets the description of this CDCEventMeta. General description -- for human consumption # noqa: E501 @@ -168,7 +165,7 @@ def description(self): return self._description @description.setter - def description(self, description): + def description(self, description: str): """Sets the description of this CDCEventMeta. General description -- for human consumption # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/cpu_memory_config.py b/libraries/models/cloudharness_model/models/cpu_memory_config.py index cab9bf7c..8f4f1e70 100644 --- a/libraries/models/cloudharness_model/models/cpu_memory_config.py +++ b/libraries/models/cloudharness_model/models/cpu_memory_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -48,7 +45,7 @@ def from_dict(cls, dikt) -> 'CpuMemoryConfig': return util.deserialize_model(dikt, cls) @property - def cpu(self): + def cpu(self) -> str: """Gets the cpu of this CpuMemoryConfig. # noqa: E501 @@ -59,7 +56,7 @@ def cpu(self): return self._cpu @cpu.setter - def cpu(self, cpu): + def cpu(self, cpu: str): """Sets the cpu of this CpuMemoryConfig. # noqa: E501 @@ -71,7 +68,7 @@ def cpu(self, cpu): self._cpu = cpu @property - def memory(self): + def memory(self) -> str: """Gets the memory of this CpuMemoryConfig. # noqa: E501 @@ -82,7 +79,7 @@ def memory(self): return self._memory @memory.setter - def memory(self, memory): + def memory(self, memory: str): """Sets the memory of this CpuMemoryConfig. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/database_deployment_config.py b/libraries/models/cloudharness_model/models/database_deployment_config.py index 3786fb89..1be424a2 100644 --- a/libraries/models/cloudharness_model/models/database_deployment_config.py +++ b/libraries/models/cloudharness_model/models/database_deployment_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf import re from cloudharness_model import util @@ -19,9 +16,13 @@ class DatabaseDeploymentConfig(Model): Do not edit the class manually. """ - def __init__(self, type=None, size=None, user=None, _pass=None, image_ref=None, mongo=None, postgres=None, neo4j=None, resources=None, auto=None, name=None): # noqa: E501 + def __init__(self, auto=None, name=None, type=None, size=None, user=None, _pass=None, image_ref=None, mongo=None, postgres=None, neo4j=None, resources=None): # noqa: E501 """DatabaseDeploymentConfig - a model defined in OpenAPI + :param auto: The auto of this DatabaseDeploymentConfig. # noqa: E501 + :type auto: bool + :param name: The name of this DatabaseDeploymentConfig. # noqa: E501 + :type name: str :param type: The type of this DatabaseDeploymentConfig. # noqa: E501 :type type: str :param size: The size of this DatabaseDeploymentConfig. # noqa: E501 @@ -40,12 +41,10 @@ def __init__(self, type=None, size=None, user=None, _pass=None, image_ref=None, :type neo4j: object :param resources: The resources of this DatabaseDeploymentConfig. # noqa: E501 :type resources: DeploymentResourcesConf - :param auto: The auto of this DatabaseDeploymentConfig. # noqa: E501 - :type auto: bool - :param name: The name of this DatabaseDeploymentConfig. # noqa: E501 - :type name: str """ self.openapi_types = { + 'auto': bool, + 'name': str, 'type': str, 'size': str, 'user': str, @@ -54,12 +53,12 @@ def __init__(self, type=None, size=None, user=None, _pass=None, image_ref=None, 'mongo': Dict[str, object], 'postgres': Dict[str, object], 'neo4j': object, - 'resources': DeploymentResourcesConf, - 'auto': bool, - 'name': str + 'resources': DeploymentResourcesConf } self.attribute_map = { + 'auto': 'auto', + 'name': 'name', 'type': 'type', 'size': 'size', 'user': 'user', @@ -68,11 +67,11 @@ def __init__(self, type=None, size=None, user=None, _pass=None, image_ref=None, 'mongo': 'mongo', 'postgres': 'postgres', 'neo4j': 'neo4j', - 'resources': 'resources', - 'auto': 'auto', - 'name': 'name' + 'resources': 'resources' } + self._auto = auto + self._name = name self._type = type self._size = size self._user = user @@ -82,8 +81,6 @@ def __init__(self, type=None, size=None, user=None, _pass=None, image_ref=None, self._postgres = postgres self._neo4j = neo4j self._resources = resources - self._auto = auto - self._name = name @classmethod def from_dict(cls, dikt) -> 'DatabaseDeploymentConfig': @@ -97,7 +94,55 @@ def from_dict(cls, dikt) -> 'DatabaseDeploymentConfig': return util.deserialize_model(dikt, cls) @property - def type(self): + def auto(self) -> bool: + """Gets the auto of this DatabaseDeploymentConfig. + + When true, enables automatic template # noqa: E501 + + :return: The auto of this DatabaseDeploymentConfig. + :rtype: bool + """ + return self._auto + + @auto.setter + def auto(self, auto: bool): + """Sets the auto of this DatabaseDeploymentConfig. + + When true, enables automatic template # noqa: E501 + + :param auto: The auto of this DatabaseDeploymentConfig. + :type auto: bool + """ + if auto is None: + raise ValueError("Invalid value for `auto`, must not be `None`") # noqa: E501 + + self._auto = auto + + @property + def name(self) -> str: + """Gets the name of this DatabaseDeploymentConfig. + + # noqa: E501 + + :return: The name of this DatabaseDeploymentConfig. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name: str): + """Sets the name of this DatabaseDeploymentConfig. + + # noqa: E501 + + :param name: The name of this DatabaseDeploymentConfig. + :type name: str + """ + + self._name = name + + @property + def type(self) -> str: """Gets the type of this DatabaseDeploymentConfig. Define the database type. One of (mongo, postgres, neo4j, sqlite3) # noqa: E501 @@ -108,7 +153,7 @@ def type(self): return self._type @type.setter - def type(self, type): + def type(self, type: str): """Sets the type of this DatabaseDeploymentConfig. Define the database type. One of (mongo, postgres, neo4j, sqlite3) # noqa: E501 @@ -122,7 +167,7 @@ def type(self, type): self._type = type @property - def size(self): + def size(self) -> str: """Gets the size of this DatabaseDeploymentConfig. Specify database disk size # noqa: E501 @@ -133,7 +178,7 @@ def size(self): return self._size @size.setter - def size(self, size): + def size(self, size: str): """Sets the size of this DatabaseDeploymentConfig. Specify database disk size # noqa: E501 @@ -145,7 +190,7 @@ def size(self, size): self._size = size @property - def user(self): + def user(self) -> str: """Gets the user of this DatabaseDeploymentConfig. database username # noqa: E501 @@ -156,7 +201,7 @@ def user(self): return self._user @user.setter - def user(self, user): + def user(self, user: str): """Sets the user of this DatabaseDeploymentConfig. database username # noqa: E501 @@ -168,7 +213,7 @@ def user(self, user): self._user = user @property - def _pass(self): + def _pass(self) -> str: """Gets the _pass of this DatabaseDeploymentConfig. Database password # noqa: E501 @@ -179,7 +224,7 @@ def _pass(self): return self.__pass @_pass.setter - def _pass(self, _pass): + def _pass(self, _pass: str): """Sets the _pass of this DatabaseDeploymentConfig. Database password # noqa: E501 @@ -191,7 +236,7 @@ def _pass(self, _pass): self.__pass = _pass @property - def image_ref(self): + def image_ref(self) -> str: """Gets the image_ref of this DatabaseDeploymentConfig. Used for referencing images from the build # noqa: E501 @@ -202,7 +247,7 @@ def image_ref(self): return self._image_ref @image_ref.setter - def image_ref(self, image_ref): + def image_ref(self, image_ref: str): """Sets the image_ref of this DatabaseDeploymentConfig. Used for referencing images from the build # noqa: E501 @@ -214,7 +259,7 @@ def image_ref(self, image_ref): self._image_ref = image_ref @property - def mongo(self): + def mongo(self) -> Dict[str, object]: """Gets the mongo of this DatabaseDeploymentConfig. # noqa: E501 @@ -225,7 +270,7 @@ def mongo(self): return self._mongo @mongo.setter - def mongo(self, mongo): + def mongo(self, mongo: Dict[str, object]): """Sets the mongo of this DatabaseDeploymentConfig. # noqa: E501 @@ -237,7 +282,7 @@ def mongo(self, mongo): self._mongo = mongo @property - def postgres(self): + def postgres(self) -> Dict[str, object]: """Gets the postgres of this DatabaseDeploymentConfig. # noqa: E501 @@ -248,7 +293,7 @@ def postgres(self): return self._postgres @postgres.setter - def postgres(self, postgres): + def postgres(self, postgres: Dict[str, object]): """Sets the postgres of this DatabaseDeploymentConfig. # noqa: E501 @@ -260,7 +305,7 @@ def postgres(self, postgres): self._postgres = postgres @property - def neo4j(self): + def neo4j(self) -> object: """Gets the neo4j of this DatabaseDeploymentConfig. Neo4j database specific configuration # noqa: E501 @@ -271,7 +316,7 @@ def neo4j(self): return self._neo4j @neo4j.setter - def neo4j(self, neo4j): + def neo4j(self, neo4j: object): """Sets the neo4j of this DatabaseDeploymentConfig. Neo4j database specific configuration # noqa: E501 @@ -283,7 +328,7 @@ def neo4j(self, neo4j): self._neo4j = neo4j @property - def resources(self): + def resources(self) -> DeploymentResourcesConf: """Gets the resources of this DatabaseDeploymentConfig. @@ -293,7 +338,7 @@ def resources(self): return self._resources @resources.setter - def resources(self, resources): + def resources(self, resources: DeploymentResourcesConf): """Sets the resources of this DatabaseDeploymentConfig. @@ -302,51 +347,3 @@ def resources(self, resources): """ self._resources = resources - - @property - def auto(self): - """Gets the auto of this DatabaseDeploymentConfig. - - When true, enables automatic template # noqa: E501 - - :return: The auto of this DatabaseDeploymentConfig. - :rtype: bool - """ - return self._auto - - @auto.setter - def auto(self, auto): - """Sets the auto of this DatabaseDeploymentConfig. - - When true, enables automatic template # noqa: E501 - - :param auto: The auto of this DatabaseDeploymentConfig. - :type auto: bool - """ - if auto is None: - raise ValueError("Invalid value for `auto`, must not be `None`") # noqa: E501 - - self._auto = auto - - @property - def name(self): - """Gets the name of this DatabaseDeploymentConfig. - - # noqa: E501 - - :return: The name of this DatabaseDeploymentConfig. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """Sets the name of this DatabaseDeploymentConfig. - - # noqa: E501 - - :param name: The name of this DatabaseDeploymentConfig. - :type name: str - """ - - self._name = name diff --git a/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py b/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py index c72ac477..ab31de80 100644 --- a/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py +++ b/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf from cloudharness_model.models.deployment_volume_spec import DeploymentVolumeSpec import re @@ -21,9 +18,13 @@ class DeploymentAutoArtifactConfig(Model): Do not edit the class manually. """ - def __init__(self, port=None, replicas=None, image=None, resources=None, volume=None, auto=None, name=None): # noqa: E501 + def __init__(self, auto=None, name=None, port=None, replicas=None, image=None, resources=None, volume=None): # noqa: E501 """DeploymentAutoArtifactConfig - a model defined in OpenAPI + :param auto: The auto of this DeploymentAutoArtifactConfig. # noqa: E501 + :type auto: bool + :param name: The name of this DeploymentAutoArtifactConfig. # noqa: E501 + :type name: str :param port: The port of this DeploymentAutoArtifactConfig. # noqa: E501 :type port: str :param replicas: The replicas of this DeploymentAutoArtifactConfig. # noqa: E501 @@ -34,38 +35,34 @@ def __init__(self, port=None, replicas=None, image=None, resources=None, volume= :type resources: DeploymentResourcesConf :param volume: The volume of this DeploymentAutoArtifactConfig. # noqa: E501 :type volume: DeploymentVolumeSpec - :param auto: The auto of this DeploymentAutoArtifactConfig. # noqa: E501 - :type auto: bool - :param name: The name of this DeploymentAutoArtifactConfig. # noqa: E501 - :type name: str """ self.openapi_types = { + 'auto': bool, + 'name': str, 'port': str, 'replicas': int, 'image': str, 'resources': DeploymentResourcesConf, - 'volume': DeploymentVolumeSpec, - 'auto': bool, - 'name': str + 'volume': DeploymentVolumeSpec } self.attribute_map = { + 'auto': 'auto', + 'name': 'name', 'port': 'port', 'replicas': 'replicas', 'image': 'image', 'resources': 'resources', - 'volume': 'volume', - 'auto': 'auto', - 'name': 'name' + 'volume': 'volume' } + self._auto = auto + self._name = name self._port = port self._replicas = replicas self._image = image self._resources = resources self._volume = volume - self._auto = auto - self._name = name @classmethod def from_dict(cls, dikt) -> 'DeploymentAutoArtifactConfig': @@ -79,7 +76,55 @@ def from_dict(cls, dikt) -> 'DeploymentAutoArtifactConfig': return util.deserialize_model(dikt, cls) @property - def port(self): + def auto(self) -> bool: + """Gets the auto of this DeploymentAutoArtifactConfig. + + When true, enables automatic template # noqa: E501 + + :return: The auto of this DeploymentAutoArtifactConfig. + :rtype: bool + """ + return self._auto + + @auto.setter + def auto(self, auto: bool): + """Sets the auto of this DeploymentAutoArtifactConfig. + + When true, enables automatic template # noqa: E501 + + :param auto: The auto of this DeploymentAutoArtifactConfig. + :type auto: bool + """ + if auto is None: + raise ValueError("Invalid value for `auto`, must not be `None`") # noqa: E501 + + self._auto = auto + + @property + def name(self) -> str: + """Gets the name of this DeploymentAutoArtifactConfig. + + # noqa: E501 + + :return: The name of this DeploymentAutoArtifactConfig. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name: str): + """Sets the name of this DeploymentAutoArtifactConfig. + + # noqa: E501 + + :param name: The name of this DeploymentAutoArtifactConfig. + :type name: str + """ + + self._name = name + + @property + def port(self) -> str: """Gets the port of this DeploymentAutoArtifactConfig. Deployment port # noqa: E501 @@ -90,7 +135,7 @@ def port(self): return self._port @port.setter - def port(self, port): + def port(self, port: str): """Sets the port of this DeploymentAutoArtifactConfig. Deployment port # noqa: E501 @@ -102,7 +147,7 @@ def port(self, port): self._port = port @property - def replicas(self): + def replicas(self) -> int: """Gets the replicas of this DeploymentAutoArtifactConfig. Number of replicas # noqa: E501 @@ -113,7 +158,7 @@ def replicas(self): return self._replicas @replicas.setter - def replicas(self, replicas): + def replicas(self, replicas: int): """Sets the replicas of this DeploymentAutoArtifactConfig. Number of replicas # noqa: E501 @@ -125,7 +170,7 @@ def replicas(self, replicas): self._replicas = replicas @property - def image(self): + def image(self) -> str: """Gets the image of this DeploymentAutoArtifactConfig. Image name to use in the deployment. Leave it blank to set from the application's Docker file # noqa: E501 @@ -136,7 +181,7 @@ def image(self): return self._image @image.setter - def image(self, image): + def image(self, image: str): """Sets the image of this DeploymentAutoArtifactConfig. Image name to use in the deployment. Leave it blank to set from the application's Docker file # noqa: E501 @@ -150,7 +195,7 @@ def image(self, image): self._image = image @property - def resources(self): + def resources(self) -> DeploymentResourcesConf: """Gets the resources of this DeploymentAutoArtifactConfig. @@ -160,7 +205,7 @@ def resources(self): return self._resources @resources.setter - def resources(self, resources): + def resources(self, resources: DeploymentResourcesConf): """Sets the resources of this DeploymentAutoArtifactConfig. @@ -171,7 +216,7 @@ def resources(self, resources): self._resources = resources @property - def volume(self): + def volume(self) -> DeploymentVolumeSpec: """Gets the volume of this DeploymentAutoArtifactConfig. @@ -181,7 +226,7 @@ def volume(self): return self._volume @volume.setter - def volume(self, volume): + def volume(self, volume: DeploymentVolumeSpec): """Sets the volume of this DeploymentAutoArtifactConfig. @@ -190,51 +235,3 @@ def volume(self, volume): """ self._volume = volume - - @property - def auto(self): - """Gets the auto of this DeploymentAutoArtifactConfig. - - When true, enables automatic template # noqa: E501 - - :return: The auto of this DeploymentAutoArtifactConfig. - :rtype: bool - """ - return self._auto - - @auto.setter - def auto(self, auto): - """Sets the auto of this DeploymentAutoArtifactConfig. - - When true, enables automatic template # noqa: E501 - - :param auto: The auto of this DeploymentAutoArtifactConfig. - :type auto: bool - """ - if auto is None: - raise ValueError("Invalid value for `auto`, must not be `None`") # noqa: E501 - - self._auto = auto - - @property - def name(self): - """Gets the name of this DeploymentAutoArtifactConfig. - - # noqa: E501 - - :return: The name of this DeploymentAutoArtifactConfig. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """Sets the name of this DeploymentAutoArtifactConfig. - - # noqa: E501 - - :param name: The name of this DeploymentAutoArtifactConfig. - :type name: str - """ - - self._name = name diff --git a/libraries/models/cloudharness_model/models/deployment_resources_conf.py b/libraries/models/cloudharness_model/models/deployment_resources_conf.py index 520e2008..27c09148 100644 --- a/libraries/models/cloudharness_model/models/deployment_resources_conf.py +++ b/libraries/models/cloudharness_model/models/deployment_resources_conf.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.cpu_memory_config import CpuMemoryConfig from cloudharness_model import util @@ -50,7 +47,7 @@ def from_dict(cls, dikt) -> 'DeploymentResourcesConf': return util.deserialize_model(dikt, cls) @property - def requests(self): + def requests(self) -> CpuMemoryConfig: """Gets the requests of this DeploymentResourcesConf. @@ -60,7 +57,7 @@ def requests(self): return self._requests @requests.setter - def requests(self, requests): + def requests(self, requests: CpuMemoryConfig): """Sets the requests of this DeploymentResourcesConf. @@ -71,7 +68,7 @@ def requests(self, requests): self._requests = requests @property - def limits(self): + def limits(self) -> CpuMemoryConfig: """Gets the limits of this DeploymentResourcesConf. @@ -81,7 +78,7 @@ def limits(self): return self._limits @limits.setter - def limits(self, limits): + def limits(self, limits: CpuMemoryConfig): """Sets the limits of this DeploymentResourcesConf. diff --git a/libraries/models/cloudharness_model/models/deployment_volume_spec.py b/libraries/models/cloudharness_model/models/deployment_volume_spec.py index 631bc55d..7fc64914 100644 --- a/libraries/models/cloudharness_model/models/deployment_volume_spec.py +++ b/libraries/models/cloudharness_model/models/deployment_volume_spec.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -15,41 +12,41 @@ class DeploymentVolumeSpec(Model): Do not edit the class manually. """ - def __init__(self, mountpath=None, size=None, usenfs=None, auto=None, name=None): # noqa: E501 + def __init__(self, auto=None, name=None, mountpath=None, size=None, usenfs=None): # noqa: E501 """DeploymentVolumeSpec - a model defined in OpenAPI + :param auto: The auto of this DeploymentVolumeSpec. # noqa: E501 + :type auto: bool + :param name: The name of this DeploymentVolumeSpec. # noqa: E501 + :type name: str :param mountpath: The mountpath of this DeploymentVolumeSpec. # noqa: E501 :type mountpath: str :param size: The size of this DeploymentVolumeSpec. # noqa: E501 :type size: object :param usenfs: The usenfs of this DeploymentVolumeSpec. # noqa: E501 :type usenfs: bool - :param auto: The auto of this DeploymentVolumeSpec. # noqa: E501 - :type auto: bool - :param name: The name of this DeploymentVolumeSpec. # noqa: E501 - :type name: str """ self.openapi_types = { + 'auto': bool, + 'name': str, 'mountpath': str, 'size': object, - 'usenfs': bool, - 'auto': bool, - 'name': str + 'usenfs': bool } self.attribute_map = { + 'auto': 'auto', + 'name': 'name', 'mountpath': 'mountpath', 'size': 'size', - 'usenfs': 'usenfs', - 'auto': 'auto', - 'name': 'name' + 'usenfs': 'usenfs' } + self._auto = auto + self._name = name self._mountpath = mountpath self._size = size self._usenfs = usenfs - self._auto = auto - self._name = name @classmethod def from_dict(cls, dikt) -> 'DeploymentVolumeSpec': @@ -63,7 +60,55 @@ def from_dict(cls, dikt) -> 'DeploymentVolumeSpec': return util.deserialize_model(dikt, cls) @property - def mountpath(self): + def auto(self) -> bool: + """Gets the auto of this DeploymentVolumeSpec. + + When true, enables automatic template # noqa: E501 + + :return: The auto of this DeploymentVolumeSpec. + :rtype: bool + """ + return self._auto + + @auto.setter + def auto(self, auto: bool): + """Sets the auto of this DeploymentVolumeSpec. + + When true, enables automatic template # noqa: E501 + + :param auto: The auto of this DeploymentVolumeSpec. + :type auto: bool + """ + if auto is None: + raise ValueError("Invalid value for `auto`, must not be `None`") # noqa: E501 + + self._auto = auto + + @property + def name(self) -> str: + """Gets the name of this DeploymentVolumeSpec. + + # noqa: E501 + + :return: The name of this DeploymentVolumeSpec. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name: str): + """Sets the name of this DeploymentVolumeSpec. + + # noqa: E501 + + :param name: The name of this DeploymentVolumeSpec. + :type name: str + """ + + self._name = name + + @property + def mountpath(self) -> str: """Gets the mountpath of this DeploymentVolumeSpec. The mount path for the volume # noqa: E501 @@ -74,7 +119,7 @@ def mountpath(self): return self._mountpath @mountpath.setter - def mountpath(self, mountpath): + def mountpath(self, mountpath: str): """Sets the mountpath of this DeploymentVolumeSpec. The mount path for the volume # noqa: E501 @@ -88,7 +133,7 @@ def mountpath(self, mountpath): self._mountpath = mountpath @property - def size(self): + def size(self) -> object: """Gets the size of this DeploymentVolumeSpec. The volume size. E.g. 5Gi # noqa: E501 @@ -99,7 +144,7 @@ def size(self): return self._size @size.setter - def size(self, size): + def size(self, size: object): """Sets the size of this DeploymentVolumeSpec. The volume size. E.g. 5Gi # noqa: E501 @@ -111,7 +156,7 @@ def size(self, size): self._size = size @property - def usenfs(self): + def usenfs(self) -> bool: """Gets the usenfs of this DeploymentVolumeSpec. Set to `true` to use the nfs on the created volume and mount as ReadWriteMany. # noqa: E501 @@ -122,7 +167,7 @@ def usenfs(self): return self._usenfs @usenfs.setter - def usenfs(self, usenfs): + def usenfs(self, usenfs: bool): """Sets the usenfs of this DeploymentVolumeSpec. Set to `true` to use the nfs on the created volume and mount as ReadWriteMany. # noqa: E501 @@ -132,51 +177,3 @@ def usenfs(self, usenfs): """ self._usenfs = usenfs - - @property - def auto(self): - """Gets the auto of this DeploymentVolumeSpec. - - When true, enables automatic template # noqa: E501 - - :return: The auto of this DeploymentVolumeSpec. - :rtype: bool - """ - return self._auto - - @auto.setter - def auto(self, auto): - """Sets the auto of this DeploymentVolumeSpec. - - When true, enables automatic template # noqa: E501 - - :param auto: The auto of this DeploymentVolumeSpec. - :type auto: bool - """ - if auto is None: - raise ValueError("Invalid value for `auto`, must not be `None`") # noqa: E501 - - self._auto = auto - - @property - def name(self): - """Gets the name of this DeploymentVolumeSpec. - - # noqa: E501 - - :return: The name of this DeploymentVolumeSpec. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """Sets the name of this DeploymentVolumeSpec. - - # noqa: E501 - - :param name: The name of this DeploymentVolumeSpec. - :type name: str - """ - - self._name = name diff --git a/libraries/models/cloudharness_model/models/e2_e_tests_config.py b/libraries/models/cloudharness_model/models/e2_e_tests_config.py index e856fe9d..6ae48d93 100644 --- a/libraries/models/cloudharness_model/models/e2_e_tests_config.py +++ b/libraries/models/cloudharness_model/models/e2_e_tests_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -58,7 +55,7 @@ def from_dict(cls, dikt) -> 'E2ETestsConfig': return util.deserialize_model(dikt, cls) @property - def enabled(self): + def enabled(self) -> bool: """Gets the enabled of this E2ETestsConfig. Enables end to end testing for this application (default: false) # noqa: E501 @@ -69,7 +66,7 @@ def enabled(self): return self._enabled @enabled.setter - def enabled(self, enabled): + def enabled(self, enabled: bool): """Sets the enabled of this E2ETestsConfig. Enables end to end testing for this application (default: false) # noqa: E501 @@ -83,7 +80,7 @@ def enabled(self, enabled): self._enabled = enabled @property - def smoketest(self): + def smoketest(self) -> bool: """Gets the smoketest of this E2ETestsConfig. Specify whether to run the common smoke tests # noqa: E501 @@ -94,7 +91,7 @@ def smoketest(self): return self._smoketest @smoketest.setter - def smoketest(self, smoketest): + def smoketest(self, smoketest: bool): """Sets the smoketest of this E2ETestsConfig. Specify whether to run the common smoke tests # noqa: E501 @@ -108,7 +105,7 @@ def smoketest(self, smoketest): self._smoketest = smoketest @property - def ignore_console_errors(self): + def ignore_console_errors(self) -> bool: """Gets the ignore_console_errors of this E2ETestsConfig. # noqa: E501 @@ -119,7 +116,7 @@ def ignore_console_errors(self): return self._ignore_console_errors @ignore_console_errors.setter - def ignore_console_errors(self, ignore_console_errors): + def ignore_console_errors(self, ignore_console_errors: bool): """Sets the ignore_console_errors of this E2ETestsConfig. # noqa: E501 @@ -131,7 +128,7 @@ def ignore_console_errors(self, ignore_console_errors): self._ignore_console_errors = ignore_console_errors @property - def ignore_request_errors(self): + def ignore_request_errors(self) -> bool: """Gets the ignore_request_errors of this E2ETestsConfig. # noqa: E501 @@ -142,7 +139,7 @@ def ignore_request_errors(self): return self._ignore_request_errors @ignore_request_errors.setter - def ignore_request_errors(self, ignore_request_errors): + def ignore_request_errors(self, ignore_request_errors: bool): """Sets the ignore_request_errors of this E2ETestsConfig. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/file_resources_config.py b/libraries/models/cloudharness_model/models/file_resources_config.py index da5993b4..fff73422 100644 --- a/libraries/models/cloudharness_model/models/file_resources_config.py +++ b/libraries/models/cloudharness_model/models/file_resources_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model import re from cloudharness_model import util @@ -55,7 +52,7 @@ def from_dict(cls, dikt) -> 'FileResourcesConfig': return util.deserialize_model(dikt, cls) @property - def name(self): + def name(self) -> str: """Gets the name of this FileResourcesConfig. # noqa: E501 @@ -66,7 +63,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this FileResourcesConfig. # noqa: E501 @@ -82,7 +79,7 @@ def name(self, name): self._name = name @property - def src(self): + def src(self) -> str: """Gets the src of this FileResourcesConfig. # noqa: E501 @@ -93,7 +90,7 @@ def src(self): return self._src @src.setter - def src(self, src): + def src(self, src: str): """Sets the src of this FileResourcesConfig. # noqa: E501 @@ -109,7 +106,7 @@ def src(self, src): self._src = src @property - def dst(self): + def dst(self) -> str: """Gets the dst of this FileResourcesConfig. # noqa: E501 @@ -120,7 +117,7 @@ def dst(self): return self._dst @dst.setter - def dst(self, dst): + def dst(self, dst: str): """Sets the dst of this FileResourcesConfig. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/git_dependency_config.py b/libraries/models/cloudharness_model/models/git_dependency_config.py index b2a17690..8e3acf61 100644 --- a/libraries/models/cloudharness_model/models/git_dependency_config.py +++ b/libraries/models/cloudharness_model/models/git_dependency_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -53,7 +50,7 @@ def from_dict(cls, dikt) -> 'GitDependencyConfig': return util.deserialize_model(dikt, cls) @property - def url(self): + def url(self) -> str: """Gets the url of this GitDependencyConfig. @@ -63,7 +60,7 @@ def url(self): return self._url @url.setter - def url(self, url): + def url(self, url: str): """Sets the url of this GitDependencyConfig. @@ -76,7 +73,7 @@ def url(self, url): self._url = url @property - def branch_tag(self): + def branch_tag(self) -> str: """Gets the branch_tag of this GitDependencyConfig. @@ -86,7 +83,7 @@ def branch_tag(self): return self._branch_tag @branch_tag.setter - def branch_tag(self, branch_tag): + def branch_tag(self, branch_tag: str): """Sets the branch_tag of this GitDependencyConfig. @@ -99,7 +96,7 @@ def branch_tag(self, branch_tag): self._branch_tag = branch_tag @property - def path(self): + def path(self) -> str: """Gets the path of this GitDependencyConfig. Defines the path where the repo is cloned. default: /git # noqa: E501 @@ -110,7 +107,7 @@ def path(self): return self._path @path.setter - def path(self, path): + def path(self, path: str): """Sets the path of this GitDependencyConfig. Defines the path where the repo is cloned. default: /git # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/harness_main_config.py b/libraries/models/cloudharness_model/models/harness_main_config.py index 7f18e82d..6691ed07 100644 --- a/libraries/models/cloudharness_model/models/harness_main_config.py +++ b/libraries/models/cloudharness_model/models/harness_main_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.application_config import ApplicationConfig from cloudharness_model.models.backup_config import BackupConfig from cloudharness_model.models.name_value import NameValue @@ -23,7 +20,7 @@ class HarnessMainConfig(Model): Do not edit the class manually. """ - def __init__(self, local=None, secured_gatekeepers=None, domain=None, namespace=None, mainapp=None, registry=None, tag=None, apps=None, env=None, privenv=None, backup=None, name=None, task_images=None, build_hash=None): # noqa: E501 + def __init__(self, local=None, secured_gatekeepers=None, domain=None, namespace=None, mainapp=None, registry=None, tag=None, apps=None, env=None, privenv=None, backup=None, name=None, task_images=None, build_hash=None, envmap=None): # noqa: E501 """HarnessMainConfig - a model defined in OpenAPI :param local: The local of this HarnessMainConfig. # noqa: E501 @@ -54,6 +51,8 @@ def __init__(self, local=None, secured_gatekeepers=None, domain=None, namespace= :type task_images: Dict[str, object] :param build_hash: The build_hash of this HarnessMainConfig. # noqa: E501 :type build_hash: str + :param envmap: The envmap of this HarnessMainConfig. # noqa: E501 + :type envmap: Dict[str, object] """ self.openapi_types = { 'local': bool, @@ -69,7 +68,8 @@ def __init__(self, local=None, secured_gatekeepers=None, domain=None, namespace= 'backup': BackupConfig, 'name': str, 'task_images': Dict[str, object], - 'build_hash': str + 'build_hash': str, + 'envmap': Dict[str, object] } self.attribute_map = { @@ -86,7 +86,8 @@ def __init__(self, local=None, secured_gatekeepers=None, domain=None, namespace= 'backup': 'backup', 'name': 'name', 'task_images': 'task-images', - 'build_hash': 'build_hash' + 'build_hash': 'build_hash', + 'envmap': 'envmap' } self._local = local @@ -103,6 +104,7 @@ def __init__(self, local=None, secured_gatekeepers=None, domain=None, namespace= self._name = name self._task_images = task_images self._build_hash = build_hash + self._envmap = envmap @classmethod def from_dict(cls, dikt) -> 'HarnessMainConfig': @@ -116,7 +118,7 @@ def from_dict(cls, dikt) -> 'HarnessMainConfig': return util.deserialize_model(dikt, cls) @property - def local(self): + def local(self) -> bool: """Gets the local of this HarnessMainConfig. If set to true, local DNS mapping is added to pods. # noqa: E501 @@ -127,7 +129,7 @@ def local(self): return self._local @local.setter - def local(self, local): + def local(self, local: bool): """Sets the local of this HarnessMainConfig. If set to true, local DNS mapping is added to pods. # noqa: E501 @@ -141,7 +143,7 @@ def local(self, local): self._local = local @property - def secured_gatekeepers(self): + def secured_gatekeepers(self) -> bool: """Gets the secured_gatekeepers of this HarnessMainConfig. Enables/disables Gatekeepers on secured applications. Set to false for testing/development # noqa: E501 @@ -152,7 +154,7 @@ def secured_gatekeepers(self): return self._secured_gatekeepers @secured_gatekeepers.setter - def secured_gatekeepers(self, secured_gatekeepers): + def secured_gatekeepers(self, secured_gatekeepers: bool): """Sets the secured_gatekeepers of this HarnessMainConfig. Enables/disables Gatekeepers on secured applications. Set to false for testing/development # noqa: E501 @@ -166,7 +168,7 @@ def secured_gatekeepers(self, secured_gatekeepers): self._secured_gatekeepers = secured_gatekeepers @property - def domain(self): + def domain(self) -> str: """Gets the domain of this HarnessMainConfig. The root domain # noqa: E501 @@ -177,7 +179,7 @@ def domain(self): return self._domain @domain.setter - def domain(self, domain): + def domain(self, domain: str): """Sets the domain of this HarnessMainConfig. The root domain # noqa: E501 @@ -191,7 +193,7 @@ def domain(self, domain): self._domain = domain @property - def namespace(self): + def namespace(self) -> str: """Gets the namespace of this HarnessMainConfig. The K8s namespace. # noqa: E501 @@ -202,7 +204,7 @@ def namespace(self): return self._namespace @namespace.setter - def namespace(self, namespace): + def namespace(self, namespace: str): """Sets the namespace of this HarnessMainConfig. The K8s namespace. # noqa: E501 @@ -216,7 +218,7 @@ def namespace(self, namespace): self._namespace = namespace @property - def mainapp(self): + def mainapp(self) -> str: """Gets the mainapp of this HarnessMainConfig. Defines the app to map to the root domain # noqa: E501 @@ -227,7 +229,7 @@ def mainapp(self): return self._mainapp @mainapp.setter - def mainapp(self, mainapp): + def mainapp(self, mainapp: str): """Sets the mainapp of this HarnessMainConfig. Defines the app to map to the root domain # noqa: E501 @@ -241,7 +243,7 @@ def mainapp(self, mainapp): self._mainapp = mainapp @property - def registry(self): + def registry(self) -> RegistryConfig: """Gets the registry of this HarnessMainConfig. @@ -251,7 +253,7 @@ def registry(self): return self._registry @registry.setter - def registry(self, registry): + def registry(self, registry: RegistryConfig): """Sets the registry of this HarnessMainConfig. @@ -262,7 +264,7 @@ def registry(self, registry): self._registry = registry @property - def tag(self): + def tag(self) -> str: """Gets the tag of this HarnessMainConfig. Docker tag used to push/pull the built images. # noqa: E501 @@ -273,7 +275,7 @@ def tag(self): return self._tag @tag.setter - def tag(self, tag): + def tag(self, tag: str): """Sets the tag of this HarnessMainConfig. Docker tag used to push/pull the built images. # noqa: E501 @@ -285,7 +287,7 @@ def tag(self, tag): self._tag = tag @property - def apps(self): + def apps(self) -> Dict[str, ApplicationConfig]: """Gets the apps of this HarnessMainConfig. # noqa: E501 @@ -296,7 +298,7 @@ def apps(self): return self._apps @apps.setter - def apps(self, apps): + def apps(self, apps: Dict[str, ApplicationConfig]): """Sets the apps of this HarnessMainConfig. # noqa: E501 @@ -310,10 +312,10 @@ def apps(self, apps): self._apps = apps @property - def env(self): + def env(self) -> List[NameValue]: """Gets the env of this HarnessMainConfig. - Environmental variables added to all pods # noqa: E501 + Environmental variables added to all pods (deprecated, please use envmap) # noqa: E501 :return: The env of this HarnessMainConfig. :rtype: List[NameValue] @@ -321,10 +323,10 @@ def env(self): return self._env @env.setter - def env(self, env): + def env(self, env: List[NameValue]): """Sets the env of this HarnessMainConfig. - Environmental variables added to all pods # noqa: E501 + Environmental variables added to all pods (deprecated, please use envmap) # noqa: E501 :param env: The env of this HarnessMainConfig. :type env: List[NameValue] @@ -333,7 +335,7 @@ def env(self, env): self._env = env @property - def privenv(self): + def privenv(self) -> NameValue: """Gets the privenv of this HarnessMainConfig. @@ -343,7 +345,7 @@ def privenv(self): return self._privenv @privenv.setter - def privenv(self, privenv): + def privenv(self, privenv: NameValue): """Sets the privenv of this HarnessMainConfig. @@ -354,7 +356,7 @@ def privenv(self, privenv): self._privenv = privenv @property - def backup(self): + def backup(self) -> BackupConfig: """Gets the backup of this HarnessMainConfig. @@ -364,7 +366,7 @@ def backup(self): return self._backup @backup.setter - def backup(self, backup): + def backup(self, backup: BackupConfig): """Sets the backup of this HarnessMainConfig. @@ -375,7 +377,7 @@ def backup(self, backup): self._backup = backup @property - def name(self): + def name(self) -> str: """Gets the name of this HarnessMainConfig. Base name # noqa: E501 @@ -386,7 +388,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this HarnessMainConfig. Base name # noqa: E501 @@ -398,7 +400,7 @@ def name(self, name): self._name = name @property - def task_images(self): + def task_images(self) -> Dict[str, object]: """Gets the task_images of this HarnessMainConfig. # noqa: E501 @@ -409,7 +411,7 @@ def task_images(self): return self._task_images @task_images.setter - def task_images(self, task_images): + def task_images(self, task_images: Dict[str, object]): """Sets the task_images of this HarnessMainConfig. # noqa: E501 @@ -421,7 +423,7 @@ def task_images(self, task_images): self._task_images = task_images @property - def build_hash(self): + def build_hash(self) -> str: """Gets the build_hash of this HarnessMainConfig. # noqa: E501 @@ -432,7 +434,7 @@ def build_hash(self): return self._build_hash @build_hash.setter - def build_hash(self, build_hash): + def build_hash(self, build_hash: str): """Sets the build_hash of this HarnessMainConfig. # noqa: E501 @@ -442,3 +444,26 @@ def build_hash(self, build_hash): """ self._build_hash = build_hash + + @property + def envmap(self) -> Dict[str, object]: + """Gets the envmap of this HarnessMainConfig. + + # noqa: E501 + + :return: The envmap of this HarnessMainConfig. + :rtype: Dict[str, object] + """ + return self._envmap + + @envmap.setter + def envmap(self, envmap: Dict[str, object]): + """Sets the envmap of this HarnessMainConfig. + + # noqa: E501 + + :param envmap: The envmap of this HarnessMainConfig. + :type envmap: Dict[str, object] + """ + + self._envmap = envmap diff --git a/libraries/models/cloudharness_model/models/ingress_config.py b/libraries/models/cloudharness_model/models/ingress_config.py index 6253941a..e0da288f 100644 --- a/libraries/models/cloudharness_model/models/ingress_config.py +++ b/libraries/models/cloudharness_model/models/ingress_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.ingress_config_all_of_letsencrypt import IngressConfigAllOfLetsencrypt from cloudharness_model import util @@ -17,36 +14,36 @@ class IngressConfig(Model): Do not edit the class manually. """ - def __init__(self, ssl_redirect=None, letsencrypt=None, auto=None, name=None): # noqa: E501 + def __init__(self, auto=None, name=None, ssl_redirect=None, letsencrypt=None): # noqa: E501 """IngressConfig - a model defined in OpenAPI - :param ssl_redirect: The ssl_redirect of this IngressConfig. # noqa: E501 - :type ssl_redirect: bool - :param letsencrypt: The letsencrypt of this IngressConfig. # noqa: E501 - :type letsencrypt: IngressConfigAllOfLetsencrypt :param auto: The auto of this IngressConfig. # noqa: E501 :type auto: bool :param name: The name of this IngressConfig. # noqa: E501 :type name: str + :param ssl_redirect: The ssl_redirect of this IngressConfig. # noqa: E501 + :type ssl_redirect: bool + :param letsencrypt: The letsencrypt of this IngressConfig. # noqa: E501 + :type letsencrypt: IngressConfigAllOfLetsencrypt """ self.openapi_types = { - 'ssl_redirect': bool, - 'letsencrypt': IngressConfigAllOfLetsencrypt, 'auto': bool, - 'name': str + 'name': str, + 'ssl_redirect': bool, + 'letsencrypt': IngressConfigAllOfLetsencrypt } self.attribute_map = { - 'ssl_redirect': 'ssl_redirect', - 'letsencrypt': 'letsencrypt', 'auto': 'auto', - 'name': 'name' + 'name': 'name', + 'ssl_redirect': 'ssl_redirect', + 'letsencrypt': 'letsencrypt' } - self._ssl_redirect = ssl_redirect - self._letsencrypt = letsencrypt self._auto = auto self._name = name + self._ssl_redirect = ssl_redirect + self._letsencrypt = letsencrypt @classmethod def from_dict(cls, dikt) -> 'IngressConfig': @@ -60,51 +57,7 @@ def from_dict(cls, dikt) -> 'IngressConfig': return util.deserialize_model(dikt, cls) @property - def ssl_redirect(self): - """Gets the ssl_redirect of this IngressConfig. - - # noqa: E501 - - :return: The ssl_redirect of this IngressConfig. - :rtype: bool - """ - return self._ssl_redirect - - @ssl_redirect.setter - def ssl_redirect(self, ssl_redirect): - """Sets the ssl_redirect of this IngressConfig. - - # noqa: E501 - - :param ssl_redirect: The ssl_redirect of this IngressConfig. - :type ssl_redirect: bool - """ - - self._ssl_redirect = ssl_redirect - - @property - def letsencrypt(self): - """Gets the letsencrypt of this IngressConfig. - - - :return: The letsencrypt of this IngressConfig. - :rtype: IngressConfigAllOfLetsencrypt - """ - return self._letsencrypt - - @letsencrypt.setter - def letsencrypt(self, letsencrypt): - """Sets the letsencrypt of this IngressConfig. - - - :param letsencrypt: The letsencrypt of this IngressConfig. - :type letsencrypt: IngressConfigAllOfLetsencrypt - """ - - self._letsencrypt = letsencrypt - - @property - def auto(self): + def auto(self) -> bool: """Gets the auto of this IngressConfig. When true, enables automatic template # noqa: E501 @@ -115,7 +68,7 @@ def auto(self): return self._auto @auto.setter - def auto(self, auto): + def auto(self, auto: bool): """Sets the auto of this IngressConfig. When true, enables automatic template # noqa: E501 @@ -129,7 +82,7 @@ def auto(self, auto): self._auto = auto @property - def name(self): + def name(self) -> str: """Gets the name of this IngressConfig. # noqa: E501 @@ -140,7 +93,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this IngressConfig. # noqa: E501 @@ -150,3 +103,47 @@ def name(self, name): """ self._name = name + + @property + def ssl_redirect(self) -> bool: + """Gets the ssl_redirect of this IngressConfig. + + # noqa: E501 + + :return: The ssl_redirect of this IngressConfig. + :rtype: bool + """ + return self._ssl_redirect + + @ssl_redirect.setter + def ssl_redirect(self, ssl_redirect: bool): + """Sets the ssl_redirect of this IngressConfig. + + # noqa: E501 + + :param ssl_redirect: The ssl_redirect of this IngressConfig. + :type ssl_redirect: bool + """ + + self._ssl_redirect = ssl_redirect + + @property + def letsencrypt(self) -> IngressConfigAllOfLetsencrypt: + """Gets the letsencrypt of this IngressConfig. + + + :return: The letsencrypt of this IngressConfig. + :rtype: IngressConfigAllOfLetsencrypt + """ + return self._letsencrypt + + @letsencrypt.setter + def letsencrypt(self, letsencrypt: IngressConfigAllOfLetsencrypt): + """Sets the letsencrypt of this IngressConfig. + + + :param letsencrypt: The letsencrypt of this IngressConfig. + :type letsencrypt: IngressConfigAllOfLetsencrypt + """ + + self._letsencrypt = letsencrypt diff --git a/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py b/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py index 0e8a5ab8..467e18a2 100644 --- a/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py +++ b/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -43,7 +40,7 @@ def from_dict(cls, dikt) -> 'IngressConfigAllOfLetsencrypt': return util.deserialize_model(dikt, cls) @property - def email(self): + def email(self) -> str: """Gets the email of this IngressConfigAllOfLetsencrypt. @@ -53,7 +50,7 @@ def email(self): return self._email @email.setter - def email(self, email): + def email(self, email: str): """Sets the email of this IngressConfigAllOfLetsencrypt. diff --git a/libraries/models/cloudharness_model/models/jupyter_hub_config.py b/libraries/models/cloudharness_model/models/jupyter_hub_config.py index 1f04fa73..5aaa9850 100644 --- a/libraries/models/cloudharness_model/models/jupyter_hub_config.py +++ b/libraries/models/cloudharness_model/models/jupyter_hub_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -58,7 +55,7 @@ def from_dict(cls, dikt) -> 'JupyterHubConfig': return util.deserialize_model(dikt, cls) @property - def args(self): + def args(self) -> List[str]: """Gets the args of this JupyterHubConfig. arguments passed to the container # noqa: E501 @@ -69,7 +66,7 @@ def args(self): return self._args @args.setter - def args(self, args): + def args(self, args: List[str]): """Sets the args of this JupyterHubConfig. arguments passed to the container # noqa: E501 @@ -81,7 +78,7 @@ def args(self, args): self._args = args @property - def extra_config(self): + def extra_config(self) -> Dict[str, object]: """Gets the extra_config of this JupyterHubConfig. # noqa: E501 @@ -92,7 +89,7 @@ def extra_config(self): return self._extra_config @extra_config.setter - def extra_config(self, extra_config): + def extra_config(self, extra_config: Dict[str, object]): """Sets the extra_config of this JupyterHubConfig. # noqa: E501 @@ -104,7 +101,7 @@ def extra_config(self, extra_config): self._extra_config = extra_config @property - def spawner_extra_config(self): + def spawner_extra_config(self) -> Dict[str, object]: """Gets the spawner_extra_config of this JupyterHubConfig. # noqa: E501 @@ -115,7 +112,7 @@ def spawner_extra_config(self): return self._spawner_extra_config @spawner_extra_config.setter - def spawner_extra_config(self, spawner_extra_config): + def spawner_extra_config(self, spawner_extra_config: Dict[str, object]): """Sets the spawner_extra_config of this JupyterHubConfig. # noqa: E501 @@ -127,7 +124,7 @@ def spawner_extra_config(self, spawner_extra_config): self._spawner_extra_config = spawner_extra_config @property - def application_hook(self): + def application_hook(self) -> object: """Gets the application_hook of this JupyterHubConfig. change the hook function (advanced) Specify the Python name of the function (full module path, the module must be installed in the Docker image) # noqa: E501 @@ -138,7 +135,7 @@ def application_hook(self): return self._application_hook @application_hook.setter - def application_hook(self, application_hook): + def application_hook(self, application_hook: object): """Sets the application_hook of this JupyterHubConfig. change the hook function (advanced) Specify the Python name of the function (full module path, the module must be installed in the Docker image) # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/name_value.py b/libraries/models/cloudharness_model/models/name_value.py index f4b75cdd..abf07fe6 100644 --- a/libraries/models/cloudharness_model/models/name_value.py +++ b/libraries/models/cloudharness_model/models/name_value.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -48,7 +45,7 @@ def from_dict(cls, dikt) -> 'NameValue': return util.deserialize_model(dikt, cls) @property - def name(self): + def name(self) -> str: """Gets the name of this NameValue. # noqa: E501 @@ -59,7 +56,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this NameValue. # noqa: E501 @@ -73,7 +70,7 @@ def name(self, name): self._name = name @property - def value(self): + def value(self) -> str: """Gets the value of this NameValue. # noqa: E501 @@ -84,7 +81,7 @@ def value(self): return self._value @value.setter - def value(self, value): + def value(self, value: str): """Sets the value of this NameValue. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/registry_config.py b/libraries/models/cloudharness_model/models/registry_config.py index 79f27027..7ce48e9c 100644 --- a/libraries/models/cloudharness_model/models/registry_config.py +++ b/libraries/models/cloudharness_model/models/registry_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -48,7 +45,7 @@ def from_dict(cls, dikt) -> 'RegistryConfig': return util.deserialize_model(dikt, cls) @property - def name(self): + def name(self) -> str: """Gets the name of this RegistryConfig. # noqa: E501 @@ -59,7 +56,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this RegistryConfig. # noqa: E501 @@ -73,7 +70,7 @@ def name(self, name): self._name = name @property - def secret(self): + def secret(self) -> str: """Gets the secret of this RegistryConfig. Optional secret used for pulling from docker registry. # noqa: E501 @@ -84,7 +81,7 @@ def secret(self): return self._secret @secret.setter - def secret(self, secret): + def secret(self, secret: str): """Sets the secret of this RegistryConfig. Optional secret used for pulling from docker registry. # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/service_auto_artifact_config.py b/libraries/models/cloudharness_model/models/service_auto_artifact_config.py index 8d14ac42..77bded86 100644 --- a/libraries/models/cloudharness_model/models/service_auto_artifact_config.py +++ b/libraries/models/cloudharness_model/models/service_auto_artifact_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -15,31 +12,31 @@ class ServiceAutoArtifactConfig(Model): Do not edit the class manually. """ - def __init__(self, port=None, auto=None, name=None): # noqa: E501 + def __init__(self, auto=None, name=None, port=None): # noqa: E501 """ServiceAutoArtifactConfig - a model defined in OpenAPI - :param port: The port of this ServiceAutoArtifactConfig. # noqa: E501 - :type port: int :param auto: The auto of this ServiceAutoArtifactConfig. # noqa: E501 :type auto: bool :param name: The name of this ServiceAutoArtifactConfig. # noqa: E501 :type name: str + :param port: The port of this ServiceAutoArtifactConfig. # noqa: E501 + :type port: int """ self.openapi_types = { - 'port': int, 'auto': bool, - 'name': str + 'name': str, + 'port': int } self.attribute_map = { - 'port': 'port', 'auto': 'auto', - 'name': 'name' + 'name': 'name', + 'port': 'port' } - self._port = port self._auto = auto self._name = name + self._port = port @classmethod def from_dict(cls, dikt) -> 'ServiceAutoArtifactConfig': @@ -53,30 +50,7 @@ def from_dict(cls, dikt) -> 'ServiceAutoArtifactConfig': return util.deserialize_model(dikt, cls) @property - def port(self): - """Gets the port of this ServiceAutoArtifactConfig. - - Service port # noqa: E501 - - :return: The port of this ServiceAutoArtifactConfig. - :rtype: int - """ - return self._port - - @port.setter - def port(self, port): - """Sets the port of this ServiceAutoArtifactConfig. - - Service port # noqa: E501 - - :param port: The port of this ServiceAutoArtifactConfig. - :type port: int - """ - - self._port = port - - @property - def auto(self): + def auto(self) -> bool: """Gets the auto of this ServiceAutoArtifactConfig. When true, enables automatic template # noqa: E501 @@ -87,7 +61,7 @@ def auto(self): return self._auto @auto.setter - def auto(self, auto): + def auto(self, auto: bool): """Sets the auto of this ServiceAutoArtifactConfig. When true, enables automatic template # noqa: E501 @@ -101,7 +75,7 @@ def auto(self, auto): self._auto = auto @property - def name(self): + def name(self) -> str: """Gets the name of this ServiceAutoArtifactConfig. # noqa: E501 @@ -112,7 +86,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this ServiceAutoArtifactConfig. # noqa: E501 @@ -122,3 +96,26 @@ def name(self, name): """ self._name = name + + @property + def port(self) -> int: + """Gets the port of this ServiceAutoArtifactConfig. + + Service port # noqa: E501 + + :return: The port of this ServiceAutoArtifactConfig. + :rtype: int + """ + return self._port + + @port.setter + def port(self, port: int): + """Sets the port of this ServiceAutoArtifactConfig. + + Service port # noqa: E501 + + :param port: The port of this ServiceAutoArtifactConfig. + :type port: int + """ + + self._port = port diff --git a/libraries/models/cloudharness_model/models/unit_tests_config.py b/libraries/models/cloudharness_model/models/unit_tests_config.py index 9b7813c8..680d984a 100644 --- a/libraries/models/cloudharness_model/models/unit_tests_config.py +++ b/libraries/models/cloudharness_model/models/unit_tests_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -48,7 +45,7 @@ def from_dict(cls, dikt) -> 'UnitTestsConfig': return util.deserialize_model(dikt, cls) @property - def enabled(self): + def enabled(self) -> bool: """Gets the enabled of this UnitTestsConfig. Enables unit tests for this application (default: true) # noqa: E501 @@ -59,7 +56,7 @@ def enabled(self): return self._enabled @enabled.setter - def enabled(self, enabled): + def enabled(self, enabled: bool): """Sets the enabled of this UnitTestsConfig. Enables unit tests for this application (default: true) # noqa: E501 @@ -73,7 +70,7 @@ def enabled(self, enabled): self._enabled = enabled @property - def commands(self): + def commands(self) -> List[str]: """Gets the commands of this UnitTestsConfig. Commands to run unit tests # noqa: E501 @@ -84,7 +81,7 @@ def commands(self): return self._commands @commands.setter - def commands(self, commands): + def commands(self, commands: List[str]): """Sets the commands of this UnitTestsConfig. Commands to run unit tests # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/uri_role_mapping_config.py b/libraries/models/cloudharness_model/models/uri_role_mapping_config.py index 046becca..649ae22e 100644 --- a/libraries/models/cloudharness_model/models/uri_role_mapping_config.py +++ b/libraries/models/cloudharness_model/models/uri_role_mapping_config.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model import re from cloudharness_model import util @@ -50,7 +47,7 @@ def from_dict(cls, dikt) -> 'UriRoleMappingConfig': return util.deserialize_model(dikt, cls) @property - def uri(self): + def uri(self) -> str: """Gets the uri of this UriRoleMappingConfig. # noqa: E501 @@ -61,7 +58,7 @@ def uri(self): return self._uri @uri.setter - def uri(self, uri): + def uri(self, uri: str): """Sets the uri of this UriRoleMappingConfig. # noqa: E501 @@ -77,7 +74,7 @@ def uri(self, uri): self._uri = uri @property - def roles(self): + def roles(self) -> List[str]: """Gets the roles of this UriRoleMappingConfig. Roles allowed to access the present uri # noqa: E501 @@ -88,7 +85,7 @@ def roles(self): return self._roles @roles.setter - def roles(self, roles): + def roles(self, roles: List[str]): """Sets the roles of this UriRoleMappingConfig. Roles allowed to access the present uri # noqa: E501 diff --git a/libraries/models/cloudharness_model/models/user.py b/libraries/models/cloudharness_model/models/user.py index 3d1c1895..0676fbae 100644 --- a/libraries/models/cloudharness_model/models/user.py +++ b/libraries/models/cloudharness_model/models/user.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model.models.user_credential import UserCredential from cloudharness_model import util @@ -135,7 +132,7 @@ def from_dict(cls, dikt) -> 'User': return util.deserialize_model(dikt, cls) @property - def access(self): + def access(self) -> Dict[str, object]: """Gets the access of this User. @@ -145,7 +142,7 @@ def access(self): return self._access @access.setter - def access(self, access): + def access(self, access: Dict[str, object]): """Sets the access of this User. @@ -156,7 +153,7 @@ def access(self, access): self._access = access @property - def attributes(self): + def attributes(self) -> Dict[str, object]: """Gets the attributes of this User. @@ -166,7 +163,7 @@ def attributes(self): return self._attributes @attributes.setter - def attributes(self, attributes): + def attributes(self, attributes: Dict[str, object]): """Sets the attributes of this User. @@ -177,7 +174,7 @@ def attributes(self, attributes): self._attributes = attributes @property - def client_roles(self): + def client_roles(self) -> Dict[str, object]: """Gets the client_roles of this User. @@ -187,7 +184,7 @@ def client_roles(self): return self._client_roles @client_roles.setter - def client_roles(self, client_roles): + def client_roles(self, client_roles: Dict[str, object]): """Sets the client_roles of this User. @@ -198,7 +195,7 @@ def client_roles(self, client_roles): self._client_roles = client_roles @property - def created_timestamp(self): + def created_timestamp(self) -> int: """Gets the created_timestamp of this User. @@ -208,7 +205,7 @@ def created_timestamp(self): return self._created_timestamp @created_timestamp.setter - def created_timestamp(self, created_timestamp): + def created_timestamp(self, created_timestamp: int): """Sets the created_timestamp of this User. @@ -219,7 +216,7 @@ def created_timestamp(self, created_timestamp): self._created_timestamp = created_timestamp @property - def credentials(self): + def credentials(self) -> List[UserCredential]: """Gets the credentials of this User. @@ -229,7 +226,7 @@ def credentials(self): return self._credentials @credentials.setter - def credentials(self, credentials): + def credentials(self, credentials: List[UserCredential]): """Sets the credentials of this User. @@ -240,7 +237,7 @@ def credentials(self, credentials): self._credentials = credentials @property - def disableable_credential_types(self): + def disableable_credential_types(self) -> List[str]: """Gets the disableable_credential_types of this User. @@ -250,7 +247,7 @@ def disableable_credential_types(self): return self._disableable_credential_types @disableable_credential_types.setter - def disableable_credential_types(self, disableable_credential_types): + def disableable_credential_types(self, disableable_credential_types: List[str]): """Sets the disableable_credential_types of this User. @@ -261,7 +258,7 @@ def disableable_credential_types(self, disableable_credential_types): self._disableable_credential_types = disableable_credential_types @property - def email(self): + def email(self) -> str: """Gets the email of this User. @@ -271,7 +268,7 @@ def email(self): return self._email @email.setter - def email(self, email): + def email(self, email: str): """Sets the email of this User. @@ -282,7 +279,7 @@ def email(self, email): self._email = email @property - def email_verified(self): + def email_verified(self) -> bool: """Gets the email_verified of this User. @@ -292,7 +289,7 @@ def email_verified(self): return self._email_verified @email_verified.setter - def email_verified(self, email_verified): + def email_verified(self, email_verified: bool): """Sets the email_verified of this User. @@ -303,7 +300,7 @@ def email_verified(self, email_verified): self._email_verified = email_verified @property - def enabled(self): + def enabled(self) -> bool: """Gets the enabled of this User. @@ -313,7 +310,7 @@ def enabled(self): return self._enabled @enabled.setter - def enabled(self, enabled): + def enabled(self, enabled: bool): """Sets the enabled of this User. @@ -324,7 +321,7 @@ def enabled(self, enabled): self._enabled = enabled @property - def federation_link(self): + def federation_link(self) -> str: """Gets the federation_link of this User. @@ -334,7 +331,7 @@ def federation_link(self): return self._federation_link @federation_link.setter - def federation_link(self, federation_link): + def federation_link(self, federation_link: str): """Sets the federation_link of this User. @@ -345,7 +342,7 @@ def federation_link(self, federation_link): self._federation_link = federation_link @property - def first_name(self): + def first_name(self) -> str: """Gets the first_name of this User. @@ -355,7 +352,7 @@ def first_name(self): return self._first_name @first_name.setter - def first_name(self, first_name): + def first_name(self, first_name: str): """Sets the first_name of this User. @@ -366,7 +363,7 @@ def first_name(self, first_name): self._first_name = first_name @property - def groups(self): + def groups(self) -> List[str]: """Gets the groups of this User. @@ -376,7 +373,7 @@ def groups(self): return self._groups @groups.setter - def groups(self, groups): + def groups(self, groups: List[str]): """Sets the groups of this User. @@ -387,7 +384,7 @@ def groups(self, groups): self._groups = groups @property - def id(self): + def id(self) -> str: """Gets the id of this User. @@ -397,7 +394,7 @@ def id(self): return self._id @id.setter - def id(self, id): + def id(self, id: str): """Sets the id of this User. @@ -408,7 +405,7 @@ def id(self, id): self._id = id @property - def last_name(self): + def last_name(self) -> str: """Gets the last_name of this User. @@ -418,7 +415,7 @@ def last_name(self): return self._last_name @last_name.setter - def last_name(self, last_name): + def last_name(self, last_name: str): """Sets the last_name of this User. @@ -429,7 +426,7 @@ def last_name(self, last_name): self._last_name = last_name @property - def realm_roles(self): + def realm_roles(self) -> List[str]: """Gets the realm_roles of this User. @@ -439,7 +436,7 @@ def realm_roles(self): return self._realm_roles @realm_roles.setter - def realm_roles(self, realm_roles): + def realm_roles(self, realm_roles: List[str]): """Sets the realm_roles of this User. @@ -450,7 +447,7 @@ def realm_roles(self, realm_roles): self._realm_roles = realm_roles @property - def required_actions(self): + def required_actions(self) -> List[str]: """Gets the required_actions of this User. @@ -460,7 +457,7 @@ def required_actions(self): return self._required_actions @required_actions.setter - def required_actions(self, required_actions): + def required_actions(self, required_actions: List[str]): """Sets the required_actions of this User. @@ -471,7 +468,7 @@ def required_actions(self, required_actions): self._required_actions = required_actions @property - def service_account_client_id(self): + def service_account_client_id(self) -> str: """Gets the service_account_client_id of this User. @@ -481,7 +478,7 @@ def service_account_client_id(self): return self._service_account_client_id @service_account_client_id.setter - def service_account_client_id(self, service_account_client_id): + def service_account_client_id(self, service_account_client_id: str): """Sets the service_account_client_id of this User. @@ -492,7 +489,7 @@ def service_account_client_id(self, service_account_client_id): self._service_account_client_id = service_account_client_id @property - def username(self): + def username(self) -> str: """Gets the username of this User. @@ -502,7 +499,7 @@ def username(self): return self._username @username.setter - def username(self, username): + def username(self, username: str): """Sets the username of this User. @@ -513,7 +510,7 @@ def username(self, username): self._username = username @property - def additional_properties(self): + def additional_properties(self) -> object: """Gets the additional_properties of this User. @@ -523,7 +520,7 @@ def additional_properties(self): return self._additional_properties @additional_properties.setter - def additional_properties(self, additional_properties): + def additional_properties(self, additional_properties: object): """Sets the additional_properties of this User. diff --git a/libraries/models/cloudharness_model/models/user_credential.py b/libraries/models/cloudharness_model/models/user_credential.py index 4f54ddf5..1b692f8f 100644 --- a/libraries/models/cloudharness_model/models/user_credential.py +++ b/libraries/models/cloudharness_model/models/user_credential.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -83,7 +80,7 @@ def from_dict(cls, dikt) -> 'UserCredential': return util.deserialize_model(dikt, cls) @property - def created_date(self): + def created_date(self) -> int: """Gets the created_date of this UserCredential. @@ -93,7 +90,7 @@ def created_date(self): return self._created_date @created_date.setter - def created_date(self, created_date): + def created_date(self, created_date: int): """Sets the created_date of this UserCredential. @@ -104,7 +101,7 @@ def created_date(self, created_date): self._created_date = created_date @property - def credential_data(self): + def credential_data(self) -> str: """Gets the credential_data of this UserCredential. @@ -114,7 +111,7 @@ def credential_data(self): return self._credential_data @credential_data.setter - def credential_data(self, credential_data): + def credential_data(self, credential_data: str): """Sets the credential_data of this UserCredential. @@ -125,7 +122,7 @@ def credential_data(self, credential_data): self._credential_data = credential_data @property - def id(self): + def id(self) -> str: """Gets the id of this UserCredential. @@ -135,7 +132,7 @@ def id(self): return self._id @id.setter - def id(self, id): + def id(self, id: str): """Sets the id of this UserCredential. @@ -146,7 +143,7 @@ def id(self, id): self._id = id @property - def priority(self): + def priority(self) -> int: """Gets the priority of this UserCredential. @@ -156,7 +153,7 @@ def priority(self): return self._priority @priority.setter - def priority(self, priority): + def priority(self, priority: int): """Sets the priority of this UserCredential. @@ -167,7 +164,7 @@ def priority(self, priority): self._priority = priority @property - def secret_data(self): + def secret_data(self) -> str: """Gets the secret_data of this UserCredential. @@ -177,7 +174,7 @@ def secret_data(self): return self._secret_data @secret_data.setter - def secret_data(self, secret_data): + def secret_data(self, secret_data: str): """Sets the secret_data of this UserCredential. @@ -188,7 +185,7 @@ def secret_data(self, secret_data): self._secret_data = secret_data @property - def temporary(self): + def temporary(self) -> bool: """Gets the temporary of this UserCredential. @@ -198,7 +195,7 @@ def temporary(self): return self._temporary @temporary.setter - def temporary(self, temporary): + def temporary(self, temporary: bool): """Sets the temporary of this UserCredential. @@ -209,7 +206,7 @@ def temporary(self, temporary): self._temporary = temporary @property - def type(self): + def type(self) -> str: """Gets the type of this UserCredential. @@ -219,7 +216,7 @@ def type(self): return self._type @type.setter - def type(self, type): + def type(self, type: str): """Sets the type of this UserCredential. @@ -230,7 +227,7 @@ def type(self, type): self._type = type @property - def user_label(self): + def user_label(self) -> str: """Gets the user_label of this UserCredential. @@ -240,7 +237,7 @@ def user_label(self): return self._user_label @user_label.setter - def user_label(self, user_label): + def user_label(self, user_label: str): """Sets the user_label of this UserCredential. @@ -251,7 +248,7 @@ def user_label(self, user_label): self._user_label = user_label @property - def value(self): + def value(self) -> str: """Gets the value of this UserCredential. @@ -261,7 +258,7 @@ def value(self): return self._value @value.setter - def value(self, value): + def value(self, value: str): """Sets the value of this UserCredential. diff --git a/libraries/models/cloudharness_model/models/user_group.py b/libraries/models/cloudharness_model/models/user_group.py index 72e135ef..0cf48e99 100644 --- a/libraries/models/cloudharness_model/models/user_group.py +++ b/libraries/models/cloudharness_model/models/user_group.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -78,7 +75,7 @@ def from_dict(cls, dikt) -> 'UserGroup': return util.deserialize_model(dikt, cls) @property - def access(self): + def access(self) -> Dict[str, object]: """Gets the access of this UserGroup. @@ -88,7 +85,7 @@ def access(self): return self._access @access.setter - def access(self, access): + def access(self, access: Dict[str, object]): """Sets the access of this UserGroup. @@ -99,7 +96,7 @@ def access(self, access): self._access = access @property - def attributes(self): + def attributes(self) -> Dict[str, object]: """Gets the attributes of this UserGroup. # noqa: E501 @@ -110,7 +107,7 @@ def attributes(self): return self._attributes @attributes.setter - def attributes(self, attributes): + def attributes(self, attributes: Dict[str, object]): """Sets the attributes of this UserGroup. # noqa: E501 @@ -122,7 +119,7 @@ def attributes(self, attributes): self._attributes = attributes @property - def client_roles(self): + def client_roles(self) -> Dict[str, object]: """Gets the client_roles of this UserGroup. @@ -132,7 +129,7 @@ def client_roles(self): return self._client_roles @client_roles.setter - def client_roles(self, client_roles): + def client_roles(self, client_roles: Dict[str, object]): """Sets the client_roles of this UserGroup. @@ -143,7 +140,7 @@ def client_roles(self, client_roles): self._client_roles = client_roles @property - def id(self): + def id(self) -> str: """Gets the id of this UserGroup. @@ -153,7 +150,7 @@ def id(self): return self._id @id.setter - def id(self, id): + def id(self, id: str): """Sets the id of this UserGroup. @@ -164,7 +161,7 @@ def id(self, id): self._id = id @property - def name(self): + def name(self) -> str: """Gets the name of this UserGroup. @@ -174,7 +171,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this UserGroup. @@ -185,7 +182,7 @@ def name(self, name): self._name = name @property - def path(self): + def path(self) -> str: """Gets the path of this UserGroup. @@ -195,7 +192,7 @@ def path(self): return self._path @path.setter - def path(self, path): + def path(self, path: str): """Sets the path of this UserGroup. @@ -206,7 +203,7 @@ def path(self, path): self._path = path @property - def realm_roles(self): + def realm_roles(self) -> List[str]: """Gets the realm_roles of this UserGroup. @@ -216,7 +213,7 @@ def realm_roles(self): return self._realm_roles @realm_roles.setter - def realm_roles(self, realm_roles): + def realm_roles(self, realm_roles: List[str]): """Sets the realm_roles of this UserGroup. @@ -227,7 +224,7 @@ def realm_roles(self, realm_roles): self._realm_roles = realm_roles @property - def sub_groups(self): + def sub_groups(self) -> List[UserGroup]: """Gets the sub_groups of this UserGroup. @@ -237,7 +234,7 @@ def sub_groups(self): return self._sub_groups @sub_groups.setter - def sub_groups(self, sub_groups): + def sub_groups(self, sub_groups: List[UserGroup]): """Sets the sub_groups of this UserGroup. diff --git a/libraries/models/cloudharness_model/models/user_role.py b/libraries/models/cloudharness_model/models/user_role.py index dfa7e529..8cbc7d00 100644 --- a/libraries/models/cloudharness_model/models/user_role.py +++ b/libraries/models/cloudharness_model/models/user_role.py @@ -1,11 +1,8 @@ -# coding: utf-8 - -from __future__ import absolute_import from datetime import date, datetime # noqa: F401 from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model_ import Model +from cloudharness_model.models.base_model import Model from cloudharness_model import util @@ -73,7 +70,7 @@ def from_dict(cls, dikt) -> 'UserRole': return util.deserialize_model(dikt, cls) @property - def attributes(self): + def attributes(self) -> Dict[str, object]: """Gets the attributes of this UserRole. @@ -83,7 +80,7 @@ def attributes(self): return self._attributes @attributes.setter - def attributes(self, attributes): + def attributes(self, attributes: Dict[str, object]): """Sets the attributes of this UserRole. @@ -94,7 +91,7 @@ def attributes(self, attributes): self._attributes = attributes @property - def client_role(self): + def client_role(self) -> bool: """Gets the client_role of this UserRole. @@ -104,7 +101,7 @@ def client_role(self): return self._client_role @client_role.setter - def client_role(self, client_role): + def client_role(self, client_role: bool): """Sets the client_role of this UserRole. @@ -115,7 +112,7 @@ def client_role(self, client_role): self._client_role = client_role @property - def composite(self): + def composite(self) -> bool: """Gets the composite of this UserRole. @@ -125,7 +122,7 @@ def composite(self): return self._composite @composite.setter - def composite(self, composite): + def composite(self, composite: bool): """Sets the composite of this UserRole. @@ -136,7 +133,7 @@ def composite(self, composite): self._composite = composite @property - def container_id(self): + def container_id(self) -> str: """Gets the container_id of this UserRole. @@ -146,7 +143,7 @@ def container_id(self): return self._container_id @container_id.setter - def container_id(self, container_id): + def container_id(self, container_id: str): """Sets the container_id of this UserRole. @@ -157,7 +154,7 @@ def container_id(self, container_id): self._container_id = container_id @property - def description(self): + def description(self) -> str: """Gets the description of this UserRole. @@ -167,7 +164,7 @@ def description(self): return self._description @description.setter - def description(self, description): + def description(self, description: str): """Sets the description of this UserRole. @@ -178,7 +175,7 @@ def description(self, description): self._description = description @property - def id(self): + def id(self) -> str: """Gets the id of this UserRole. @@ -188,7 +185,7 @@ def id(self): return self._id @id.setter - def id(self, id): + def id(self, id: str): """Sets the id of this UserRole. @@ -199,7 +196,7 @@ def id(self, id): self._id = id @property - def name(self): + def name(self) -> str: """Gets the name of this UserRole. @@ -209,7 +206,7 @@ def name(self): return self._name @name.setter - def name(self, name): + def name(self, name: str): """Sets the name of this UserRole. diff --git a/libraries/models/cloudharness_model/typing_utils.py b/libraries/models/cloudharness_model/typing_utils.py index 0563f81f..74e3c913 100644 --- a/libraries/models/cloudharness_model/typing_utils.py +++ b/libraries/models/cloudharness_model/typing_utils.py @@ -1,5 +1,3 @@ -# coding: utf-8 - import sys if sys.version_info < (3, 7): diff --git a/libraries/models/tox.ini b/libraries/models/tox.ini index e76b6dbf..132efa3e 100644 --- a/libraries/models/tox.ini +++ b/libraries/models/tox.ini @@ -5,7 +5,7 @@ skipsdist=True [testenv] deps=-r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt - {toxinidir} + {toxinidir} commands= pytest --cov=cloudharness_model From 831bd1c5644d1aa88af48c6a4195f810da952244 Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Mon, 29 Jul 2024 16:06:29 +0100 Subject: [PATCH 2/8] CH-91 Updated the auto deployment template to include the envmap and added an example to samples --- .../samples/controllers/test_controller.py | 16 ++++++++++++++++ applications/samples/deploy/values.yaml | 3 +++ .../helm/templates/auto-deployments.yaml | 4 ++++ 3 files changed, 23 insertions(+) diff --git a/applications/samples/backend/samples/controllers/test_controller.py b/applications/samples/backend/samples/controllers/test_controller.py index e792c99e..3fb922f2 100644 --- a/applications/samples/backend/samples/controllers/test_controller.py +++ b/applications/samples/backend/samples/controllers/test_controller.py @@ -22,6 +22,22 @@ def ping(): # noqa: E501 :rtype: str """ + + import os + + expected_environment_variables = { + 'ENVIRONMENT_TEST_A': 'value', + 'ENVIRONMENT_TEST_B': '123', + } + + for key, expected_value in expected_environment_variables.items(): + try: + environment_value = os.environ[key] + if environment_value != expected_value: + raise Exception(f'Expected environment variable {key} to be {expected_value}, but got {environment_value}') + except KeyError: + raise Exception(f'Expected to have an environment variable {key} defined') + import time return time.time() diff --git a/applications/samples/deploy/values.yaml b/applications/samples/deploy/values.yaml index 6265c681..ab22f1e5 100644 --- a/applications/samples/deploy/values.yaml +++ b/applications/samples/deploy/values.yaml @@ -39,6 +39,9 @@ harness: env: - name: WORKERS value: "3" + envmap: + ENVIRONMENT_TEST_A: "value" + ENVIRONMENT_TEST_B: 123 dependencies: soft: - workflows diff --git a/deployment-configuration/helm/templates/auto-deployments.yaml b/deployment-configuration/helm/templates/auto-deployments.yaml index 23d4f61c..6981c2fd 100644 --- a/deployment-configuration/helm/templates/auto-deployments.yaml +++ b/deployment-configuration/helm/templates/auto-deployments.yaml @@ -66,6 +66,10 @@ spec: {{- if .app.harness.env }} {{- .app.harness.env | toYaml | nindent 8 }} {{- end }} + {{- range $name, $value := .app.harness.envmap }} + - name: {{ $name | quote }} + value: {{ $value | quote }} + {{- end }} {{ if .app.harness.livenessProbe }} livenessProbe: httpGet: From 9d7a648789908d6c2c5484b204e06f6df3c3c640 Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Mon, 29 Jul 2024 16:56:01 +0100 Subject: [PATCH 3/8] CH-91 Updated documentation around environment variables --- docs/applications/README.md | 5 ++- docs/applications/environment-variables.md | 46 ++++++++++++++++++++++ 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 docs/applications/environment-variables.md diff --git a/docs/applications/README.md b/docs/applications/README.md index e76bd861..da0c44fa 100644 --- a/docs/applications/README.md +++ b/docs/applications/README.md @@ -109,7 +109,10 @@ The most important configuration entries are the following: - `postgres`: postgres specific configurations - `mongo`: mongo specific configurations - `neo4j`: neo4j specific configurations - - `env` (`{name, value}[]`): add custom environment variables + - `envmap`: add custom environment variables + - ``: `` + - ... + - `env` (`{name, value}[]`): add custom environment variables (deprecated, please use `envmap`) - `resources`: mount files from - `use_services` (`{name, src, dst}[]`): create reverse proxy endpoints in the ingress for the listed applications on [subdomain].[Values.domain]/proxy/[name]. Useful to avoid CORS requests from frontend clients - `readinessProbe`: defines a a url to use as a readiness probe diff --git a/docs/applications/environment-variables.md b/docs/applications/environment-variables.md new file mode 100644 index 00000000..f986ec38 --- /dev/null +++ b/docs/applications/environment-variables.md @@ -0,0 +1,46 @@ +# CloudHarness Environment Variables + +CloudHarness has support for adding environment variables for an application which will be available to all containers within the application pod. + +## Automatically included environment variables + +The following environment variables are included in each container by default: +- `CH_CURRENT_APP_NAME`: the name of the application +- Any environment variables defined in the root `.Values.env` +- If `accounts` is an included application: + - `CH_ACCOUNTS_CLIENT_SECRET`: the client secret for the accounts + - `CH_ACCOUNTS_REALM`: the accounts realm + - `CH_ACCOUNTS_AUTH_DOMAIN`: the auth domain for the accounts + - `CH_ACCOUNTS_CLIENT_ID`: the client id for the accounts + - `DOMAIN`: the domain for the accounts + +## Environment variables definition in CloudHarness + +Environment variables are defined in the application values.yaml file in the `envmap` section under the `harness` section. +Example + +```yaml +harness: + envmap: + ENV_VARIABLE_A: + ... +``` + +Each key in the `envmap` will add an environment variable with a name matching the key and a value equal to the value provided. The value can be any primitive type, but will be quoted as a string within the deployment template. + +### (Deprecated) Setting with `env` + +Environment variables can be defined by using the `env` section under the `harness` section. This functionality is deprecated but not yet obsoleted, and use of `envmap` should be preferred over this approach. +Example + +```yaml +harness: + env: + - name: ENV_VARIABLE_A + value: + ... +``` + +Each element of the `env` sequence will add an environment variable named `name` with value set from `value`. + +This functionality was deprecated as cloud harness cannot merge arrays, so if an environment variable needed changing in a specific environment the entire array must be reproduced to change the single variable. \ No newline at end of file From 3a0e4f14f8d5cda23819a1cc3ffb5323752ad278 Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Tue, 30 Jul 2024 10:32:25 +0100 Subject: [PATCH 4/8] CH-91 Updated model documentation generation to use the directory docs are actually generated to --- docs/model/ApiTestsConfig.md | 33 ++++++++++++ docs/model/ApplicationAccountsConfig.md | 31 ++++++++++++ docs/model/ApplicationConfig.md | 30 +++++++++++ docs/model/ApplicationDependenciesConfig.md | 33 ++++++++++++ docs/model/ApplicationHarnessConfig.md | 50 +++++++++++++++++++ docs/model/ApplicationProbe.md | 33 ++++++++++++ docs/model/ApplicationTestConfig.md | 32 ++++++++++++ docs/model/ApplicationUser.md | 33 ++++++++++++ docs/model/AutoArtifactSpec.md | 31 ++++++++++++ docs/model/BackupConfig.md | 38 ++++++++++++++ docs/model/CDCEvent.md | 34 +++++++++++++ docs/model/CDCEventMeta.md | 34 +++++++++++++ docs/model/CpuMemoryConfig.md | 31 ++++++++++++ docs/model/DatabaseDeploymentConfig.md | 40 +++++++++++++++ docs/model/DeploymentAutoArtifactConfig.md | 36 +++++++++++++ docs/model/DeploymentResourcesConf.md | 31 ++++++++++++ docs/model/DeploymentVolumeSpec.md | 34 +++++++++++++ docs/model/E2ETestsConfig.md | 33 ++++++++++++ docs/model/FileResourcesConfig.md | 32 ++++++++++++ docs/model/GitDependencyConfig.md | 32 ++++++++++++ docs/model/HarnessMainConfig.md | 44 ++++++++++++++++ docs/model/IngressConfig.md | 33 ++++++++++++ docs/model/IngressConfigAllOfLetsencrypt.md | 30 +++++++++++ docs/model/JupyterHubConfig.md | 33 ++++++++++++ docs/model/NameValue.md | 31 ++++++++++++ docs/model/RegistryConfig.md | 31 ++++++++++++ docs/model/ServiceAutoArtifactConfig.md | 32 ++++++++++++ docs/model/UnitTestsConfig.md | 31 ++++++++++++ docs/model/UriRoleMappingConfig.md | 31 ++++++++++++ docs/model/User.md | 47 +++++++++++++++++ docs/model/UserCredential.md | 37 ++++++++++++++ docs/model/UserGroup.md | 36 +++++++++++++ docs/model/UserRole.md | 35 +++++++++++++ .../ch_cli_tools/openapi.py | 2 +- 34 files changed, 1133 insertions(+), 1 deletion(-) create mode 100644 docs/model/ApiTestsConfig.md create mode 100644 docs/model/ApplicationAccountsConfig.md create mode 100644 docs/model/ApplicationConfig.md create mode 100644 docs/model/ApplicationDependenciesConfig.md create mode 100644 docs/model/ApplicationHarnessConfig.md create mode 100644 docs/model/ApplicationProbe.md create mode 100644 docs/model/ApplicationTestConfig.md create mode 100644 docs/model/ApplicationUser.md create mode 100644 docs/model/AutoArtifactSpec.md create mode 100644 docs/model/BackupConfig.md create mode 100644 docs/model/CDCEvent.md create mode 100644 docs/model/CDCEventMeta.md create mode 100644 docs/model/CpuMemoryConfig.md create mode 100644 docs/model/DatabaseDeploymentConfig.md create mode 100644 docs/model/DeploymentAutoArtifactConfig.md create mode 100644 docs/model/DeploymentResourcesConf.md create mode 100644 docs/model/DeploymentVolumeSpec.md create mode 100644 docs/model/E2ETestsConfig.md create mode 100644 docs/model/FileResourcesConfig.md create mode 100644 docs/model/GitDependencyConfig.md create mode 100644 docs/model/HarnessMainConfig.md create mode 100644 docs/model/IngressConfig.md create mode 100644 docs/model/IngressConfigAllOfLetsencrypt.md create mode 100644 docs/model/JupyterHubConfig.md create mode 100644 docs/model/NameValue.md create mode 100644 docs/model/RegistryConfig.md create mode 100644 docs/model/ServiceAutoArtifactConfig.md create mode 100644 docs/model/UnitTestsConfig.md create mode 100644 docs/model/UriRoleMappingConfig.md create mode 100644 docs/model/User.md create mode 100644 docs/model/UserCredential.md create mode 100644 docs/model/UserGroup.md create mode 100644 docs/model/UserRole.md diff --git a/docs/model/ApiTestsConfig.md b/docs/model/ApiTestsConfig.md new file mode 100644 index 00000000..c0c0a347 --- /dev/null +++ b/docs/model/ApiTestsConfig.md @@ -0,0 +1,33 @@ +# ApiTestsConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enables api tests for this application (default: false) | +**autotest** | **bool** | Specify whether to run the common smoke tests | +**run_params** | **List[str]** | Additional schemathesis parameters | [optional] +**checks** | **List[str]** | One of the Schemathesis checks: - not_a_server_error. The response has 5xx HTTP status; - status_code_conformance. The response status is not defined in the API schema; - content_type_conformance. The response content type is not defined in the API schema; - response_schema_conformance. The response content does not conform to the schema defined for this specific response; - response_headers_conformance. The response headers does not contain all defined headers. | + +## Example + +```python +from cloudharness_model.models.api_tests_config import ApiTestsConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ApiTestsConfig from a JSON string +api_tests_config_instance = ApiTestsConfig.from_json(json) +# print the JSON string representation of the object +print ApiTestsConfig.to_json() + +# convert the object into a dict +api_tests_config_dict = api_tests_config_instance.to_dict() +# create an instance of ApiTestsConfig from a dict +api_tests_config_form_dict = api_tests_config.from_dict(api_tests_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) + + diff --git a/docs/model/ApplicationAccountsConfig.md b/docs/model/ApplicationAccountsConfig.md new file mode 100644 index 00000000..542dc891 --- /dev/null +++ b/docs/model/ApplicationAccountsConfig.md @@ -0,0 +1,31 @@ +# ApplicationAccountsConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**roles** | **List[str]** | Specify roles to be created in this deployment specific for this application | [optional] +**users** | [**List[ApplicationUser]**](ApplicationUser.md) | Defines test users to be added to the deployment, specific for this application | [optional] + +## Example + +```python +from cloudharness_model.models.application_accounts_config import ApplicationAccountsConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationAccountsConfig from a JSON string +application_accounts_config_instance = ApplicationAccountsConfig.from_json(json) +# print the JSON string representation of the object +print ApplicationAccountsConfig.to_json() + +# convert the object into a dict +application_accounts_config_dict = application_accounts_config_instance.to_dict() +# create an instance of ApplicationAccountsConfig from a dict +application_accounts_config_form_dict = application_accounts_config.from_dict(application_accounts_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) + + diff --git a/docs/model/ApplicationConfig.md b/docs/model/ApplicationConfig.md new file mode 100644 index 00000000..c62c5523 --- /dev/null +++ b/docs/model/ApplicationConfig.md @@ -0,0 +1,30 @@ +# ApplicationConfig + +Place here the values to configure your application helm templates. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**harness** | [**ApplicationHarnessConfig**](ApplicationHarnessConfig.md) | | + +## Example + +```python +from cloudharness_model.models.application_config import ApplicationConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationConfig from a JSON string +application_config_instance = ApplicationConfig.from_json(json) +# print the JSON string representation of the object +print ApplicationConfig.to_json() + +# convert the object into a dict +application_config_dict = application_config_instance.to_dict() +# create an instance of ApplicationConfig from a dict +application_config_form_dict = application_config.from_dict(application_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) + + diff --git a/docs/model/ApplicationDependenciesConfig.md b/docs/model/ApplicationDependenciesConfig.md new file mode 100644 index 00000000..1adfc23c --- /dev/null +++ b/docs/model/ApplicationDependenciesConfig.md @@ -0,0 +1,33 @@ +# ApplicationDependenciesConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hard** | **List[str]** | Hard dependencies indicate that the application may not start without these other applications. | [optional] +**soft** | **List[str]** | Soft dependencies indicate that the application will work partially without these other applications. | [optional] +**build** | **List[str]** | Hard dependencies indicate that the application Docker image build requires these base/common images | [optional] +**git** | [**List[GitDependencyConfig]**](GitDependencyConfig.md) | | [optional] + +## Example + +```python +from cloudharness_model.models.application_dependencies_config import ApplicationDependenciesConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationDependenciesConfig from a JSON string +application_dependencies_config_instance = ApplicationDependenciesConfig.from_json(json) +# print the JSON string representation of the object +print ApplicationDependenciesConfig.to_json() + +# convert the object into a dict +application_dependencies_config_dict = application_dependencies_config_instance.to_dict() +# create an instance of ApplicationDependenciesConfig from a dict +application_dependencies_config_form_dict = application_dependencies_config.from_dict(application_dependencies_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) + + diff --git a/docs/model/ApplicationHarnessConfig.md b/docs/model/ApplicationHarnessConfig.md new file mode 100644 index 00000000..0d6fc57a --- /dev/null +++ b/docs/model/ApplicationHarnessConfig.md @@ -0,0 +1,50 @@ +# ApplicationHarnessConfig + +Define helm variables that allow CloudHarness to enable and configure your application's deployment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deployment** | [**DeploymentAutoArtifactConfig**](DeploymentAutoArtifactConfig.md) | | [optional] +**service** | [**ServiceAutoArtifactConfig**](ServiceAutoArtifactConfig.md) | | [optional] +**subdomain** | **str** | If specified, an ingress will be created at [subdomain].[.Values.domain] | [optional] +**aliases** | **List[str]** | If specified, an ingress will be created at [alias].[.Values.domain] for each alias | [optional] +**domain** | **str** | If specified, an ingress will be created at [domain] | [optional] +**dependencies** | [**ApplicationDependenciesConfig**](ApplicationDependenciesConfig.md) | | [optional] +**secured** | **bool** | When true, the application is shielded with a getekeeper | [optional] +**uri_role_mapping** | [**List[UriRoleMappingConfig]**](UriRoleMappingConfig.md) | Map uri/roles to secure with the Gatekeeper (if `secured: true`) | [optional] +**secrets** | **Dict[str, object]** | | [optional] +**use_services** | **List[str]** | Specify which services this application uses in the frontend to create proxy ingresses. e.g. ``` - name: samples ``` | [optional] +**database** | [**DatabaseDeploymentConfig**](DatabaseDeploymentConfig.md) | | [optional] +**resources** | [**List[FileResourcesConfig]**](FileResourcesConfig.md) | Application file resources. Maps from deploy/resources folder and mounts as configmaps | [optional] +**readiness_probe** | [**ApplicationProbe**](ApplicationProbe.md) | | [optional] +**startup_probe** | [**ApplicationProbe**](ApplicationProbe.md) | | [optional] +**liveness_probe** | [**ApplicationProbe**](ApplicationProbe.md) | | [optional] +**source_root** | **str** | | [optional] +**name** | **str** | Application's name. Do not edit, the value is automatically set from the application directory's name | [optional] +**jupyterhub** | [**JupyterHubConfig**](JupyterHubConfig.md) | | [optional] +**accounts** | [**ApplicationAccountsConfig**](ApplicationAccountsConfig.md) | | [optional] +**test** | [**ApplicationTestConfig**](ApplicationTestConfig.md) | | [optional] +**quotas** | **Dict[str, object]** | | [optional] + +## Example + +```python +from cloudharness_model.models.application_harness_config import ApplicationHarnessConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationHarnessConfig from a JSON string +application_harness_config_instance = ApplicationHarnessConfig.from_json(json) +# print the JSON string representation of the object +print ApplicationHarnessConfig.to_json() + +# convert the object into a dict +application_harness_config_dict = application_harness_config_instance.to_dict() +# create an instance of ApplicationHarnessConfig from a dict +application_harness_config_form_dict = application_harness_config.from_dict(application_harness_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) + + diff --git a/docs/model/ApplicationProbe.md b/docs/model/ApplicationProbe.md new file mode 100644 index 00000000..404de194 --- /dev/null +++ b/docs/model/ApplicationProbe.md @@ -0,0 +1,33 @@ +# ApplicationProbe + +Define a Kubernetes probe See also the [official documentation](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **str** | | +**period_seconds** | **float** | | [optional] +**failure_threshold** | **float** | | [optional] +**initial_delay_seconds** | **float** | | [optional] + +## Example + +```python +from cloudharness_model.models.application_probe import ApplicationProbe + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationProbe from a JSON string +application_probe_instance = ApplicationProbe.from_json(json) +# print the JSON string representation of the object +print ApplicationProbe.to_json() + +# convert the object into a dict +application_probe_dict = application_probe_instance.to_dict() +# create an instance of ApplicationProbe from a dict +application_probe_form_dict = application_probe.from_dict(application_probe_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) + + diff --git a/docs/model/ApplicationTestConfig.md b/docs/model/ApplicationTestConfig.md new file mode 100644 index 00000000..c0922e1f --- /dev/null +++ b/docs/model/ApplicationTestConfig.md @@ -0,0 +1,32 @@ +# ApplicationTestConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unit** | [**UnitTestsConfig**](UnitTestsConfig.md) | | +**api** | [**ApiTestsConfig**](ApiTestsConfig.md) | | +**e2e** | [**E2ETestsConfig**](E2ETestsConfig.md) | | + +## Example + +```python +from cloudharness_model.models.application_test_config import ApplicationTestConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationTestConfig from a JSON string +application_test_config_instance = ApplicationTestConfig.from_json(json) +# print the JSON string representation of the object +print ApplicationTestConfig.to_json() + +# convert the object into a dict +application_test_config_dict = application_test_config_instance.to_dict() +# create an instance of ApplicationTestConfig from a dict +application_test_config_form_dict = application_test_config.from_dict(application_test_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) + + diff --git a/docs/model/ApplicationUser.md b/docs/model/ApplicationUser.md new file mode 100644 index 00000000..d276a038 --- /dev/null +++ b/docs/model/ApplicationUser.md @@ -0,0 +1,33 @@ +# ApplicationUser + +Defines a user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **str** | | +**password** | **str** | | [optional] +**client_roles** | **List[str]** | | [optional] +**realm_roles** | **List[str]** | | [optional] + +## Example + +```python +from cloudharness_model.models.application_user import ApplicationUser + +# TODO update the JSON string below +json = "{}" +# create an instance of ApplicationUser from a JSON string +application_user_instance = ApplicationUser.from_json(json) +# print the JSON string representation of the object +print ApplicationUser.to_json() + +# convert the object into a dict +application_user_dict = application_user_instance.to_dict() +# create an instance of ApplicationUser from a dict +application_user_form_dict = application_user.from_dict(application_user_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) + + diff --git a/docs/model/AutoArtifactSpec.md b/docs/model/AutoArtifactSpec.md new file mode 100644 index 00000000..f637301c --- /dev/null +++ b/docs/model/AutoArtifactSpec.md @@ -0,0 +1,31 @@ +# AutoArtifactSpec + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto** | **bool** | When true, enables automatic template | +**name** | **str** | | [optional] + +## Example + +```python +from cloudharness_model.models.auto_artifact_spec import AutoArtifactSpec + +# TODO update the JSON string below +json = "{}" +# create an instance of AutoArtifactSpec from a JSON string +auto_artifact_spec_instance = AutoArtifactSpec.from_json(json) +# print the JSON string representation of the object +print AutoArtifactSpec.to_json() + +# convert the object into a dict +auto_artifact_spec_dict = auto_artifact_spec_instance.to_dict() +# create an instance of AutoArtifactSpec from a dict +auto_artifact_spec_form_dict = auto_artifact_spec.from_dict(auto_artifact_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) + + diff --git a/docs/model/BackupConfig.md b/docs/model/BackupConfig.md new file mode 100644 index 00000000..9f18eb44 --- /dev/null +++ b/docs/model/BackupConfig.md @@ -0,0 +1,38 @@ +# BackupConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **bool** | | [optional] +**keep_days** | **int** | | [optional] +**keep_weeks** | **int** | | [optional] +**keep_months** | **int** | | [optional] +**schedule** | **str** | Cron expression | [optional] +**suffix** | **object** | The file suffix added to backup files | [optional] +**volumesize** | **str** | The volume size for backups (all backups share the same volume) | [optional] +**dir** | **str** | | +**resources** | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | | + +## Example + +```python +from cloudharness_model.models.backup_config import BackupConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of BackupConfig from a JSON string +backup_config_instance = BackupConfig.from_json(json) +# print the JSON string representation of the object +print BackupConfig.to_json() + +# convert the object into a dict +backup_config_dict = backup_config_instance.to_dict() +# create an instance of BackupConfig from a dict +backup_config_form_dict = backup_config.from_dict(backup_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) + + diff --git a/docs/model/CDCEvent.md b/docs/model/CDCEvent.md new file mode 100644 index 00000000..faf90671 --- /dev/null +++ b/docs/model/CDCEvent.md @@ -0,0 +1,34 @@ +# CDCEvent + +A message sent to the orchestration queue. Applications can listen to these events to react to data change events happening on other applications. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **str** | the operation on the object e.g. create / update / delete | +**uid** | **str** | the unique identifier attribute of the object | +**message_type** | **str** | the type of the message (relates to the object type) e.g. jobs | +**resource** | **Dict[str, object]** | | [optional] +**meta** | [**CDCEventMeta**](CDCEventMeta.md) | | + +## Example + +```python +from cloudharness_model.models.cdc_event import CDCEvent + +# TODO update the JSON string below +json = "{}" +# create an instance of CDCEvent from a JSON string +cdc_event_instance = CDCEvent.from_json(json) +# print the JSON string representation of the object +print CDCEvent.to_json() + +# convert the object into a dict +cdc_event_dict = cdc_event_instance.to_dict() +# create an instance of CDCEvent from a dict +cdc_event_form_dict = cdc_event.from_dict(cdc_event_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) + + diff --git a/docs/model/CDCEventMeta.md b/docs/model/CDCEventMeta.md new file mode 100644 index 00000000..b3d633f0 --- /dev/null +++ b/docs/model/CDCEventMeta.md @@ -0,0 +1,34 @@ +# CDCEventMeta + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**app_name** | **str** | The name of the application/microservice sending the message | +**user** | [**User**](User.md) | | [optional] +**args** | **List[Dict[str, object]]** | the caller function arguments | [optional] +**kwargs** | **object** | the caller function keyword arguments | [optional] +**description** | **str** | General description -- for human consumption | [optional] + +## Example + +```python +from cloudharness_model.models.cdc_event_meta import CDCEventMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of CDCEventMeta from a JSON string +cdc_event_meta_instance = CDCEventMeta.from_json(json) +# print the JSON string representation of the object +print CDCEventMeta.to_json() + +# convert the object into a dict +cdc_event_meta_dict = cdc_event_meta_instance.to_dict() +# create an instance of CDCEventMeta from a dict +cdc_event_meta_form_dict = cdc_event_meta.from_dict(cdc_event_meta_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) + + diff --git a/docs/model/CpuMemoryConfig.md b/docs/model/CpuMemoryConfig.md new file mode 100644 index 00000000..7819d202 --- /dev/null +++ b/docs/model/CpuMemoryConfig.md @@ -0,0 +1,31 @@ +# CpuMemoryConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cpu** | **str** | | [optional] +**memory** | **str** | | [optional] + +## Example + +```python +from cloudharness_model.models.cpu_memory_config import CpuMemoryConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of CpuMemoryConfig from a JSON string +cpu_memory_config_instance = CpuMemoryConfig.from_json(json) +# print the JSON string representation of the object +print CpuMemoryConfig.to_json() + +# convert the object into a dict +cpu_memory_config_dict = cpu_memory_config_instance.to_dict() +# create an instance of CpuMemoryConfig from a dict +cpu_memory_config_form_dict = cpu_memory_config.from_dict(cpu_memory_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) + + diff --git a/docs/model/DatabaseDeploymentConfig.md b/docs/model/DatabaseDeploymentConfig.md new file mode 100644 index 00000000..45db673b --- /dev/null +++ b/docs/model/DatabaseDeploymentConfig.md @@ -0,0 +1,40 @@ +# DatabaseDeploymentConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto** | **bool** | When true, enables automatic template | +**name** | **str** | | [optional] +**type** | **str** | Define the database type. One of (mongo, postgres, neo4j, sqlite3) | [optional] +**size** | **str** | Specify database disk size | [optional] +**user** | **str** | database username | [optional] +**var_pass** | **str** | Database password | [optional] +**image_ref** | **str** | Used for referencing images from the build | [optional] +**mongo** | **Dict[str, object]** | | [optional] +**postgres** | **Dict[str, object]** | | [optional] +**neo4j** | **object** | Neo4j database specific configuration | [optional] +**resources** | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | | [optional] + +## Example + +```python +from cloudharness_model.models.database_deployment_config import DatabaseDeploymentConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of DatabaseDeploymentConfig from a JSON string +database_deployment_config_instance = DatabaseDeploymentConfig.from_json(json) +# print the JSON string representation of the object +print DatabaseDeploymentConfig.to_json() + +# convert the object into a dict +database_deployment_config_dict = database_deployment_config_instance.to_dict() +# create an instance of DatabaseDeploymentConfig from a dict +database_deployment_config_form_dict = database_deployment_config.from_dict(database_deployment_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) + + diff --git a/docs/model/DeploymentAutoArtifactConfig.md b/docs/model/DeploymentAutoArtifactConfig.md new file mode 100644 index 00000000..707059d0 --- /dev/null +++ b/docs/model/DeploymentAutoArtifactConfig.md @@ -0,0 +1,36 @@ +# DeploymentAutoArtifactConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto** | **bool** | When true, enables automatic template | +**name** | **str** | | [optional] +**port** | **str** | Deployment port | [optional] +**replicas** | **int** | Number of replicas | [optional] +**image** | **str** | Image name to use in the deployment. Leave it blank to set from the application's Docker file | [optional] +**resources** | [**DeploymentResourcesConf**](DeploymentResourcesConf.md) | | [optional] +**volume** | [**DeploymentVolumeSpec**](DeploymentVolumeSpec.md) | | [optional] + +## Example + +```python +from cloudharness_model.models.deployment_auto_artifact_config import DeploymentAutoArtifactConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of DeploymentAutoArtifactConfig from a JSON string +deployment_auto_artifact_config_instance = DeploymentAutoArtifactConfig.from_json(json) +# print the JSON string representation of the object +print DeploymentAutoArtifactConfig.to_json() + +# convert the object into a dict +deployment_auto_artifact_config_dict = deployment_auto_artifact_config_instance.to_dict() +# create an instance of DeploymentAutoArtifactConfig from a dict +deployment_auto_artifact_config_form_dict = deployment_auto_artifact_config.from_dict(deployment_auto_artifact_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) + + diff --git a/docs/model/DeploymentResourcesConf.md b/docs/model/DeploymentResourcesConf.md new file mode 100644 index 00000000..7a0c10d1 --- /dev/null +++ b/docs/model/DeploymentResourcesConf.md @@ -0,0 +1,31 @@ +# DeploymentResourcesConf + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requests** | [**CpuMemoryConfig**](CpuMemoryConfig.md) | | [optional] +**limits** | [**CpuMemoryConfig**](CpuMemoryConfig.md) | | [optional] + +## Example + +```python +from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf + +# TODO update the JSON string below +json = "{}" +# create an instance of DeploymentResourcesConf from a JSON string +deployment_resources_conf_instance = DeploymentResourcesConf.from_json(json) +# print the JSON string representation of the object +print DeploymentResourcesConf.to_json() + +# convert the object into a dict +deployment_resources_conf_dict = deployment_resources_conf_instance.to_dict() +# create an instance of DeploymentResourcesConf from a dict +deployment_resources_conf_form_dict = deployment_resources_conf.from_dict(deployment_resources_conf_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) + + diff --git a/docs/model/DeploymentVolumeSpec.md b/docs/model/DeploymentVolumeSpec.md new file mode 100644 index 00000000..66693cb8 --- /dev/null +++ b/docs/model/DeploymentVolumeSpec.md @@ -0,0 +1,34 @@ +# DeploymentVolumeSpec + +Defines a volume attached to the deployment. Automatically created the volume claim and mounts. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto** | **bool** | When true, enables automatic template | +**name** | **str** | | [optional] +**mountpath** | **str** | The mount path for the volume | +**size** | **object** | The volume size. E.g. 5Gi | [optional] +**usenfs** | **bool** | Set to `true` to use the nfs on the created volume and mount as ReadWriteMany. | [optional] + +## Example + +```python +from cloudharness_model.models.deployment_volume_spec import DeploymentVolumeSpec + +# TODO update the JSON string below +json = "{}" +# create an instance of DeploymentVolumeSpec from a JSON string +deployment_volume_spec_instance = DeploymentVolumeSpec.from_json(json) +# print the JSON string representation of the object +print DeploymentVolumeSpec.to_json() + +# convert the object into a dict +deployment_volume_spec_dict = deployment_volume_spec_instance.to_dict() +# create an instance of DeploymentVolumeSpec from a dict +deployment_volume_spec_form_dict = deployment_volume_spec.from_dict(deployment_volume_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) + + diff --git a/docs/model/E2ETestsConfig.md b/docs/model/E2ETestsConfig.md new file mode 100644 index 00000000..1f5756f2 --- /dev/null +++ b/docs/model/E2ETestsConfig.md @@ -0,0 +1,33 @@ +# E2ETestsConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enables end to end testing for this application (default: false) | +**smoketest** | **bool** | Specify whether to run the common smoke tests | +**ignore_console_errors** | **bool** | | [optional] +**ignore_request_errors** | **bool** | | [optional] + +## Example + +```python +from cloudharness_model.models.e2_e_tests_config import E2ETestsConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of E2ETestsConfig from a JSON string +e2_e_tests_config_instance = E2ETestsConfig.from_json(json) +# print the JSON string representation of the object +print E2ETestsConfig.to_json() + +# convert the object into a dict +e2_e_tests_config_dict = e2_e_tests_config_instance.to_dict() +# create an instance of E2ETestsConfig from a dict +e2_e_tests_config_form_dict = e2_e_tests_config.from_dict(e2_e_tests_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) + + diff --git a/docs/model/FileResourcesConfig.md b/docs/model/FileResourcesConfig.md new file mode 100644 index 00000000..4d72981e --- /dev/null +++ b/docs/model/FileResourcesConfig.md @@ -0,0 +1,32 @@ +# FileResourcesConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**src** | **str** | | +**dst** | **str** | | + +## Example + +```python +from cloudharness_model.models.file_resources_config import FileResourcesConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of FileResourcesConfig from a JSON string +file_resources_config_instance = FileResourcesConfig.from_json(json) +# print the JSON string representation of the object +print FileResourcesConfig.to_json() + +# convert the object into a dict +file_resources_config_dict = file_resources_config_instance.to_dict() +# create an instance of FileResourcesConfig from a dict +file_resources_config_form_dict = file_resources_config.from_dict(file_resources_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) + + diff --git a/docs/model/GitDependencyConfig.md b/docs/model/GitDependencyConfig.md new file mode 100644 index 00000000..51779d4d --- /dev/null +++ b/docs/model/GitDependencyConfig.md @@ -0,0 +1,32 @@ +# GitDependencyConfig + +Defines a git repo to be cloned inside the application path + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**branch_tag** | **str** | | +**path** | **str** | Defines the path where the repo is cloned. default: /git | [optional] + +## Example + +```python +from cloudharness_model.models.git_dependency_config import GitDependencyConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of GitDependencyConfig from a JSON string +git_dependency_config_instance = GitDependencyConfig.from_json(json) +# print the JSON string representation of the object +print GitDependencyConfig.to_json() + +# convert the object into a dict +git_dependency_config_dict = git_dependency_config_instance.to_dict() +# create an instance of GitDependencyConfig from a dict +git_dependency_config_form_dict = git_dependency_config.from_dict(git_dependency_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) + + diff --git a/docs/model/HarnessMainConfig.md b/docs/model/HarnessMainConfig.md new file mode 100644 index 00000000..5cecf052 --- /dev/null +++ b/docs/model/HarnessMainConfig.md @@ -0,0 +1,44 @@ +# HarnessMainConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**local** | **bool** | If set to true, local DNS mapping is added to pods. | +**secured_gatekeepers** | **bool** | Enables/disables Gatekeepers on secured applications. Set to false for testing/development | +**domain** | **str** | The root domain | +**namespace** | **str** | The K8s namespace. | +**mainapp** | **str** | Defines the app to map to the root domain | +**registry** | [**RegistryConfig**](RegistryConfig.md) | | [optional] +**tag** | **str** | Docker tag used to push/pull the built images. | [optional] +**apps** | [**Dict[str, ApplicationConfig]**](ApplicationConfig.md) | | +**env** | [**List[NameValue]**](NameValue.md) | Environmental variables added to all pods (deprecated, please use envmap) | [optional] +**privenv** | [**NameValue**](NameValue.md) | | [optional] +**backup** | [**BackupConfig**](BackupConfig.md) | | [optional] +**name** | **str** | Base name | [optional] +**task_images** | **Dict[str, object]** | | [optional] +**build_hash** | **str** | | [optional] +**envmap** | **Dict[str, object]** | | [optional] + +## Example + +```python +from cloudharness_model.models.harness_main_config import HarnessMainConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of HarnessMainConfig from a JSON string +harness_main_config_instance = HarnessMainConfig.from_json(json) +# print the JSON string representation of the object +print HarnessMainConfig.to_json() + +# convert the object into a dict +harness_main_config_dict = harness_main_config_instance.to_dict() +# create an instance of HarnessMainConfig from a dict +harness_main_config_form_dict = harness_main_config.from_dict(harness_main_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) + + diff --git a/docs/model/IngressConfig.md b/docs/model/IngressConfig.md new file mode 100644 index 00000000..0c53184e --- /dev/null +++ b/docs/model/IngressConfig.md @@ -0,0 +1,33 @@ +# IngressConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto** | **bool** | When true, enables automatic template | +**name** | **str** | | [optional] +**ssl_redirect** | **bool** | | [optional] +**letsencrypt** | [**IngressConfigAllOfLetsencrypt**](IngressConfigAllOfLetsencrypt.md) | | [optional] + +## Example + +```python +from cloudharness_model.models.ingress_config import IngressConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of IngressConfig from a JSON string +ingress_config_instance = IngressConfig.from_json(json) +# print the JSON string representation of the object +print IngressConfig.to_json() + +# convert the object into a dict +ingress_config_dict = ingress_config_instance.to_dict() +# create an instance of IngressConfig from a dict +ingress_config_form_dict = ingress_config.from_dict(ingress_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) + + diff --git a/docs/model/IngressConfigAllOfLetsencrypt.md b/docs/model/IngressConfigAllOfLetsencrypt.md new file mode 100644 index 00000000..836a9ee9 --- /dev/null +++ b/docs/model/IngressConfigAllOfLetsencrypt.md @@ -0,0 +1,30 @@ +# IngressConfigAllOfLetsencrypt + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | | [optional] + +## Example + +```python +from cloudharness_model.models.ingress_config_all_of_letsencrypt import IngressConfigAllOfLetsencrypt + +# TODO update the JSON string below +json = "{}" +# create an instance of IngressConfigAllOfLetsencrypt from a JSON string +ingress_config_all_of_letsencrypt_instance = IngressConfigAllOfLetsencrypt.from_json(json) +# print the JSON string representation of the object +print IngressConfigAllOfLetsencrypt.to_json() + +# convert the object into a dict +ingress_config_all_of_letsencrypt_dict = ingress_config_all_of_letsencrypt_instance.to_dict() +# create an instance of IngressConfigAllOfLetsencrypt from a dict +ingress_config_all_of_letsencrypt_form_dict = ingress_config_all_of_letsencrypt.from_dict(ingress_config_all_of_letsencrypt_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) + + diff --git a/docs/model/JupyterHubConfig.md b/docs/model/JupyterHubConfig.md new file mode 100644 index 00000000..ccc2e304 --- /dev/null +++ b/docs/model/JupyterHubConfig.md @@ -0,0 +1,33 @@ +# JupyterHubConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**args** | **List[str]** | arguments passed to the container | [optional] +**extra_config** | **Dict[str, object]** | | [optional] +**spawner_extra_config** | **Dict[str, object]** | | [optional] +**application_hook** | **object** | change the hook function (advanced) Specify the Python name of the function (full module path, the module must be installed in the Docker image) | [optional] + +## Example + +```python +from cloudharness_model.models.jupyter_hub_config import JupyterHubConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of JupyterHubConfig from a JSON string +jupyter_hub_config_instance = JupyterHubConfig.from_json(json) +# print the JSON string representation of the object +print JupyterHubConfig.to_json() + +# convert the object into a dict +jupyter_hub_config_dict = jupyter_hub_config_instance.to_dict() +# create an instance of JupyterHubConfig from a dict +jupyter_hub_config_form_dict = jupyter_hub_config.from_dict(jupyter_hub_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) + + diff --git a/docs/model/NameValue.md b/docs/model/NameValue.md new file mode 100644 index 00000000..cfcf6f34 --- /dev/null +++ b/docs/model/NameValue.md @@ -0,0 +1,31 @@ +# NameValue + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**value** | **str** | | [optional] + +## Example + +```python +from cloudharness_model.models.name_value import NameValue + +# TODO update the JSON string below +json = "{}" +# create an instance of NameValue from a JSON string +name_value_instance = NameValue.from_json(json) +# print the JSON string representation of the object +print NameValue.to_json() + +# convert the object into a dict +name_value_dict = name_value_instance.to_dict() +# create an instance of NameValue from a dict +name_value_form_dict = name_value.from_dict(name_value_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) + + diff --git a/docs/model/RegistryConfig.md b/docs/model/RegistryConfig.md new file mode 100644 index 00000000..88bbdd7b --- /dev/null +++ b/docs/model/RegistryConfig.md @@ -0,0 +1,31 @@ +# RegistryConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**secret** | **str** | Optional secret used for pulling from docker registry. | [optional] + +## Example + +```python +from cloudharness_model.models.registry_config import RegistryConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of RegistryConfig from a JSON string +registry_config_instance = RegistryConfig.from_json(json) +# print the JSON string representation of the object +print RegistryConfig.to_json() + +# convert the object into a dict +registry_config_dict = registry_config_instance.to_dict() +# create an instance of RegistryConfig from a dict +registry_config_form_dict = registry_config.from_dict(registry_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) + + diff --git a/docs/model/ServiceAutoArtifactConfig.md b/docs/model/ServiceAutoArtifactConfig.md new file mode 100644 index 00000000..dc4c74d8 --- /dev/null +++ b/docs/model/ServiceAutoArtifactConfig.md @@ -0,0 +1,32 @@ +# ServiceAutoArtifactConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auto** | **bool** | When true, enables automatic template | +**name** | **str** | | [optional] +**port** | **int** | Service port | [optional] + +## Example + +```python +from cloudharness_model.models.service_auto_artifact_config import ServiceAutoArtifactConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceAutoArtifactConfig from a JSON string +service_auto_artifact_config_instance = ServiceAutoArtifactConfig.from_json(json) +# print the JSON string representation of the object +print ServiceAutoArtifactConfig.to_json() + +# convert the object into a dict +service_auto_artifact_config_dict = service_auto_artifact_config_instance.to_dict() +# create an instance of ServiceAutoArtifactConfig from a dict +service_auto_artifact_config_form_dict = service_auto_artifact_config.from_dict(service_auto_artifact_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) + + diff --git a/docs/model/UnitTestsConfig.md b/docs/model/UnitTestsConfig.md new file mode 100644 index 00000000..9aed04eb --- /dev/null +++ b/docs/model/UnitTestsConfig.md @@ -0,0 +1,31 @@ +# UnitTestsConfig + + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enables unit tests for this application (default: true) | +**commands** | **List[str]** | Commands to run unit tests | + +## Example + +```python +from cloudharness_model.models.unit_tests_config import UnitTestsConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of UnitTestsConfig from a JSON string +unit_tests_config_instance = UnitTestsConfig.from_json(json) +# print the JSON string representation of the object +print UnitTestsConfig.to_json() + +# convert the object into a dict +unit_tests_config_dict = unit_tests_config_instance.to_dict() +# create an instance of UnitTestsConfig from a dict +unit_tests_config_form_dict = unit_tests_config.from_dict(unit_tests_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) + + diff --git a/docs/model/UriRoleMappingConfig.md b/docs/model/UriRoleMappingConfig.md new file mode 100644 index 00000000..11f78073 --- /dev/null +++ b/docs/model/UriRoleMappingConfig.md @@ -0,0 +1,31 @@ +# UriRoleMappingConfig + +Defines the application Gatekeeper configuration, if enabled (i.e. `secured: true`. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uri** | **str** | | +**roles** | **List[str]** | Roles allowed to access the present uri | + +## Example + +```python +from cloudharness_model.models.uri_role_mapping_config import UriRoleMappingConfig + +# TODO update the JSON string below +json = "{}" +# create an instance of UriRoleMappingConfig from a JSON string +uri_role_mapping_config_instance = UriRoleMappingConfig.from_json(json) +# print the JSON string representation of the object +print UriRoleMappingConfig.to_json() + +# convert the object into a dict +uri_role_mapping_config_dict = uri_role_mapping_config_instance.to_dict() +# create an instance of UriRoleMappingConfig from a dict +uri_role_mapping_config_form_dict = uri_role_mapping_config.from_dict(uri_role_mapping_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) + + diff --git a/docs/model/User.md b/docs/model/User.md new file mode 100644 index 00000000..e5864f66 --- /dev/null +++ b/docs/model/User.md @@ -0,0 +1,47 @@ +# User + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | **Dict[str, object]** | | [optional] +**attributes** | **Dict[str, object]** | | [optional] +**client_roles** | **Dict[str, object]** | | [optional] +**created_timestamp** | **int** | | [optional] +**credentials** | [**List[UserCredential]**](UserCredential.md) | | [optional] +**disableable_credential_types** | **List[str]** | | [optional] +**email** | **str** | | [optional] +**email_verified** | **bool** | | [optional] +**enabled** | **bool** | | [optional] +**federation_link** | **str** | | [optional] +**first_name** | **str** | | [optional] +**groups** | **List[str]** | | [optional] +**id** | **str** | | [optional] +**last_name** | **str** | | [optional] +**realm_roles** | **List[str]** | | [optional] +**required_actions** | **List[str]** | | [optional] +**service_account_client_id** | **str** | | [optional] +**username** | **str** | | [optional] +**additional_properties** | **object** | | [optional] + +## Example + +```python +from cloudharness_model.models.user import User + +# TODO update the JSON string below +json = "{}" +# create an instance of User from a JSON string +user_instance = User.from_json(json) +# print the JSON string representation of the object +print User.to_json() + +# convert the object into a dict +user_dict = user_instance.to_dict() +# create an instance of User from a dict +user_form_dict = user.from_dict(user_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) + + diff --git a/docs/model/UserCredential.md b/docs/model/UserCredential.md new file mode 100644 index 00000000..8dd7e316 --- /dev/null +++ b/docs/model/UserCredential.md @@ -0,0 +1,37 @@ +# UserCredential + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_date** | **int** | | [optional] +**credential_data** | **str** | | [optional] +**id** | **str** | | [optional] +**priority** | **int** | | [optional] +**secret_data** | **str** | | [optional] +**temporary** | **bool** | | [optional] +**type** | **str** | | [optional] +**user_label** | **str** | | [optional] +**value** | **str** | | [optional] + +## Example + +```python +from cloudharness_model.models.user_credential import UserCredential + +# TODO update the JSON string below +json = "{}" +# create an instance of UserCredential from a JSON string +user_credential_instance = UserCredential.from_json(json) +# print the JSON string representation of the object +print UserCredential.to_json() + +# convert the object into a dict +user_credential_dict = user_credential_instance.to_dict() +# create an instance of UserCredential from a dict +user_credential_form_dict = user_credential.from_dict(user_credential_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) + + diff --git a/docs/model/UserGroup.md b/docs/model/UserGroup.md new file mode 100644 index 00000000..a8a2bf14 --- /dev/null +++ b/docs/model/UserGroup.md @@ -0,0 +1,36 @@ +# UserGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | **Dict[str, object]** | | [optional] +**attributes** | **Dict[str, object]** | | [optional] +**client_roles** | **Dict[str, object]** | | [optional] +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**path** | **str** | | [optional] +**realm_roles** | **List[str]** | | [optional] +**sub_groups** | [**List[UserGroup]**](UserGroup.md) | | [optional] + +## Example + +```python +from cloudharness_model.models.user_group import UserGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of UserGroup from a JSON string +user_group_instance = UserGroup.from_json(json) +# print the JSON string representation of the object +print UserGroup.to_json() + +# convert the object into a dict +user_group_dict = user_group_instance.to_dict() +# create an instance of UserGroup from a dict +user_group_form_dict = user_group.from_dict(user_group_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) + + diff --git a/docs/model/UserRole.md b/docs/model/UserRole.md new file mode 100644 index 00000000..9e244bb1 --- /dev/null +++ b/docs/model/UserRole.md @@ -0,0 +1,35 @@ +# UserRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **Dict[str, object]** | | [optional] +**client_role** | **bool** | | [optional] +**composite** | **bool** | | [optional] +**container_id** | **str** | | [optional] +**description** | **str** | | [optional] +**id** | **str** | | [optional] +**name** | **str** | | [optional] + +## Example + +```python +from cloudharness_model.models.user_role import UserRole + +# TODO update the JSON string below +json = "{}" +# create an instance of UserRole from a JSON string +user_role_instance = UserRole.from_json(json) +# print the JSON string representation of the object +print UserRole.to_json() + +# convert the object into a dict +user_role_dict = user_role_instance.to_dict() +# create an instance of UserRole from a dict +user_role_form_dict = user_role.from_dict(user_role_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) + + diff --git a/tools/deployment-cli-tools/ch_cli_tools/openapi.py b/tools/deployment-cli-tools/ch_cli_tools/openapi.py index 978b0322..05a22b44 100644 --- a/tools/deployment-cli-tools/ch_cli_tools/openapi.py +++ b/tools/deployment-cli-tools/ch_cli_tools/openapi.py @@ -50,7 +50,7 @@ def generate_model(base_path=ROOT): command = f"java -jar {CODEGEN} generate -i {base_path}/libraries/models/api/openapi.yaml -g python -o {tmp_path} --skip-validate-spec -c {base_path}/libraries/models/api/config.json" os.system(command) try: - source_dir = join(tmp_path, "docs/models") + source_dir = join(tmp_path, "docs") if not os.path.exists(source_dir): os.makedirs(source_dir) From cc8f107e54abd51abcf70cd36b804bd3ee798f1e Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Tue, 30 Jul 2024 10:43:52 +0100 Subject: [PATCH 5/8] CH-91 updated base model imports to custom base model --- .../models/api_tests_config.py | 2 +- .../models/application_accounts_config.py | 2 +- .../models/application_config.py | 2 +- .../models/application_dependencies_config.py | 2 +- .../models/application_harness_config.py | 2 +- .../models/application_probe.py | 2 +- .../models/application_test_config.py | 2 +- .../models/application_user.py | 2 +- .../models/auto_artifact_spec.py | 2 +- .../models/backup_config.py | 2 +- .../cloudharness_model/models/base_model.py | 68 ------------------- .../cloudharness_model/models/cdc_event.py | 2 +- .../models/cdc_event_meta.py | 2 +- .../models/cpu_memory_config.py | 2 +- .../models/database_deployment_config.py | 2 +- .../models/deployment_auto_artifact_config.py | 2 +- .../models/deployment_resources_conf.py | 2 +- .../models/deployment_volume_spec.py | 2 +- .../models/e2_e_tests_config.py | 2 +- .../models/file_resources_config.py | 2 +- .../models/git_dependency_config.py | 2 +- .../models/harness_main_config.py | 2 +- .../models/ingress_config.py | 2 +- .../ingress_config_all_of_letsencrypt.py | 2 +- .../models/jupyter_hub_config.py | 2 +- .../cloudharness_model/models/name_value.py | 2 +- .../models/registry_config.py | 2 +- .../models/service_auto_artifact_config.py | 2 +- .../models/unit_tests_config.py | 2 +- .../models/uri_role_mapping_config.py | 2 +- .../models/cloudharness_model/models/user.py | 2 +- .../models/user_credential.py | 2 +- .../cloudharness_model/models/user_group.py | 6 +- .../cloudharness_model/models/user_role.py | 2 +- 34 files changed, 35 insertions(+), 103 deletions(-) delete mode 100644 libraries/models/cloudharness_model/models/base_model.py diff --git a/libraries/models/cloudharness_model/models/api_tests_config.py b/libraries/models/cloudharness_model/models/api_tests_config.py index a4476c08..a7965a55 100644 --- a/libraries/models/cloudharness_model/models/api_tests_config.py +++ b/libraries/models/cloudharness_model/models/api_tests_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/application_accounts_config.py b/libraries/models/cloudharness_model/models/application_accounts_config.py index 9a97db85..9dc8b124 100644 --- a/libraries/models/cloudharness_model/models/application_accounts_config.py +++ b/libraries/models/cloudharness_model/models/application_accounts_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.application_user import ApplicationUser from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/application_config.py b/libraries/models/cloudharness_model/models/application_config.py index f423ee3b..26a6c813 100644 --- a/libraries/models/cloudharness_model/models/application_config.py +++ b/libraries/models/cloudharness_model/models/application_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.application_harness_config import ApplicationHarnessConfig from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/application_dependencies_config.py b/libraries/models/cloudharness_model/models/application_dependencies_config.py index a09df86f..1bfd211e 100644 --- a/libraries/models/cloudharness_model/models/application_dependencies_config.py +++ b/libraries/models/cloudharness_model/models/application_dependencies_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.git_dependency_config import GitDependencyConfig from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/application_harness_config.py b/libraries/models/cloudharness_model/models/application_harness_config.py index ad85a40b..1921de7b 100644 --- a/libraries/models/cloudharness_model/models/application_harness_config.py +++ b/libraries/models/cloudharness_model/models/application_harness_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.application_accounts_config import ApplicationAccountsConfig from cloudharness_model.models.application_dependencies_config import ApplicationDependenciesConfig from cloudharness_model.models.application_probe import ApplicationProbe diff --git a/libraries/models/cloudharness_model/models/application_probe.py b/libraries/models/cloudharness_model/models/application_probe.py index 75864acc..0b590781 100644 --- a/libraries/models/cloudharness_model/models/application_probe.py +++ b/libraries/models/cloudharness_model/models/application_probe.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/application_test_config.py b/libraries/models/cloudharness_model/models/application_test_config.py index 3ad31523..73b76e53 100644 --- a/libraries/models/cloudharness_model/models/application_test_config.py +++ b/libraries/models/cloudharness_model/models/application_test_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.api_tests_config import ApiTestsConfig from cloudharness_model.models.e2_e_tests_config import E2ETestsConfig from cloudharness_model.models.unit_tests_config import UnitTestsConfig diff --git a/libraries/models/cloudharness_model/models/application_user.py b/libraries/models/cloudharness_model/models/application_user.py index 991d8ea3..78c3479c 100644 --- a/libraries/models/cloudharness_model/models/application_user.py +++ b/libraries/models/cloudharness_model/models/application_user.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/auto_artifact_spec.py b/libraries/models/cloudharness_model/models/auto_artifact_spec.py index c0c89ac3..1280a055 100644 --- a/libraries/models/cloudharness_model/models/auto_artifact_spec.py +++ b/libraries/models/cloudharness_model/models/auto_artifact_spec.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/backup_config.py b/libraries/models/cloudharness_model/models/backup_config.py index 0613c70d..b4198553 100644 --- a/libraries/models/cloudharness_model/models/backup_config.py +++ b/libraries/models/cloudharness_model/models/backup_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf import re from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/base_model.py b/libraries/models/cloudharness_model/models/base_model.py deleted file mode 100644 index 0938bbc9..00000000 --- a/libraries/models/cloudharness_model/models/base_model.py +++ /dev/null @@ -1,68 +0,0 @@ -import pprint - -import typing - -from cloudharness_model import util - -T = typing.TypeVar('T') - - -class Model: - # openapiTypes: The key is attribute name and the - # value is attribute type. - openapi_types: typing.Dict[str, type] = {} - - # attributeMap: The key is attribute name and the - # value is json key in definition. - attribute_map: typing.Dict[str, str] = {} - - @classmethod - def from_dict(cls: typing.Type[T], dikt) -> T: - """Returns the dict as a model""" - return util.deserialize_model(dikt, cls) - - def to_dict(self): - """Returns the model properties as a dict - - :rtype: dict - """ - result = {} - - for attr in self.openapi_types: - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """Returns the string representation of the model - - :rtype: str - """ - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/libraries/models/cloudharness_model/models/cdc_event.py b/libraries/models/cloudharness_model/models/cdc_event.py index b8861ad1..b1db28fe 100644 --- a/libraries/models/cloudharness_model/models/cdc_event.py +++ b/libraries/models/cloudharness_model/models/cdc_event.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.cdc_event_meta import CDCEventMeta from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/cdc_event_meta.py b/libraries/models/cloudharness_model/models/cdc_event_meta.py index 78db4e05..30591287 100644 --- a/libraries/models/cloudharness_model/models/cdc_event_meta.py +++ b/libraries/models/cloudharness_model/models/cdc_event_meta.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.user import User from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/cpu_memory_config.py b/libraries/models/cloudharness_model/models/cpu_memory_config.py index 8f4f1e70..63fcee6a 100644 --- a/libraries/models/cloudharness_model/models/cpu_memory_config.py +++ b/libraries/models/cloudharness_model/models/cpu_memory_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/database_deployment_config.py b/libraries/models/cloudharness_model/models/database_deployment_config.py index 1be424a2..b9b7faa5 100644 --- a/libraries/models/cloudharness_model/models/database_deployment_config.py +++ b/libraries/models/cloudharness_model/models/database_deployment_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf import re from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py b/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py index ab31de80..56ef4b69 100644 --- a/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py +++ b/libraries/models/cloudharness_model/models/deployment_auto_artifact_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.deployment_resources_conf import DeploymentResourcesConf from cloudharness_model.models.deployment_volume_spec import DeploymentVolumeSpec import re diff --git a/libraries/models/cloudharness_model/models/deployment_resources_conf.py b/libraries/models/cloudharness_model/models/deployment_resources_conf.py index 27c09148..2d122230 100644 --- a/libraries/models/cloudharness_model/models/deployment_resources_conf.py +++ b/libraries/models/cloudharness_model/models/deployment_resources_conf.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.cpu_memory_config import CpuMemoryConfig from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/deployment_volume_spec.py b/libraries/models/cloudharness_model/models/deployment_volume_spec.py index 7fc64914..7843eae9 100644 --- a/libraries/models/cloudharness_model/models/deployment_volume_spec.py +++ b/libraries/models/cloudharness_model/models/deployment_volume_spec.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/e2_e_tests_config.py b/libraries/models/cloudharness_model/models/e2_e_tests_config.py index 6ae48d93..baba68df 100644 --- a/libraries/models/cloudharness_model/models/e2_e_tests_config.py +++ b/libraries/models/cloudharness_model/models/e2_e_tests_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/file_resources_config.py b/libraries/models/cloudharness_model/models/file_resources_config.py index fff73422..2c73b702 100644 --- a/libraries/models/cloudharness_model/models/file_resources_config.py +++ b/libraries/models/cloudharness_model/models/file_resources_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model import re from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/git_dependency_config.py b/libraries/models/cloudharness_model/models/git_dependency_config.py index 8e3acf61..8b380815 100644 --- a/libraries/models/cloudharness_model/models/git_dependency_config.py +++ b/libraries/models/cloudharness_model/models/git_dependency_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/harness_main_config.py b/libraries/models/cloudharness_model/models/harness_main_config.py index 6691ed07..ea8b7478 100644 --- a/libraries/models/cloudharness_model/models/harness_main_config.py +++ b/libraries/models/cloudharness_model/models/harness_main_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.application_config import ApplicationConfig from cloudharness_model.models.backup_config import BackupConfig from cloudharness_model.models.name_value import NameValue diff --git a/libraries/models/cloudharness_model/models/ingress_config.py b/libraries/models/cloudharness_model/models/ingress_config.py index e0da288f..d0b5352d 100644 --- a/libraries/models/cloudharness_model/models/ingress_config.py +++ b/libraries/models/cloudharness_model/models/ingress_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.ingress_config_all_of_letsencrypt import IngressConfigAllOfLetsencrypt from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py b/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py index 467e18a2..a9286c07 100644 --- a/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py +++ b/libraries/models/cloudharness_model/models/ingress_config_all_of_letsencrypt.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/jupyter_hub_config.py b/libraries/models/cloudharness_model/models/jupyter_hub_config.py index 5aaa9850..35095ce4 100644 --- a/libraries/models/cloudharness_model/models/jupyter_hub_config.py +++ b/libraries/models/cloudharness_model/models/jupyter_hub_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/name_value.py b/libraries/models/cloudharness_model/models/name_value.py index abf07fe6..22c0f511 100644 --- a/libraries/models/cloudharness_model/models/name_value.py +++ b/libraries/models/cloudharness_model/models/name_value.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/registry_config.py b/libraries/models/cloudharness_model/models/registry_config.py index 7ce48e9c..8e2830c6 100644 --- a/libraries/models/cloudharness_model/models/registry_config.py +++ b/libraries/models/cloudharness_model/models/registry_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/service_auto_artifact_config.py b/libraries/models/cloudharness_model/models/service_auto_artifact_config.py index 77bded86..4225711b 100644 --- a/libraries/models/cloudharness_model/models/service_auto_artifact_config.py +++ b/libraries/models/cloudharness_model/models/service_auto_artifact_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/unit_tests_config.py b/libraries/models/cloudharness_model/models/unit_tests_config.py index 680d984a..6983c7fb 100644 --- a/libraries/models/cloudharness_model/models/unit_tests_config.py +++ b/libraries/models/cloudharness_model/models/unit_tests_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/uri_role_mapping_config.py b/libraries/models/cloudharness_model/models/uri_role_mapping_config.py index 649ae22e..4a86884c 100644 --- a/libraries/models/cloudharness_model/models/uri_role_mapping_config.py +++ b/libraries/models/cloudharness_model/models/uri_role_mapping_config.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model import re from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/user.py b/libraries/models/cloudharness_model/models/user.py index 0676fbae..698ad2ce 100644 --- a/libraries/models/cloudharness_model/models/user.py +++ b/libraries/models/cloudharness_model/models/user.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model.models.user_credential import UserCredential from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/user_credential.py b/libraries/models/cloudharness_model/models/user_credential.py index 1b692f8f..48f77e4f 100644 --- a/libraries/models/cloudharness_model/models/user_credential.py +++ b/libraries/models/cloudharness_model/models/user_credential.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util diff --git a/libraries/models/cloudharness_model/models/user_group.py b/libraries/models/cloudharness_model/models/user_group.py index 0cf48e99..153f84fa 100644 --- a/libraries/models/cloudharness_model/models/user_group.py +++ b/libraries/models/cloudharness_model/models/user_group.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util @@ -224,7 +224,7 @@ def realm_roles(self, realm_roles: List[str]): self._realm_roles = realm_roles @property - def sub_groups(self) -> List[UserGroup]: + def sub_groups(self) -> List['UserGroup']: """Gets the sub_groups of this UserGroup. @@ -234,7 +234,7 @@ def sub_groups(self) -> List[UserGroup]: return self._sub_groups @sub_groups.setter - def sub_groups(self, sub_groups: List[UserGroup]): + def sub_groups(self, sub_groups: List['UserGroup']): """Sets the sub_groups of this UserGroup. diff --git a/libraries/models/cloudharness_model/models/user_role.py b/libraries/models/cloudharness_model/models/user_role.py index 8cbc7d00..96be6a92 100644 --- a/libraries/models/cloudharness_model/models/user_role.py +++ b/libraries/models/cloudharness_model/models/user_role.py @@ -2,7 +2,7 @@ from typing import List, Dict # noqa: F401 -from cloudharness_model.models.base_model import Model +from cloudharness_model.models.base_model_ import Model from cloudharness_model import util From 016e0fffdba0256b7f443c3e0132671d1e1acf28 Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Tue, 30 Jul 2024 11:22:09 +0100 Subject: [PATCH 6/8] CH-91 updated samples minimal values to remove implicit dependency on common --- applications/samples/deploy/values-minimal.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/applications/samples/deploy/values-minimal.yaml b/applications/samples/deploy/values-minimal.yaml index 23f80267..ee31280d 100644 --- a/applications/samples/deploy/values-minimal.yaml +++ b/applications/samples/deploy/values-minimal.yaml @@ -3,4 +3,5 @@ harness: dependencies: soft: [] hard: [] + use_services: [] From b8afcea21369a3da33c3a928fc4c0f816e858006 Mon Sep 17 00:00:00 2001 From: Jake Conkerton-Darby Date: Tue, 30 Jul 2024 13:47:36 +0100 Subject: [PATCH 7/8] CH-91 Added an extra test to ensure env and envmap work together in values definition --- .../samples/backend/samples/controllers/test_controller.py | 1 + applications/samples/deploy/values-minimal.yaml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/applications/samples/backend/samples/controllers/test_controller.py b/applications/samples/backend/samples/controllers/test_controller.py index 3fb922f2..ff108973 100644 --- a/applications/samples/backend/samples/controllers/test_controller.py +++ b/applications/samples/backend/samples/controllers/test_controller.py @@ -26,6 +26,7 @@ def ping(): # noqa: E501 import os expected_environment_variables = { + 'WORKERS': '3', 'ENVIRONMENT_TEST_A': 'value', 'ENVIRONMENT_TEST_B': '123', } diff --git a/applications/samples/deploy/values-minimal.yaml b/applications/samples/deploy/values-minimal.yaml index ee31280d..1312b943 100644 --- a/applications/samples/deploy/values-minimal.yaml +++ b/applications/samples/deploy/values-minimal.yaml @@ -1,5 +1,5 @@ harness: - secured: true + secured: false dependencies: soft: [] hard: [] From 419910db974e281be04c69b7fab1f65f8e58e06c Mon Sep 17 00:00:00 2001 From: Filippo Ledda Date: Tue, 30 Jul 2024 14:58:49 +0200 Subject: [PATCH 8/8] CH-141 merge json files --- .../webapp/frontend/package.json | 11 +++++++ .../deployment-cli-tools/ch_cli_tools/helm.py | 2 +- .../ch_cli_tools/utils.py | 32 +++++++++++++++++++ .../deployment-cli-tools/harness-application | 1 + .../tests/resources/conf-source1/a.json | 7 ++++ .../tests/resources/conf-source1/b.json | 7 ++++ .../tests/resources/conf-source2/a.json | 7 ++++ .../tests/resources/conf-source2/c.json | 7 ++++ .../deployment-cli-tools/tests/test_utils.py | 11 +++++++ 9 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 application-templates/webapp/frontend/package.json create mode 100644 tools/deployment-cli-tools/tests/resources/conf-source1/a.json create mode 100644 tools/deployment-cli-tools/tests/resources/conf-source1/b.json create mode 100644 tools/deployment-cli-tools/tests/resources/conf-source2/a.json create mode 100644 tools/deployment-cli-tools/tests/resources/conf-source2/c.json diff --git a/application-templates/webapp/frontend/package.json b/application-templates/webapp/frontend/package.json new file mode 100644 index 00000000..b8d45278 --- /dev/null +++ b/application-templates/webapp/frontend/package.json @@ -0,0 +1,11 @@ +{ + "name": "__APP_NAME__", + "scripts": { + "dev": "vite", + "start": "DOMAIN=http://localhost:5000 vite", + "start:dev": "DOMAIN=https://test.ch.metacell.us vite", + "start:local": "DOMAIN=http://samples.ch vite", + "prebuild": "eslint .", + "build": "vite build" + } +} diff --git a/tools/deployment-cli-tools/ch_cli_tools/helm.py b/tools/deployment-cli-tools/ch_cli_tools/helm.py index dc4a6cba..2552dcbe 100644 --- a/tools/deployment-cli-tools/ch_cli_tools/helm.py +++ b/tools/deployment-cli-tools/ch_cli_tools/helm.py @@ -410,7 +410,7 @@ def image_tag(self, image_name, build_context_path=None, dependencies=()): ignore = set(DEFAULT_IGNORE) if os.path.exists(ignore_path): with open(ignore_path) as f: - ignore = ignore.union({line.strip() for line in f}) + ignore = ignore.union({line.strip() for line in f if line.strip() and not line.startswith('#')}) logging.info(f"Ignoring {ignore}") tag = generate_tag_from_content(build_context_path, ignore) logging.info(f"Content hash: {tag}") diff --git a/tools/deployment-cli-tools/ch_cli_tools/utils.py b/tools/deployment-cli-tools/ch_cli_tools/utils.py index 9e2cbf9e..3ec8e6f3 100644 --- a/tools/deployment-cli-tools/ch_cli_tools/utils.py +++ b/tools/deployment-cli-tools/ch_cli_tools/utils.py @@ -145,6 +145,8 @@ def get_template(yaml_path, base_default=False): def file_is_yaml(fname): return fname[-4:] == 'yaml' or fname[-3:] == 'yml' +def file_is_json(fname): + return fname[-4:] == 'json' def replaceindir(root_src_dir, source, replace): """ @@ -270,6 +272,14 @@ def merge_configuration_directories(source, dest): except Exception as e: logging.warning(f"Overwriting file {fdest} with {fpath}") shutil.copy2(fpath, fdest) + elif file_is_json(fpath): + try: + merge_json_files(fpath, fdest) + logging.info( + f"Merged/overridden file content of {fdest} with {fpath}") + except Exception as e: + logging.warning(f"Overwriting file {fdest} with {fpath}") + shutil.copy2(fpath, fdest) else: logging.warning(f"Overwriting file {fdest} with {fpath}") shutil.copy2(fpath, fdest) @@ -280,6 +290,28 @@ def merge_yaml_files(fname, fdest): content_src = yaml.load(f) merge_to_yaml_file(content_src, fdest) +def merge_json_files(fname, fdest): + with open(fname) as f: + content_src = json.load(f) + merge_to_json_file(content_src, fdest) + +def merge_to_json_file(content_src, fdest): + if not content_src: + return + if not exists(fdest): + merged = content_src + else: + with open(fdest) as f: + content_dest = json.load(f) + + merged = dict_merge( + content_dest, content_src) if content_dest else content_src + + if not exists(dirname(fdest)): + os.makedirs(dirname(fdest)) + with open(fdest, "w") as f: + json.dump(merged, f, indent=2) + return merged def merge_to_yaml_file(content_src, fdest): if not content_src: diff --git a/tools/deployment-cli-tools/harness-application b/tools/deployment-cli-tools/harness-application index cc626eea..37bec808 100644 --- a/tools/deployment-cli-tools/harness-application +++ b/tools/deployment-cli-tools/harness-application @@ -71,6 +71,7 @@ if __name__ == "__main__": shutil.move(os.path.join(app_path, args.name), os.path.join(app_path, 'frontend')) generate_ts_client(openapi_file=os.path.join(app_path, 'api/openapi.yaml')) + if 'server' in templates: with tempfile.TemporaryDirectory() as tmp_dirname: copymergedir(os.path.join(CH_ROOT, APPLICATION_TEMPLATE_PATH, template_name), tmp_dirname) diff --git a/tools/deployment-cli-tools/tests/resources/conf-source1/a.json b/tools/deployment-cli-tools/tests/resources/conf-source1/a.json new file mode 100644 index 00000000..acc95bb9 --- /dev/null +++ b/tools/deployment-cli-tools/tests/resources/conf-source1/a.json @@ -0,0 +1,7 @@ +{ + "a": "a", + "b": { + "ba": "ba", + "bc": "bc" + } +} \ No newline at end of file diff --git a/tools/deployment-cli-tools/tests/resources/conf-source1/b.json b/tools/deployment-cli-tools/tests/resources/conf-source1/b.json new file mode 100644 index 00000000..424af7c0 --- /dev/null +++ b/tools/deployment-cli-tools/tests/resources/conf-source1/b.json @@ -0,0 +1,7 @@ +{ + "a": "a", + "b": { + "ba": "ba", + "bb": "bb" + } +} \ No newline at end of file diff --git a/tools/deployment-cli-tools/tests/resources/conf-source2/a.json b/tools/deployment-cli-tools/tests/resources/conf-source2/a.json new file mode 100644 index 00000000..c7f21ebc --- /dev/null +++ b/tools/deployment-cli-tools/tests/resources/conf-source2/a.json @@ -0,0 +1,7 @@ +{ + "a": "a1", + "b": { + "ba": "ba1", + "bb": "bb" + } +} \ No newline at end of file diff --git a/tools/deployment-cli-tools/tests/resources/conf-source2/c.json b/tools/deployment-cli-tools/tests/resources/conf-source2/c.json new file mode 100644 index 00000000..424af7c0 --- /dev/null +++ b/tools/deployment-cli-tools/tests/resources/conf-source2/c.json @@ -0,0 +1,7 @@ +{ + "a": "a", + "b": { + "ba": "ba", + "bb": "bb" + } +} \ No newline at end of file diff --git a/tools/deployment-cli-tools/tests/test_utils.py b/tools/deployment-cli-tools/tests/test_utils.py index cbd813c1..cade7770 100644 --- a/tools/deployment-cli-tools/tests/test_utils.py +++ b/tools/deployment-cli-tools/tests/test_utils.py @@ -47,6 +47,17 @@ def test_merge_configuration_directories(): assert a['b']['ba'] == 'ba1' assert a['b']['bb'] == 'bb' assert a['b']['bc'] == 'bc' + + assert os.path.exists(os.path.join(res_path, "a.json")) + assert os.path.exists(os.path.join(res_path, "b.json")) + assert os.path.exists(os.path.join(res_path, "c.json")) + + with open(os.path.join(res_path, "a.json")) as f: + a = json.load(f) + assert a['a'] == 'a1' + assert a['b']['ba'] == 'ba1' + assert a['b']['bb'] == 'bb' + assert a['b']['bc'] == 'bc' finally: if os.path.exists(res_path): shutil.rmtree(res_path)