Skip to content

Commit

Permalink
Update docs for 0.11 release (#284)
Browse files Browse the repository at this point in the history
Signed-off-by: Sivanantham Chinnaiyan <sivanantham.chinnaiyan@ideas2it.com>
  • Loading branch information
sivanantha321 authored Aug 29, 2023
1 parent e1bde52 commit 0f34ac5
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 33 deletions.
14 changes: 7 additions & 7 deletions docs/admin/kubernetes_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Kubernetes 1.22 is the minimally required version and please check the following
Kubernetes version.

## Recommended Version Matrix
| Kubernetes Version | Recommended Istio Version |
| :---------- | :------------ |
| 1.25 | 1.15, 1.16 |
| 1.26 | 1.17 |
| 1.27 | 1.17, 1.18 |
| Kubernetes Version | Recommended Istio Version |
|:-------------------|:--------------------------|
| 1.25 | 1.15, 1.16 |
| 1.26 | 1.17 |
| 1.27 | 1.17, 1.18 |

## 1. Install Istio

Expand Down Expand Up @@ -46,14 +46,14 @@ The minimally required Cert Manager version is 1.9.0 and you can refer to [Cert

=== "kubectl"
```bash
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.10.0/kserve.yaml
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.11.0/kserve.yaml
```

Install KServe default serving runtimes:

=== "kubectl"
```bash
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.10.0/kserve-runtimes.yaml
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.11.0/kserve-runtimes.yaml
```

**ii. Change default deployment mode and ingress option**
Expand Down
6 changes: 3 additions & 3 deletions docs/admin/modelmesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ KServe ModelMesh installation enables high-scale, high-density and frequently-ch
A Kubernetes cluster is required. You will need cluster-admin authority. Additionally, [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) and an [etcd](https://etcd.io/) server on the Kubernetes cluster are required.

## 1. Standard Installation
You can find the standard installation instructions in the ModelMesh Serving [installation guide](https://github.com/kserve/modelmesh-serving/blob/release-0.10/docs/install/install-script.md). This approach assumes you have installed the prerequisites such as etcd and S3-compatible object storage.
You can find the standard installation instructions in the ModelMesh Serving [installation guide](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/install/install-script.md). This approach assumes you have installed the prerequisites such as etcd and S3-compatible object storage.

## 2. Quick Installation
A quick installation allows you to quickly get ModelMesh Serving up and running without having to manually install the prerequisites. The steps are described in the ModelMesh Serving [quick start guide](https://github.com/kserve/modelmesh-serving/blob/release-0.10/docs/quickstart.md).
A quick installation allows you to quickly get ModelMesh Serving up and running without having to manually install the prerequisites. The steps are described in the ModelMesh Serving [quick start guide](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md).

!!! note
ModelMesh Serving is namespace scoped, meaning all of its components must exist within a single namespace and only one instance of ModelMesh Serving can be installed per namespace. For more details, you can check out the ModelMesh Serving [getting started guide](https://github.com/kserve/modelmesh-serving/blob/release-0.10/docs/install/README.md).
ModelMesh Serving is namespace scoped, meaning all of its components must exist within a single namespace and only one instance of ModelMesh Serving can be installed per namespace. For more details, you can check out the ModelMesh Serving [getting started guide](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/install/README.md).
14 changes: 7 additions & 7 deletions docs/admin/serverless/serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Kubernetes 1.22 is the minimally required version and please check the following
Kubernetes version.

## Recommended Version Matrix
| Kubernetes Version | Recommended Istio Version | Recommended Knative Version |
| :---------- | :------------ | :------------|
| 1.25 | 1.15, 1.16 | 1.4-1.9 |
| 1.26 | 1.17 | 1.7-1.11 |
| 1.27 | 1.17,1.18 | 1.9-1.11 |
| Kubernetes Version | Recommended Istio Version | Recommended Knative Version |
|:-------------------|:--------------------------|:----------------------------|
| 1.25 | 1.15, 1.16 | 1.4-1.9 |
| 1.26 | 1.17 | 1.7-1.11 |
| 1.27 | 1.17,1.18 | 1.9-1.11 |

## 1. Install Knative Serving
Please refer to [Knative Serving install guide](https://knative.dev/docs/admin/install/serving/install-serving-with-yaml/).
Expand All @@ -35,14 +35,14 @@ The minimally required Cert Manager version is 1.9.0 and you can refer to [Cert
## 4. Install KServe
=== "kubectl"
```bash
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.10.0/kserve.yaml
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.11.0/kserve.yaml
```

## 5. Install KServe Built-in ClusterServingRuntimes

=== "kubectl"
```bash
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.10.0/kserve-runtimes.yaml
kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.11.0/kserve-runtimes.yaml
```

!!! note
Expand Down
8 changes: 4 additions & 4 deletions docs/developer/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Before submitting a PR, see also [CONTRIBUTING.md](https://github.com/kserve/kse

You must install these tools:

1. [`go`](https://golang.org/doc/install): KServe controller is written in Go and requires Go 1.18.0+.
1. [`go`](https://golang.org/doc/install): KServe controller is written in Go and requires Go 1.20.0+.
1. [`git`](https://help.github.com/articles/set-up-git/): For source control.
1. [`Go Module`](https://blog.golang.org/using-go-modules): Go's new dependency management system.
1. [`ko`](https://github.com/google/ko):
For development.
1. [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/): For
managing development environments.
1. [`kustomize`](https://github.com/kubernetes-sigs/kustomize/) To customize YAMLs for different environments, requires v3.5.4+.
1. [`kustomize`](https://github.com/kubernetes-sigs/kustomize/) To customize YAMLs for different environments, requires v5.0.0+.
1. [`yq`](https://github.com/mikefarah/yq) yq is used in the project makefiles to parse and display YAML output, requires yq `4.*`.

### Install Knative on a Kubernetes cluster
Expand All @@ -33,9 +33,9 @@ KServe currently requires `Knative Serving` for auto-scaling, canary rollout, `I
use the [Knative Operators](https://knative.dev/docs/install/operator/knative-with-operators/) to manage your installation. Observability, tracing and logging are optional but are often very valuable tools for troubleshooting difficult issues,
they can be installed via the [directions here](https://github.com/knative/docs/blob/release-0.15/docs/serving/installing-logging-metrics-traces.md).

* If you start from scratch, KServe requires Kubernetes 1.17+, Knative 0.19+, Istio 1.9+.
* If you start from scratch, KServe requires Kubernetes 1.25+, Knative 1.7+, Istio 1.15+.

* If you already have `Istio` or `Knative` (e.g. from a Kubeflow install) then you don't need to install them explictly, as long as version dependencies are satisfied.
* If you already have `Istio` or `Knative` (e.g. from a Kubeflow install) then you don't need to install them explicitly, as long as version dependencies are satisfied.

> **_NOTE:_** Note: On a local environment, when using `minikube` or `kind` as Kubernetes cluster, there has been a reported issue that [knative quickstart](https://knative.dev/docs/install/quickstart-install/) bootstrap does not work as expected. It is recommended to follow the installation manual from knative using [yaml](https://knative.dev/docs/install/yaml-install/) or using [knative operator](https://knative.dev/docs/install/operator/knative-with-operators/) for a better result.
Expand Down
2 changes: 1 addition & 1 deletion docs/modelserving/inference_graph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If you want to propagate a certain header, say "Custom-Header", then you can edi
config-map like this :
```json
{
"image" : "kserve/router:v0.10.0",
"image" : "kserve/router:v0.11.0",
"memoryRequest": "100Mi",
"memoryLimit": "1Gi",
"cpuRequest": "100m",
Expand Down
2 changes: 1 addition & 1 deletion docs/modelserving/v1beta1/custom/custom_model/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ if __name__ == "__main__":
```
The more details for ray fractional cpu and gpu can be found [here](https://docs.ray.io/en/latest/serve/scaling-and-resource-allocation.html#fractional-cpus-and-fractional-gpus).

The full code example can be found [here](https://github.com/kserve/kserve/blob/release-0.10/python/custom_model/model_remote.py).
The full code example can be found [here](https://github.com/kserve/kserve/blob/release-0.11/python/custom_model/model_remote.py).

Modify the `Procfile` to `web: python -m model_remote` and then run the above `pack` command, it builds the serving image which launches
each model as separate python worker and web server routes to the model workers by name.
Expand Down
Loading

0 comments on commit 0f34ac5

Please sign in to comment.