Update Katib SDK with OpenAPI generator (#1572)

* Use openapi JAR

* Remove test from SDK

* Use k8s>=12.0 version

.gitignore

@@ -7,6 +7,9 @@ __pycache__/
 build/
 *.charm
 
+# SDK generator JAR file
+hack/gen-python-sdk/openapi-generator-cli.jar
+
 # Project specific ignore files
 *.swp
 bin

hack/gen-python-sdk/gen-sdk.sh

@@ -18,26 +18,29 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-SWAGGER_JAR_URL="http://search.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.6/swagger-codegen-cli-2.4.6.jar"
-SWAGGER_CODEGEN_JAR="hack/gen-python-sdk/swagger-codegen-cli.jar"
+SWAGGER_JAR_URL="https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar"
+SWAGGER_CODEGEN_JAR="hack/gen-python-sdk/openapi-generator-cli.jar"
+
 SWAGGER_CODEGEN_CONF="hack/gen-python-sdk/swagger_config.json"
 SWAGGER_CODEGEN_FILE="pkg/apis/KATIB_VERSION/swagger.json"
+
 TMP_CODEGEN_PATH="sdk/tmp/KATIB_VERSION"
 SDK_OUTPUT_PATH="sdk/python"
 POST_GEN_PYTHON_HANDLER="hack/gen-python-sdk/post_gen.py"
 KATIB_VERSIONS=(v1beta1)
 
-echo "Downloading the swagger-codegen JAR package ..."
-wget -O ${SWAGGER_CODEGEN_JAR} ${SWAGGER_JAR_URL}
+# Download JAR package if file doesn't exist.
+if ! test -f ${SWAGGER_CODEGEN_JAR}; then
+    echo "Downloading the openapi generator JAR package ..."
+    wget -O ${SWAGGER_CODEGEN_JAR} ${SWAGGER_JAR_URL}
+fi
 
 for VERSION in ${KATIB_VERSIONS[@]}; do
     echo "Generating Python SDK for Kubeflow Katib ${VERSION} ..."
     SWAGGER_FILE=${SWAGGER_CODEGEN_FILE/KATIB_VERSION/$VERSION}
     TMP_PATH=${TMP_CODEGEN_PATH/KATIB_VERSION/$VERSION}
-    java -jar ${SWAGGER_CODEGEN_JAR} generate -i ${SWAGGER_FILE} -l python -o ${TMP_PATH} -c ${SWAGGER_CODEGEN_CONF}
+    java -jar ${SWAGGER_CODEGEN_JAR} generate -i ${SWAGGER_FILE} -g python -o ${TMP_PATH} -c ${SWAGGER_CODEGEN_CONF}
 
     # Run post gen script.
     python ${POST_GEN_PYTHON_HANDLER} ${TMP_PATH} ${SDK_OUTPUT_PATH}/${VERSION}
 done
-
-rm ${SWAGGER_CODEGEN_JAR}

hack/gen-python-sdk/post_gen.py

@@ -39,7 +39,6 @@ def _rewrite_helper(input_file, output_file, rewrite_rules):
 
     # Add Katib client to init file.
     if (output_file == "sdk/python/v1beta1/kubeflow/katib/__init__.py"):
-        lines.append("\n")
         lines.append("# Import Katib API client.\n")
         lines.append("from kubeflow.katib.api.katib_client import KatibClient\n")
 
@@ -85,16 +84,17 @@ def update_python_sdk(src, dest, versions=('v1beta1')):
                             'python/blob/master/kubernetes/docs/V1HTTPGetAction.md)')
     ]
 
+    # TODO (andreyvelich): Currently test can't be generated properly.
     src_dirs = [
         os.path.join(src, 'katib'),
         os.path.join(src, 'katib', 'models'),
-        os.path.join(src, 'test'),
+        # os.path.join(src, 'test'),
         os.path.join(src, 'docs')
     ]
     dest_dirs = [
         os.path.join(dest, 'kubeflow', 'katib'),
         os.path.join(dest, 'kubeflow', 'katib', 'models'),
-        os.path.join(dest, 'test'),
+        # os.path.join(dest, 'test'),
         os.path.join(dest, 'docs')
     ]
 

sdk/python/v1beta1/docs/V1beta1AlgorithmSetting.md

@@ -1,5 +1,6 @@
 # V1beta1AlgorithmSetting
 
+AlgorithmSetting represents key-value pair for HP or NAS algorithm settings.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1AlgorithmSpec.md

@@ -1,5 +1,6 @@
 # V1beta1AlgorithmSpec
 
+AlgorithmSpec is the specification for a HP or NAS algorithm.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1CollectorSpec.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**custom_collector** | [**V1Container**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Container.md) | When kind is \"customCollector\", this field will be used | [optional] 
+**custom_collector** | [**V1Container**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Container.md) |  | [optional] 
 **kind** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

