Skip to content

Commit c99e0ee

Browse files
authored
docs: changed every instance of default_bucket to bucket (#507)
#### Motivation Replacing default_bucket -> bucket everywhere in this repo to ensure it's consistent with KServe. #### Modifications replaced every instance of `default_bucket` to `bucket` #### Result Tested the [quickstart install](https://github.com/kserve/modelmesh-serving/blob/main/docs/quickstart.md) after modifying [quickstart.yaml](https://github.com/kserve/modelmesh-serving/blob/6c86da9473d50de63f9ea3af8a4d7c223849547e/config/dependencies/quickstart.yaml#L127) pods up and running - ``` kubectl get pods NAME READY STATUS RESTARTS AGE etcd-6fdc487479-m9pkx 1/1 Running 0 32m minio-6b5c846587-8bwdv 1/1 Running 0 32m modelmesh-controller-5cd8d68bc-9ls9p 1/1 Running 0 31m modelmesh-serving-mlserver-1.x-66bb94dcf6-hvgzj 4/4 Running 0 26m modelmesh-serving-mlserver-1.x-66bb94dcf6-qtdzw 4/4 Running 0 26m ``` Model deployed and InferenceService is Ready - ``` kubectl get isvc NAME URL READY PREV LATEST PREVROLLEDOUTREVISION LATESTREADYREVISION AGE example-sklearn-isvc grpc://modelmesh-serving.modelmesh-serving:8033 True ``` ``` kubectl describe isvc example-sklearn-isvc Name: example-sklearn-isvc Namespace: modelmesh-serving Labels: <none> Annotations: serving.kserve.io/deploymentMode: ModelMesh API Version: serving.kserve.io/v1beta1 Kind: InferenceService Metadata: Creation Timestamp: 2024-05-28T07:19:00Z Generation: 1 Resource Version: 5950 UID: db71cf11-7842-4bc1-af97-647282e6b9b9 Spec: Predictor: Model: Model Format: Name: sklearn Storage: Key: localMinIO Path: sklearn/mnist-svm.joblib Status: Components: Predictor: Grpc URL: grpc://modelmesh-serving.modelmesh-serving:8033 Rest URL: http://modelmesh-serving.modelmesh-serving:8008 URL: grpc://modelmesh-serving.modelmesh-serving:8033 Conditions: Last Transition Time: 2024-05-28T07:25:07Z Status: True Type: PredictorReady Last Transition Time: 2024-05-28T07:25:07Z Status: True Type: Ready Model Status: Copies: Failed Copies: 0 Total Copies: 1 States: Active Model State: Loaded Target Model State: Transition Status: UpToDate URL: grpc://modelmesh-serving.modelmesh-serving:8033 Events: <none> ``` Inference Request successful - ``` MODEL_NAME=example-sklearn-isvc grpcurl \ -plaintext \ -proto fvt/proto/kfs_inference_v2.proto \ -d '{ "model_name": "'"${MODEL_NAME}"'", "inputs": [{ "name": "predict", "shape": [1, 64], "datatype": "FP32", "contents": { "fp32_contents": [0.0, 0.0, 1.0, 11.0, 14.0, 15.0, 3.0, 0.0, 0.0, 1.0, 13.0, 16.0, 12.0, 16.0, 8.0, 0.0, 0.0, 8.0, 16.0, 4.0, 6.0, 16.0, 5.0, 0.0, 0.0, 5.0, 15.0, 11.0, 13.0, 14.0, 0.0, 0.0, 0.0, 0.0, 2.0, 12.0, 16.0, 13.0, 0.0, 0.0, 0.0, 0.0, 0.0, 13.0, 16.0, 16.0, 6.0, 0.0, 0.0, 0.0, 0.0, 16.0, 16.0, 16.0, 7.0, 0.0, 0.0, 0.0, 0.0, 11.0, 13.0, 12.0, 1.0, 0.0] }}]}' \ localhost:8033 \ inference.GRPCInferenceService.ModelInfer Handling connection for 8033 { "modelName": "example-sklearn-isvc__isvc-6b2eb0b8bf", "outputs": [ { "name": "predict", "datatype": "INT64", "shape": [ "1", "1" ], "contents": { "int64Contents": [ "8" ] } } ] } ``` This issue closes #456 --------- Signed-off-by: Aayush Subramaniam <[email protected]>
1 parent 31ebe73 commit c99e0ee

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

config/default/storage-secret.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ metadata:
2727
# "secret_access_key": "abcdff6a11223344aabbcc66ee231e6dd0c1122ff1234567",
2828
# "endpoint_url": "https://s3.us-south.cloud-object-storage.appdomain.cloud",
2929
# "region": "us-south",
30-
# "default_bucket": "modelmesh-example-public"
30+
# "bucket": "modelmesh-example-public"
3131
# }

config/dependencies/fvt.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ stringData:
122122
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
123123
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
124124
"endpoint_url": "http://minio:9000",
125-
"default_bucket": "modelmesh-example-models",
125+
"bucket": "modelmesh-example-models",
126126
"region": "us-south"
127127
}
128128
---

