Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: include namespace-scope info #306

Merged
merged 1 commit into from
Jan 18, 2023
Merged

doc: include namespace-scope info #306

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/install/install-script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ usage: ./scripts/install.sh [flags]

Flags:
-n, --namespace (required) Kubernetes namespace to deploy ModelMesh Serving to.
-p, --install-config-path Path to local model serve installation configs. Can be ModelMesh Serving tarfile or directory.
-p, --install-config-path Path to installation configs. Can be a local ModelMesh Serving config tarfile/directory or a URL to a config tarfile.
-d, --delete Delete any existing instances of ModelMesh Serving in Kube namespace before running install, including CRDs, RBACs, controller, older CRD with serving.kserve.io api group name, etc.
-u, --user-namespaces Kubernetes namespaces to enable for ModelMesh Serving
--quickstart Install and configure required supporting datastores in the same namespace (etcd and MinIO) - for experimentation/development
Expand All @@ -80,7 +80,7 @@ Installs ModelMesh Serving CRDs, controller, and built-in runtimes into specifie
Kubernetes namespaces.

Expects cluster-admin authority and Kube cluster access to be configured prior to running.
Also requires Etcd secret 'model-serving-etcd' to be created in namespace already.
Also requires etcd secret 'model-serving-etcd' to be created in namespace already.
```

You can optionally provide a local `--install-config-path` that points to a local ModelMesh Serving tar file or directory containing ModelMesh Serving configs to deploy. If not specified, the `config` directory from the root of the project will be used.
Expand All @@ -89,6 +89,8 @@ You can also optionally use `--delete` to delete any existing instances of Model

The installation will create a secret named `storage-config` if it does not already exist. If the `--quickstart` option was chosen, this will be populated with the connection details for the example models bucket in IBM Cloud Object Storage and the local MinIO; otherwise, it will be empty and ready for you to add your own entries.

The `--namespace-scope-mode` will deploy `ServingRuntime`s confined to the same namespace, instead of the default cluster-scoped runtimes `ClusterServingRuntime`s. These serving runtimes are accessible to any user/namespace in the cluster.

## Setup additional namespaces

To enable additional namespaces for ModelMesh after the initial installation, you need to add a label named `modelmesh-enabled`, and optionally setup the storage secret `storage-config` and built-in runtimes, in the user namespaces.
Expand Down