Skip to content

Commit

Permalink
add GMC into README (#177)
Browse files Browse the repository at this point in the history 
* add GMC into README

Signed-off-by: Iris Ding <[email protected]>

* add space

Signed-off-by: Iris Ding <[email protected]>

* add GMC into readme

Signed-off-by: Iris Ding <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Signed-off-by: Iris Ding <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
@irisdingbj @pre-commit-ci
irisdingbj and pre-commit-ci[bot] authored Jul 19, 2024
1 parent 88b3c10 commit b25c0bb
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ GenAIInfra is the containerization and cloud native suite for OPEA, including ar

The GenAIInfra repository is organized under four main directories, which include artifacts for OPEA deploying:

| Directory | Purpose |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `helm-charts` | Helm charts for deploying [GenAIExamples](https://github.com/opea-project/GenAIExamples) on Kubernetes. |
| `kubernetes-addons` | Deploy Kubernetes add-ons for OPEA. |
| `manifests` | Manifests for deploying [GenAIExamples](https://github.com/opea-project/GenAIExamples) on Kubernetes and on Docker Compose. |
| `scripts` | Scripts for testing, tools for facilitate OPEA deployment, and etc. |
| Directory | Purpose |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `microservices-connector` | GenAI Microservices Connector (GMC) supports the launching, monitoring, and updating of GenAI microservice chains, such as those in [GenAIExamples](https://github.com/opea-project/GenAIExamples) on Kubernetes. It essentially supports a Kubernetes Custom Resource Definition for GenAI chains/pipelines that may be comprised of sequential, conditional, and parallel steps. |
| `helm-charts` | Helm charts for deploying [GenAIComponents](https://github.com/opea-project/GenAIComps) on Kubernetes. |
| `kubernetes-addons` | Deploy Kubernetes add-ons for OPEA. |
| `manifests` | Manifests for deploying [GenAIComponents](https://github.com/opea-project/GenAIComps) on Kubernetes and on Docker Compose. |
| `scripts` | Scripts for testing, tools to facilitate OPEA deployment, and etc. |

## Prerequisite

Expand Down Expand Up @@ -41,6 +42,12 @@ NOTE: Please make sure you configure the appropriate container runtime based on

## Usages

### Use GenAI Microservices Connector (GMC) to deploy and adjust GenAIExamples

Follow [GMC README](https://github.com/opea-project/GenAIInfra/blob/main/microservices-connector/README.md)
to install GMC into your kubernetes cluster. [GenAIExamples](https://github.com/opea-project/GenAIExamples) contains several sample GenAI example use case pipelines such as ChatQnA, DocSum, etc.
Once you have deployed GMC in your Kubernetes cluster, you can deploy any of the example pipelines by following its Readme file (e.g. [Docsum](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/kubernetes/README.md)).

### Use helm charts to deploy

To deploy GenAIExamples to Kubernetes using helm charts, you need [Helm](https://helm.sh/docs/intro/install/) installed on your machine.
Expand Down

0 comments on commit b25c0bb

Please sign in to comment.