sdk/python/v1beta1/docs/V1beta1ConfigMapSource.md

@@ -1,5 +1,6 @@
 # V1beta1ConfigMapSource
 
+ConfigMapSource references the config map where trial template is located
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1EarlyStoppingRule.md

@@ -1,5 +1,6 @@
 # V1beta1EarlyStoppingRule
 
+EarlyStoppingRule represents each rule for early stopping.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1EarlyStoppingSetting.md

@@ -1,5 +1,6 @@
 # V1beta1EarlyStoppingSetting
 
+EarlyStoppingSetting represents key-value pair for early stopping algorithm settings.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1EarlyStoppingSpec.md

@@ -1,5 +1,6 @@
 # V1beta1EarlyStoppingSpec
 
+EarlyStoppingSpec is the specification for a early stopping algorithm.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1Experiment.md

@@ -1,5 +1,6 @@
 # V1beta1Experiment
 
+Structure of the Experiment custom resource.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1ExperimentCondition.md

@@ -1,10 +1,11 @@
 # V1beta1ExperimentCondition
 
+ExperimentCondition describes the state of the experiment at a certain point.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**last_transition_time** | **datetime** | Last time the condition transitioned from one status to another. | [optional] 
-**last_update_time** | **datetime** | The last time this condition was updated. | [optional] 
+**last_transition_time** | **datetime** |  | [optional] 
+**last_update_time** | **datetime** |  | [optional] 
 **message** | **str** | A human readable message indicating details about the transition. | [optional] 
 **reason** | **str** | The reason for the condition's last transition. | [optional] 
 **status** | **str** | Status of the condition, one of True, False, Unknown. | [default to '']

sdk/python/v1beta1/docs/V1beta1ExperimentList.md

@@ -1,5 +1,6 @@
 # V1beta1ExperimentList
 
+ExperimentList contains a list of Experiments
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1ExperimentSpec.md

@@ -1,19 +1,20 @@
 # V1beta1ExperimentSpec
 
+ExperimentSpec is the specification of an Experiment.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**algorithm** | [**V1beta1AlgorithmSpec**](V1beta1AlgorithmSpec.md) | Describes the suggestion algorithm. | [optional] 
-**early_stopping** | [**V1beta1EarlyStoppingSpec**](V1beta1EarlyStoppingSpec.md) | Describes the early stopping algorithm. | [optional] 
+**algorithm** | [**V1beta1AlgorithmSpec**](V1beta1AlgorithmSpec.md) |  | [optional] 
+**early_stopping** | [**V1beta1EarlyStoppingSpec**](V1beta1EarlyStoppingSpec.md) |  | [optional] 
 **max_failed_trial_count** | **int** | Max failed trials to mark experiment as failed. | [optional] 
 **max_trial_count** | **int** | Max completed trials to mark experiment as succeeded | [optional] 
-**metrics_collector_spec** | [**V1beta1MetricsCollectorSpec**](V1beta1MetricsCollectorSpec.md) | Describes the specification of the metrics collector | [optional] 
+**metrics_collector_spec** | [**V1beta1MetricsCollectorSpec**](V1beta1MetricsCollectorSpec.md) |  | [optional] 
 **nas_config** | [**V1beta1NasConfig**](V1beta1NasConfig.md) |  | [optional] 
-**objective** | [**V1beta1ObjectiveSpec**](V1beta1ObjectiveSpec.md) | Describes the objective of the experiment. | [optional] 
+**objective** | [**V1beta1ObjectiveSpec**](V1beta1ObjectiveSpec.md) |  | [optional] 
 **parallel_trial_count** | **int** | How many trials can be processed in parallel. Defaults to 3 | [optional] 
 **parameters** | [**list[V1beta1ParameterSpec]**](V1beta1ParameterSpec.md) | List of hyperparameter configurations. | [optional] 
 **resume_policy** | **str** | Describes resuming policy which usually take effect after experiment terminated. | [optional] 
-**trial_template** | [**V1beta1TrialTemplate**](V1beta1TrialTemplate.md) | Template for each run of the trial. | [optional] 
+**trial_template** | [**V1beta1TrialTemplate**](V1beta1TrialTemplate.md) |  | [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)
 

sdk/python/v1beta1/docs/V1beta1ExperimentStatus.md

@@ -1,18 +1,19 @@
 # V1beta1ExperimentStatus
 
+ExperimentStatus is the current status of an Experiment.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**completion_time** | **datetime** | Represents time when the Experiment was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 
+**completion_time** | **datetime** |  | [optional] 
 **conditions** | [**list[V1beta1ExperimentCondition]**](V1beta1ExperimentCondition.md) | List of observed runtime conditions for this Experiment. | [optional] 
