You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update the GMC README based on current changes. (#396)
* update the GMC README based on current changes.
Signed-off-by: zhlsunshine <[email protected]>
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* change the doc based on comments.
Signed-off-by: zhlsunshine <[email protected]>
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: microservices-connector/README.md
+38-65Lines changed: 38 additions & 65 deletions
Original file line number
Diff line number
Diff line change
@@ -36,83 +36,64 @@ There are `2` components in this repo:
36
36
-1.`manager`: controller manager to handle GMC CRD
37
37
-2.`router`: route the traffic among the microservices defined in GMC
38
38
39
-
#### How to build these binaries?
39
+
### GMC build
40
+
41
+
#### Binaries building
40
42
41
43
```sh
42
44
make build
43
45
```
44
46
45
-
#### How to build docker images for these 2 components?
47
+
#### Docker images building
46
48
47
49
```sh
48
50
make docker.build
49
51
```
50
52
51
-
#### How to delete these components' binaries?
53
+
#### Binaries deleting
52
54
53
55
```sh
54
56
make clean
55
57
```
56
58
57
-
### To Deploy on the cluster
59
+
### GMC Deployment on K8s cluster
58
60
59
-
**Build and push your image to the location specified by `CTR_IMG`:**
61
+
**GMC Images NOTE:** This image ought to be published in [OPEA docker hub](https://hub.docker.com/u/opea), including [gmcmanager](https://hub.docker.com/r/opea/gmcmanager) and [gmcrouter](https://hub.docker.com/r/opea/gmcrouter). Make sure you have the proper permission to the registry and use the latest images.
60
62
61
-
```sh
62
-
make docker.build docker.push CTR_IMG=<some-registry>/gmcmanager:tag
63
-
```
63
+
There are 2 methods for deploying GMC on K8s cluster:
64
64
65
-
**NOTE:** This image ought to be published in the personal registry you specified.
66
-
And it is required to have access to pull the image from the working environment.
67
-
Make sure you have the proper permission to the registry if the above commands don’t work.
before apply the manifests, please replace your own huggingface tokens in the manifests
78
+
- Before installting the manifests, please replace your own huggingface tokens
79
+
-`MOUNT_DIR` is the `hostPath` to save the models on you cluster hosts, so please make sure it is ready on every node of the k8s nodes and the microservices have enough permission to access it.
80
+
- The `SYSTEM_NAMESPACE` should keep the same with the namespace defined in `gmc-manager.yaml` and `gmc-manager-rbac.yaml`
81
+
- The configmap name `gmcyaml` is defined in gmcmanager deployment Spec. Please modify accordingly if you want
0 commit comments