Skip to content

Commit

Permalink
document status conditions for RoutesReady and LatestDeploymentReady (k…
Browse files Browse the repository at this point in the history
…ubeflow#3069)

* document new status conditions

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

* make generate

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

* fix linting

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

* remove requirements.txt in python

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

* comment out unnecessary git checkout lines

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

* indicate conditions for serverless mode only

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

* go mod tidy

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>

---------

Signed-off-by: Tessa Pham <hpham111@bloomberg.net>
  • Loading branch information
tessapham authored Aug 15, 2023
1 parent fc029ce commit d7bfd22
Show file tree
Hide file tree
Showing 95 changed files with 1,883 additions and 1,000 deletions.
4 changes: 2 additions & 2 deletions hack/python-sdk/client-gen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ java -jar ${SWAGGER_CODEGEN_JAR} generate -i ${SWAGGER_CODEGEN_FILE} -g python -
# revert following files since they are diveraged from generated ones
git checkout python/kserve/README.md
git checkout python/kserve/kserve/__init__.py
git checkout python/kserve/setup.py
git checkout python/kserve/requirements.txt
# git checkout python/kserve/setup.py
# git checkout python/kserve/requirements.txt

# Update kubernetes docs link.
K8S_IMPORT_LIST=`cat hack/python-sdk/swagger_config.json|grep "V1" | awk -F"\"" '{print $2}'`
Expand Down
3 changes: 2 additions & 1 deletion pkg/apis/serving/v1beta1/inference_service_status.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ type InferenceServiceStatus struct {
// - PredictorReady: predictor readiness condition; <br/>
// - TransformerReady: transformer readiness condition; <br/>
// - ExplainerReady: explainer readiness condition; <br/>
// - RoutesReady: aggregated routing condition; <br/>
// - RoutesReady (serverless mode only): aggregated routing condition, i.e. endpoint readiness condition; <br/>
// - LatestDeploymentReady (serverless mode only): aggregated configuration condition, i.e. latest deployment readiness condition; <br/>
// - Ready: aggregated condition; <br/>
duckv1.Status `json:",inline"`
// Addressable endpoint for the InferenceService
Expand Down
2 changes: 1 addition & 1 deletion python/kserve/docs/KnativeAddressable.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | [**KnativeURL**](KnativeURL.md) | | [optional]
**url** | [**KnativeURL**](KnativeURL.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)

Expand Down
8 changes: 4 additions & 4 deletions python/kserve/docs/KnativeCondition.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Conditions defines a readiness condition for a Knative resource. See: https://gi
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**last_transition_time** | [**KnativeVolatileTime**](KnativeVolatileTime.md) | LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant). | [optional]
**message** | **str** | A human readable message indicating details about the transition. | [optional]
**reason** | **str** | The reason for the condition&#39;s last transition. | [optional]
**severity** | **str** | Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error. | [optional]
**last_transition_time** | [**KnativeVolatileTime**](KnativeVolatileTime.md) | LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant). | [optional]
**message** | **str** | A human readable message indicating details about the transition. | [optional]
**reason** | **str** | The reason for the condition&#39;s last transition. | [optional]
**severity** | **str** | Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error. | [optional]
**status** | **str** | Status of the condition, one of True, False, Unknown. |
**type** | **str** | Type of condition. |

Expand Down
4 changes: 2 additions & 2 deletions python/kserve/docs/KnativeStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**conditions** | [**list[KnativeCondition]**](KnativeCondition.md) | Conditions the latest available observations of a resource&#39;s current state. | [optional]
**observed_generation** | **int** | ObservedGeneration is the &#39;Generation&#39; of the Service that was last processed by the controller. | [optional]
**conditions** | [**list[KnativeCondition]**](KnativeCondition.md) | Conditions the latest available observations of a resource&#39;s current state. | [optional]
**observed_generation** | **int** | ObservedGeneration is the &#39;Generation&#39; of the Service that was last processed by the controller. | [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)

Expand Down
10 changes: 5 additions & 5 deletions python/kserve/docs/V1alpha1BuiltInAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**env** | [**list[V1EnvVar]**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1EnvVar.md) | Environment variables used to control other aspects of the built-in adapter&#39;s behaviour (uncommon) | [optional]
**mem_buffer_bytes** | **int** | Fixed memory overhead to subtract from runtime container&#39;s memory allocation to determine model capacity | [optional]
**model_loading_timeout_millis** | **int** | Timeout for model loading operations in milliseconds | [optional]
**runtime_management_port** | **int** | Port which the runtime server listens for model management requests | [optional]
**server_type** | **str** | ServerType must be one of the supported built-in types such as \&quot;triton\&quot; or \&quot;mlserver\&quot;, and the runtime&#39;s container must have the same name | [optional]
**env** | [**list[V1EnvVar]**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1EnvVar.md) | Environment variables used to control other aspects of the built-in adapter&#39;s behaviour (uncommon) | [optional]
**mem_buffer_bytes** | **int** | Fixed memory overhead to subtract from runtime container&#39;s memory allocation to determine model capacity | [optional]
**model_loading_timeout_millis** | **int** | Timeout for model loading operations in milliseconds | [optional]
**runtime_management_port** | **int** | Port which the runtime server listens for model management requests | [optional]
**server_type** | **str** | ServerType must be one of the supported built-in types such as \&quot;triton\&quot; or \&quot;mlserver\&quot;, and the runtime&#39;s container must have the same name | [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)

