Skip to content

Commit b224b65

Browse files
authored
Update top level README (#424)
Update and clean up README Signed-off-by: Lianhao Lu <[email protected]>
1 parent ee907d6 commit b224b65

File tree

1 file changed

+3
-32
lines changed

1 file changed

+3
-32
lines changed

README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ The GenAIInfra repository is organized under four main directories, which includ
88

99
| Directory | Purpose |
1010
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
| `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. |
11+
| `authN-authZ` | Authentication and Authorization scenarios for OPEA. |
1212
| `helm-charts` | Helm charts for deploying [GenAIComponents](https://github.com/opea-project/GenAIComps) on Kubernetes. |
13+
| `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. |
1314
| `kubernetes-addons` | Deploy Kubernetes add-ons for OPEA. |
14-
| `manifests` | Manifests for deploying [GenAIComponents](https://github.com/opea-project/GenAIComps) on Kubernetes and on Docker Compose. |
15+
| `proxy` | OPEA Pipeline Proxy is an enhancement of the default Istio proxy with additional features designed specifically for OPEA RAG pipelines. |
1516
| `scripts` | Scripts for testing, tools to facilitate OPEA deployment, and etc. |
1617

1718
## Prerequisite
@@ -56,36 +57,6 @@ To deploy GenAIExamples to Kubernetes using helm charts, you need [Helm](https:/
5657

5758
For a detailed version, see [Deploy GenAIExample/GenAIComps using helm charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts)
5859

59-
Clone the GenAIInfra repository and change into the `helm-charts` directory:
60-
61-
```shell
62-
git clone https://github.com/opea-project/GenAIInfra.git
63-
cd GenAIInfra/helm-charts
64-
```
65-
66-
Select the example workflow you want to deploy, set the customized values in `values.yaml` and deploy the example (e.g. codegen) using `helm`:
67-
68-
```shell
69-
helm install codegen ./codegen
70-
```
71-
72-
### Use manifests to deploy
73-
74-
GenAIInfra also supports deploy GenAIExamples using manifests, you need [kubectl](https://kubernetes.io/docs/tasks/tools) installed on your machine.
75-
76-
Clone the GenAIInfra repository and change into the `manifests` directory:
77-
78-
```shell
79-
git clone https://github.com/opea-project/GenAIInfra.git
80-
cd GenAIInfra/manifests
81-
```
82-
83-
Select the example workflow you want to deploy, deploy the example (e.g. DocSum) using `kubectl`:
84-
85-
```shell
86-
kubectl apply -f ./DocSum/manifests/
87-
```
88-
8960
## Additional Content
9061

9162
- [Code of Conduct](https://github.com/opea-project/docs/tree/main/community/CODE_OF_CONDUCT.md)

0 commit comments

Comments
 (0)