-**current_optimal_trial** | [**V1beta1OptimalTrial**](V1beta1OptimalTrial.md) | Current optimal trial parameters and observations. | [optional] 
+**current_optimal_trial** | [**V1beta1OptimalTrial**](V1beta1OptimalTrial.md) |  | [optional] 
 **early_stopped_trial_list** | **list[str]** | List of trial names which have been early stopped. | [optional] 
 **failed_trial_list** | **list[str]** | List of trial names which have already failed. | [optional] 
 **killed_trial_list** | **list[str]** | List of trial names which have been killed. | [optional] 
-**last_reconcile_time** | **datetime** | Represents last time when the Experiment was reconciled. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 
+**last_reconcile_time** | **datetime** |  | [optional] 
 **pending_trial_list** | **list[str]** | List of trial names which are pending. | [optional] 
 **running_trial_list** | **list[str]** | List of trial names which are running. | [optional] 
-**start_time** | **datetime** | Represents time when the Experiment was acknowledged by the Experiment controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 
+**start_time** | **datetime** |  | [optional] 
 **succeeded_trial_list** | **list[str]** | List of trial names which have already succeeded. | [optional] 
 **trials** | **int** | Trials is the total number of trials owned by the experiment. | [optional] 
 **trials_early_stopped** | **int** | How many trials are currently early stopped. | [optional] 

sdk/python/v1beta1/docs/V1beta1GraphConfig.md

@@ -1,5 +1,6 @@
 # V1beta1GraphConfig
 
+GraphConfig contains a config of DAG
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1NasConfig.md

@@ -1,5 +1,6 @@
 # V1beta1NasConfig
 
+NasConfig contains config for NAS job
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1ObjectiveSpec.md

@@ -1,5 +1,6 @@
 # V1beta1ObjectiveSpec
 
+ObjectiveSpec represents Experiment's objective specification.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1Operation.md

@@ -1,5 +1,6 @@
 # V1beta1Operation
 
+Operation contains type of operation in DAG
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1OptimalTrial.md

@@ -1,10 +1,11 @@
 # V1beta1OptimalTrial
 
+OptimalTrial is the metrics and assignments of the best trial.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **best_trial_name** | **str** | BestTrialName is the name of the best trial. | [default to '']
-**observation** | [**V1beta1Observation**](V1beta1Observation.md) | Observation for this trial | [optional] 
+**observation** | [**V1beta1Observation**](V1beta1Observation.md) |  | [optional] 
 **parameter_assignments** | [**list[V1beta1ParameterAssignment]**](V1beta1ParameterAssignment.md) | Key-value pairs for hyperparameters and assignment values. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