config/dependencies/minio-storage-secret.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ stringData:
2222
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
2323
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
2424
"endpoint_url": "http://minio.controller_namespace:9000",
25-
"default_bucket": "modelmesh-example-models",
25+
"bucket": "modelmesh-example-models",
2626
"region": "us-south"
2727
}

config/dependencies/quickstart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,6 @@ stringData:
124124
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
125125
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
126126
"endpoint_url": "http://minio:9000",
127-
"default_bucket": "modelmesh-example-models",
127+
"bucket": "modelmesh-example-models",
128128
"region": "us-south"
129129
}

docs/predictors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ There should be secret key called `localMinIO` that looks like:
2828
"access_key": "AKIAIOSFODNN7EXAMPLE",
2929
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
3030
"endpoint_url": "http://minio:9000",
31-
"default_bucket": "modelmesh-example-models"
31+
"bucket": "modelmesh-example-models"
3232
}
3333
```
3434

docs/predictors/setup-storage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ $ mc ls myminio/models/onnx
6060

6161
### 3. Add a storage entry to the `storage-config` secret
6262

63-
Ensure there is a key defined in the common `storage-config` secret corresponding to the S3-based storage instance holding your model. The value of this secret key should be JSON like the following, `default_bucket` is optional.
63+
Ensure there is a key defined in the common `storage-config` secret corresponding to the S3-based storage instance holding your model. The value of this secret key should be JSON like the following, `bucket` is optional.
6464

6565
Users can specify use of a custom certificate via the storage config `certificate` parameter. The custom certificate should be in the form of an embedded Certificate Authority (CA) bundle in PEM format.
6666

@@ -72,7 +72,7 @@ Using MinIO the JSON contents look like:
7272
"access_key_id": "minioadmin",
7373
"secret_access_key": "minioadmin/K7JTCMP/EXAMPLEKEY",
7474
"endpoint_url": "http://127.0.0.1:9000:9000",
75-
"default_bucket": "",
75+
"bucket": "",
7676
"region": "us-east"
7777
}
7878
```
@@ -207,7 +207,7 @@ stringData:
207207
# "access_key_id": "AKIAIOSFODNN7EXAMPLE",
208208
# "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
209209
# "endpoint_url": "http://minio:9000",
210-
# "default_bucket": "modelmesh-example-models",
210+
# "bucket": "modelmesh-example-models",
211211
# "region": "us-south"
212212
# }
213213
pvc1: |

fvt/globals.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ var StorageConfigDataMinio = map[string]interface{}{
4646
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
4747
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
4848
"endpoint_url": "http://minio:9000",
49-
"default_bucket": "modelmesh-example-models",
49+
"bucket": "modelmesh-example-models",
5050
"region": "us-south",
5151
},
5252
}

0 commit comments

Comments
 (0)