Browse Source

Update README.md

Jay Clifford 1 year ago
parent
commit
b7316fb103
1 changed files with 12 additions and 0 deletions
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -25,6 +25,18 @@ docker run -p 8000:3000 -e MILVUS_URL={milvus server IP}:19530 zilliz/attu:v2.3.
 
 
 Make sure that the Attu container can access the Milvus IP address. After starting the container, open your web browser and enter `http://{ Attu IP }:8000` to view the Attu GUI.
 Make sure that the Attu container can access the Milvus IP address. After starting the container, open your web browser and enter `http://{ Attu IP }:8000` to view the Attu GUI.
 
 
+### Running Attu within Kubernetes
+
+Before you begin, make sure that you have Milvus installed and running within your [K8's Cluster](https://milvus.io/docs/install_cluster-milvusoperator.md). Note that Attu only supports Milvus 2.x.
+
+Here are the steps to start a container for running Attu:
+
+```code
+kubectl apply -f https://raw.githubusercontent.com/zilliztech/attu/main/attu-k8s-deploy.yaml
+```
+
+Make sure that the Attu pod can access the Milvus service. After starting the container. In the example provided this connects directly to `my-release-milvus:19530`. Change this based on the Milvus service name. A more flexible way to achieve this would be to introduce a `ConfigMap`. See this [example]("https://raw.githubusercontent.com/zilliztech/attu/main/examples/attu-k8s-deploy-ConfigMap.yaml") for details.
+
 #### Parameters for Docker CLI
 #### Parameters for Docker CLI
 
 
 | Parameter  | Example           | Required | Description                 |
 | Parameter  | Example           | Required | Description                 |