sdk/python/v1beta1/docs/V1beta1SourceSpec.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file_system_path** | [**V1beta1FileSystemPath**](V1beta1FileSystemPath.md) | During training model, metrics may be persisted into local file in source code, such as tfEvent use case | [optional] 
-**filter** | [**V1beta1FilterSpec**](V1beta1FilterSpec.md) | Default metric output format is {\"metric\": \"<metric_name>\", \"value\": <int_or_float>, \"epoch\": <int>, \"step\": <int>}, but if the output doesn't follow default format, please extend it here | [optional] 
-**http_get** | [**V1HTTPGetAction**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1HTTPGetAction.md) | Model-train source code can expose metrics by http, such as HTTP endpoint in prometheus metric format | [optional] 
+**file_system_path** | [**V1beta1FileSystemPath**](V1beta1FileSystemPath.md) |  | [optional] 
+**filter** | [**V1beta1FilterSpec**](V1beta1FilterSpec.md) |  | [optional] 
+**http_get** | [**V1HTTPGetAction**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1HTTPGetAction.md) |  | [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)
 

sdk/python/v1beta1/docs/V1beta1Suggestion.md

@@ -1,5 +1,6 @@
 # V1beta1Suggestion
 
+Suggestion represents the structure of a Suggestion resource.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1SuggestionCondition.md

@@ -1,10 +1,11 @@
 # V1beta1SuggestionCondition
 
+SuggestionCondition describes the state of the Suggestion at a certain point.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**last_transition_time** | **datetime** | Last time the condition transitioned from one status to another. | [optional] 
-**last_update_time** | **datetime** | The last time this condition was updated. | [optional] 
+**last_transition_time** | **datetime** |  | [optional] 
+**last_update_time** | **datetime** |  | [optional] 
 **message** | **str** | A human readable message indicating details about the transition. | [optional] 
 **reason** | **str** | The reason for the condition's last transition. | [optional] 
 **status** | **str** | Status of the condition, one of True, False, Unknown. | [default to '']

sdk/python/v1beta1/docs/V1beta1SuggestionList.md

@@ -1,5 +1,6 @@
 # V1beta1SuggestionList
 
+SuggestionList contains a list of Suggestion
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1SuggestionSpec.md

@@ -1,10 +1,11 @@
 # V1beta1SuggestionSpec
 
+SuggestionSpec is the specification of a Suggestion.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**algorithm** | [**V1beta1AlgorithmSpec**](V1beta1AlgorithmSpec.md) | Algorithm describes HP or NAS algorithm that suggestion is used. | 
-**early_stopping** | [**V1beta1EarlyStoppingSpec**](V1beta1EarlyStoppingSpec.md) | EarlyStopping describes early stopping algorithm that suggestion is used. | [optional] 
+**algorithm** | [**V1beta1AlgorithmSpec**](V1beta1AlgorithmSpec.md) |  | 
+**early_stopping** | [**V1beta1EarlyStoppingSpec**](V1beta1EarlyStoppingSpec.md) |  | [optional] 
 **requests** | **int** | Number of suggestions requested. | [optional] 
 **resume_policy** | **str** | ResumePolicy describes resuming policy which usually take effect after experiment terminated. Default value is LongRunning. | [optional] 
 

sdk/python/v1beta1/docs/V1beta1SuggestionStatus.md

@@ -1,13 +1,14 @@
 # V1beta1SuggestionStatus
 
+SuggestionStatus is the current status of a Suggestion.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **algorithm_settings** | [**list[V1beta1AlgorithmSetting]**](V1beta1AlgorithmSetting.md) | AlgorithmSettings defines HP or NAS algorithm settings which suggestion gRPC service returns. These settings overwrites Experiment's settings before the gRPC request. It can be empty if settings haven't been changed. | [optional] 
-**completion_time** | **datetime** | Represents time when the Suggestion was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 
+**completion_time** | **datetime** |  | [optional] 
 **conditions** | [**list[V1beta1SuggestionCondition]**](V1beta1SuggestionCondition.md) | List of observed runtime conditions for this Suggestion. | [optional] 
-**last_reconcile_time** | **datetime** | Represents last time when the Suggestion was reconciled. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 
-**start_time** | **datetime** | Represents time when the Suggestion was acknowledged by the Suggestion controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 
+**last_reconcile_time** | **datetime** |  | [optional] 
+**start_time** | **datetime** |  | [optional] 
 **suggestion_count** | **int** | Number of suggestion results | [optional] 
 **suggestions** | [**list[V1beta1TrialAssignment]**](V1beta1TrialAssignment.md) | Suggestion results | [optional] 
 

sdk/python/v1beta1/docs/V1beta1Trial.md

@@ -1,5 +1,6 @@
 # V1beta1Trial
 
+Represents the structure of a Trial resource.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1TrialAssignment.md

@@ -1,5 +1,6 @@
 # V1beta1TrialAssignment
 
+TrialAssignment is the assignment for one trial.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1TrialCondition.md

@@ -1,10 +1,11 @@
 # V1beta1TrialCondition
 
+TrialCondition describes the state of the trial at a certain point.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**last_transition_time** | **datetime** | Last time the condition transitioned from one status to another. | [optional] 
-**last_update_time** | **datetime** | The last time this condition was updated. | [optional] 
+**last_transition_time** | **datetime** |  | [optional] 
+**last_update_time** | **datetime** |  | [optional] 
 **message** | **str** | A human readable message indicating details about the transition. | [optional] 
 **reason** | **str** | The reason for the condition's last transition. | [optional] 
 **status** | **str** | Status of the condition, one of True, False, Unknown. | [default to '']

sdk/python/v1beta1/docs/V1beta1TrialList.md

@@ -1,5 +1,6 @@
 # V1beta1TrialList
 
+TrialList contains a list of Trials
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1TrialParameterSpec.md

@@ -1,5 +1,6 @@
 # V1beta1TrialParameterSpec
 
+TrialParameterSpec describes parameters that must be replaced in trial template
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------

sdk/python/v1beta1/docs/V1beta1TrialSource.md

@@ -1,10 +1,11 @@
 # V1beta1TrialSource
 
+TrialSource represent the source for trial template Only one source can be specified
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**config_map** | [**V1beta1ConfigMapSource**](V1beta1ConfigMapSource.md) | ConfigMap spec represents a reference to ConfigMap | [optional] 
-**trial_spec** | **object** | TrialSpec represents trial template in unstructured format | [optional] 
+**config_map** | [**V1beta1ConfigMapSource**](V1beta1ConfigMapSource.md) |  | [optional] 
+**trial_spec** | **object** |  | [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)