Skip to content

Issue open-horizon#4444 - MMSinCluster: Update doc with MMS service i… #4445

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

Merged
LiilyZhang merged 1 commit into from
Dec 4, 2025
Merged

Issue open-horizon#4444 - MMSinCluster: Update doc with MMS service i… #4445

Show file tree
Hide file tree
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
9 changes: 7 additions & 2 deletions docs/deployment_string.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Because {{site.data.keyword.edge_notm}} uses operators to deploy the application

- `operatorYamlArchive`: The content of the operator yaml archive files. These files are compressed (tarred and gzipped). And then the compressed content is converted to a base64 string.
- `metadata`: A list of key-value paries. It is for internal use only. Do not put it in the `clusterDeployment` when publishing a service.
- `mmsPVC`: `"mmsPVC": {"enable": true, "pvcSize": 20}` - enable persistent volume claim for the service to receive models deployed using the Model Management System (MMS) with the desired size in GB. Default size is 10GB

## Deployment String Examples
{: #deployment-examples}
Expand Down Expand Up @@ -122,14 +123,18 @@ A `clusterDeployment` string JSON would look like this when defining a service u

```json
"clusterDeployment": {
"operatorYamlArchive": "/filepath/k8s_operator_deployment_files.tar.gz"
"operatorYamlArchive": "/filepath/k8s_operator_deployment_files.tar.gz",
"mmsPVC": {
"enable": true,
"pvcSize": 20
}
}
```
{: codeblock}

When the content is encoded and stringified, the above would look like:

```json
"clusterDeployment": "{\"operatorYamlArchive\":\"H4sIAEu8lF4AA+1aX2/bNhDPcz4FkT4EGGZZsmxn0JuXZluxtjGcoHsMaIm2uVKiRlLO0mHffUfqjyVXkZLNcTCUvxeLR/J4vDse7yQ7w4ikjD8MT14OLuBi4ppfwP6vefb86Xji+ZOL6fjE9byRNz1BkxeUqUImFRYInQjOVde4vv7..."
"clusterDeployment": "{\"operatorYamlArchive\":\"H4sIAEu8lF4AA+1aX2/bNhDPcz4FkT4EGGZZsmxn0JuXZluxtjGcoHsMaIm2uVKiRlLO0mHffUfqjyVXkZLNcTCUvxeLR/J4vDse7yQ7w4ikjD8MT14OLuBi4ppfwP6vefb86Xji+ZOL6fjE9byRNz1BkxeUqUImFRYInQjOVde4vv7...\",\"mmsPVC\":{\"enable\":true,\"pvcSize\":20}}"
```
{: codeblock}
8 changes: 8 additions & 0 deletions docs/service_def.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,11 @@ The differences are noted below.
- `deploymentSignature`: The digital signature of the deployment field, created using an RSA key pair provided to `hzn exchange service publish`. It is a best practice to ALWAYS use the `-K` option when publishing a service, to ensure that the public key used to verify this signature is available for the agent to verify the signature.
- `clusterDeployment`: The Kubernetes Operator yaml for this service. See [deployment structure](./deployment_string.md) for more information on this field. In `display` form, this field is shown as stringified bytes and truncated. This field MAY be omitted if `deployment` is provided. The yaml files of a published service can be retrieved from the exchange using `hzn exchange service list -f <downloaded-yaml-file>`.
- `clusterDeploymentSignature`: The digital signature of the clusterDeployment field, created using an RSA key pair provided to `hzn exchange service publish`. It is a best practice to ALWAYS use the `-K` option when publishing a service, to ensure that the public key used to verify this signature is available for the agent to verify the signature.

## Service using MMS in edge cluster

The following three user inputs are only for a service using MMS deployed to the edge cluster:

- `MMS_K8S_STORAGE_CLASS`: to indicate the Kubernete storage class of the PVC for the service. If not specified the service will use the same storage class as cluster agent.
- `MMS_K8S_STORAGE_SIZE`: to indicate the size of PVC in GB. This user input value will overwrite the value specified in the `clusterDeployment` in the service definition.
- `MMS_K8S_PVC_ACCESS_MODE`: to indicate the PVC access mode. The values are: `ReadWriteOnce` or `ReadWriteMany`. If not specified in the user input, the service will use the same PVC access mode as cluster agent.
Loading