Expand Down
10 changes: 5 additions & 5 deletions python/kserve/docs/V1alpha1ClusterServingRuntime.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ ClusterServingRuntime is the Schema for the servingruntimes API
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ObjectMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ObjectMeta.md) | | [optional]
**spec** | [**V1alpha1ServingRuntimeSpec**](V1alpha1ServingRuntimeSpec.md) | | [optional]
**status** | [**object**](.md) | ServingRuntimeStatus defines the observed state of ServingRuntime | [optional]
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ObjectMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ObjectMeta.md) | | [optional]
**spec** | [**V1alpha1ServingRuntimeSpec**](V1alpha1ServingRuntimeSpec.md) | | [optional]
**status** | [**object**](.md) | ServingRuntimeStatus defines the observed state of ServingRuntime | [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)

Expand Down
6 changes: 3 additions & 3 deletions python/kserve/docs/V1alpha1ClusterServingRuntimeList.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ ServingRuntimeList contains a list of ServingRuntime
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**items** | [**list[V1alpha1ClusterServingRuntime]**](V1alpha1ClusterServingRuntime.md) | |
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ListMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ListMeta.md) | | [optional]
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ListMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ListMeta.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)

Expand Down
20 changes: 10 additions & 10 deletions python/kserve/docs/V1alpha1Container.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**args** | **list[str]** | | [optional]
**command** | **list[str]** | | [optional]
**env** | [**list[V1EnvVar]**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1EnvVar.md) | | [optional]
**image** | **str** | | [optional]
**image_pull_policy** | **str** | | [optional]
**liveness_probe** | [**V1Probe**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Probe.md) | | [optional]
**name** | **str** | | [optional]
**readiness_probe** | [**V1Probe**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Probe.md) | | [optional]
**resources** | [**V1ResourceRequirements**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ResourceRequirements.md) | | [optional]
**working_dir** | **str** | | [optional]
**args** | **list[str]** | | [optional]
**command** | **list[str]** | | [optional]
**env** | [**list[V1EnvVar]**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1EnvVar.md) | | [optional]
**image** | **str** | | [optional]
**image_pull_policy** | **str** | | [optional]
**liveness_probe** | [**V1Probe**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Probe.md) | | [optional]
**name** | **str** | | [optional]
**readiness_probe** | [**V1Probe**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Probe.md) | | [optional]
**resources** | [**V1ResourceRequirements**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ResourceRequirements.md) | | [optional]
**working_dir** | **str** | | [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)

Expand Down
10 changes: 5 additions & 5 deletions python/kserve/docs/V1alpha1InferenceGraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ InferenceGraph is the Schema for the InferenceGraph API for multiple models
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ObjectMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ObjectMeta.md) | | [optional]
**spec** | [**V1alpha1InferenceGraphSpec**](V1alpha1InferenceGraphSpec.md) | | [optional]
**status** | [**V1alpha1InferenceGraphStatus**](V1alpha1InferenceGraphStatus.md) | | [optional]
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ObjectMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ObjectMeta.md) | | [optional]
**spec** | [**V1alpha1InferenceGraphSpec**](V1alpha1InferenceGraphSpec.md) | | [optional]
**status** | [**V1alpha1InferenceGraphStatus**](V1alpha1InferenceGraphStatus.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)

Expand Down
6 changes: 3 additions & 3 deletions python/kserve/docs/V1alpha1InferenceGraphList.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ InferenceGraphList contains a list of InferenceGraph
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
**items** | [**list[V1alpha1InferenceGraph]**](V1alpha1InferenceGraph.md) | |
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ListMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ListMeta.md) | | [optional]
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
**metadata** | [**V1ListMeta**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ListMeta.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)

Expand Down
4 changes: 2 additions & 2 deletions python/kserve/docs/V1alpha1InferenceGraphSpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ InferenceGraphSpec defines the InferenceGraph spec
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**affinity** | [**V1Affinity**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Affinity.md) | | [optional]
**affinity** | [**V1Affinity**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Affinity.md) | | [optional]
**nodes** | [**dict(str, V1alpha1InferenceRouter)**](V1alpha1InferenceRouter.md) | Map of InferenceGraph router nodes Each node defines the router which can be different routing types |
**resources** | [**V1ResourceRequirements**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ResourceRequirements.md) | | [optional]
**resources** | [**V1ResourceRequirements**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ResourceRequirements.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)

Expand Down
8 changes: 4 additions & 4 deletions python/kserve/docs/V1alpha1InferenceGraphStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ InferenceGraphStatus defines the InferenceGraph conditions and status
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**annotations** | **dict(str, str)** | Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards. | [optional]
**conditions** | [**list[KnativeCondition]**](KnativeCondition.md) | Conditions the latest available observations of a resource&#39;s current state. | [optional]
**observed_generation** | **int** | ObservedGeneration is the &#39;Generation&#39; of the Service that was last processed by the controller. | [optional]
**url** | [**KnativeURL**](KnativeURL.md) | | [optional]
**annotations** | **dict(str, str)** | Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards. | [optional]
**conditions** | [**list[KnativeCondition]**](KnativeCondition.md) | Conditions the latest available observations of a resource&#39;s current state. | [optional]
**observed_generation** | **int** | ObservedGeneration is the &#39;Generation&#39; of the Service that was last processed by the controller. | [optional]
**url** | [**KnativeURL**](KnativeURL.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)

Expand Down
Loading

0 comments on commit d7bfd22

Please sign in to comment.