Skip to content

Commit b4193e9

Browse files
committed
Syncing from anax
1 parent 80bee99 commit b4193e9

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

docs/anax/docs/deployment_string.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Because {{site.data.keyword.edge_notm}} uses operators to deploy the application
7474

7575
- `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.
7676
- `metadata`: A list of key-value paries. It is for internal use only. Do not put it in the `clusterDeployment` when publishing a service.
77+
- `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
7778

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

123124
```json
124125
"clusterDeployment": {
125-
"operatorYamlArchive": "/filepath/k8s_operator_deployment_files.tar.gz"
126+
"operatorYamlArchive": "/filepath/k8s_operator_deployment_files.tar.gz",
127+
"mmsPVC": {
128+
"enable": true,
129+
"pvcSize": 20
130+
}
126131
}
127132
```
128133
{: codeblock}
129134

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

132137
```json
133-
"clusterDeployment": "{\"operatorYamlArchive\":\"H4sIAEu8lF4AA+1aX2/bNhDPcz4FkT4EGGZZsmxn0JuXZluxtjGcoHsMaIm2uVKiRlLO0mHffUfqjyVXkZLNcTCUvxeLR/J4vDse7yQ7w4ikjD8MT14OLuBi4ppfwP6vefb86Xji+ZOL6fjE9byRNz1BkxeUqUImFRYInQjOVde4vv7..."
138+
"clusterDeployment": "{\"operatorYamlArchive\":\"H4sIAEu8lF4AA+1aX2/bNhDPcz4FkT4EGGZZsmxn0JuXZluxtjGcoHsMaIm2uVKiRlLO0mHffUfqjyVXkZLNcTCUvxeLR/J4vDse7yQ7w4ikjD8MT14OLuBi4ppfwP6vefb86Xji+ZOL6fjE9byRNz1BkxeUqUImFRYInQjOVde4vv7...\",\"mmsPVC\":{\"enable\":true,\"pvcSize\":20}}"
134139
```
135140
{: codeblock}

docs/anax/docs/service_def.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,11 @@ The differences are noted below.
4949
- `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.
5050
- `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>`.
5151
- `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.
52+
53+
## Service using MMS in edge cluster
54+
55+
The following three user inputs are only for a service using MMS deployed to the edge cluster:
56+
57+
- `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.
58+
- `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.
59+
- `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.

0 commit comments

Comments
 (0)