Working docker-compose example (#167)

* Working docker-compose example

* add persistence examples and update docker compose file

Author: Iamdavidonuh

README.md

@@ -103,21 +103,28 @@ You can pull the prebuilt Docker images for Ahnlich:
 
 #### Example Docker Compose  
 
-Below is an example `docker-compose.yaml` configuration to run both `ahnlich-db` and `ahnlich-ai`:  
+Below is an example `docker-compose.yaml` configuration to run both `ahnlich-db` and `ahnlich-ai` with tracing:  
 
 ```yaml   
-services:  
-  ahnlich_db:  
-    image: ghcr.io/deven96/ahnlich-db:latest  
-    command: "ahnlich-db run --host 0.0.0.0 --enable-tracing --otel-endpoint http://jaeger:4317'"
-    ports:  
-      - "1369:1369"  
-
-  ahnlich_ai:  
-    image: ghcr.io/deven96/ahnlich-ai:latest  
-    command: "ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 -supported-models all-minilm-l6-v2,resnet-50 --enable-tracing ---otel-endpoint http://jaeger:4317'"
-    ports:  
-      - "1370:1370"  
+services:
+  ahnlich_db:
+    image: ghcr.io/deven96/ahnlich-db:latest
+    command: >
+      "ahnlich-db run --host 0.0.0.0 \
+      --enable-tracing \
+      --otel-endpoint http://jaeger:4317"
+    ports:
+      - "1369:1369"
+
+  ahnlich_ai:
+    image: ghcr.io/deven96/ahnlich-ai:latest
+    command: >
+      "ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 \
+      --supported-models all-minilm-l6-v2,resnet-50 \
+      --enable-tracing \
+      --otel-endpoint http://jaeger:4317"
+    ports:
+      - "1370:1370"
 
   # optional jaeger service whenever --enable-tracing and
   # --otel-endpoint is used
@@ -132,6 +139,37 @@ services:
       - "4318:4318" # otlp http
 ```
 
+Below is an example `docker-compose.yaml` configuration with persistence:
+
+```yaml
+
+services:
+  ahnlich_db:
+    image: ghcr.io/deven96/ahnlich-db:latest
+    command: >
+      "ahnlich-db run --host 0.0.0.0 \
+      --enable-persistence --persist-location /root/.ahnlich/data/db.dat \
+      --persistence-interval 300"
+    ports:
+      - "1369:1369"
+    volumes:
+      - "./data/:/root/.ahnlich/data" # Persistence Location
+
+  ahnlich_ai:
+    image: ghcr.io/deven96/ahnlich-ai:latest
+    command: >
+      "ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 \
+      --supported-models all-minilm-l6-v2,resnet-50 \
+      --enable-persistence --persist-location /root/.ahnlich/data/ai.dat \
+      --persistence-interval 300"
+    ports:
+      - "1370:1370"
+    volumes:
+      - "./ahnlich_ai_model_cache:/root/.ahnlich/models" # Model cache storage
+      - "./data/:/root/.ahnlich/data" # Persistence Location
+
+```
+
 ### Contributing
 
 View [contribution guide](CONTRIBUTING.md)

docker-compose.yml

@@ -11,39 +11,29 @@ services:
     environment:
       - LOG_LEVEL=debug
       - COLLECTOR_OTLP_ENABLED=true
-    networks:
-      - jaeger-example
 
   ahnlich_db:
-    build:
-      context: ./ahnlich/
-      args:
-        - AHNLICH_BIN=ahnlich-db
-    depends_on:
-      jaeger:
-        condition: service_started
-    command: "'ahnlich-db run --host 0.0.0.0 --enable-tracing --otel-endpoint http://jaeger:4317'"
-    networks:
-      - jaeger-example
+    image: ghcr.io/deven96/ahnlich-db:latest
+    command: >
+      "ahnlich-db run --host 0.0.0.0 \
+      --enable-persistence --persist-location /root/.ahnlich/data/db.dat \
+      --persistence-interval 30000 --enable-tracing \
+      --otel-endpoint http://jaeger:4317"
     ports:
-      - 1369:1369
+      - "1369:1369"
+    volumes:
+      - "./data/:/root/.ahnlich/data" # Persistence Location
 
   ahnlich_ai:
-    build:
-      context: ./ahnlich/
-      args:
-        - AHNLICH_BIN=ahnlich-ai
-    depends_on:
-      jaeger:
-        condition: service_started
-      ahnlich_db:
-        condition: service_started
-    command: "'ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 --port 8880 --enable-tracing --otel-endpoint http://jaeger:4317 --supported-models all-minilm-l6-v2,resnet-50'"
-
-    networks:
-      - jaeger-example
+    image: ghcr.io/deven96/ahnlich-ai:latest
+    command: >
+      "ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 \
+      --supported-models all-minilm-l6-v2,resnet-50 \
+      --enable-persistence --persist-location /root/.ahnlich/data/ai.dat \
+      --persistence-interval 30000 \
+      --enable-tracing --otel-endpoint http://jaeger:4317"
     ports:
-      - 1370:1370
-
-networks:
-  jaeger-example:
+      - "1370:1370"
+    volumes:
+      - "./ahnlich_ai_model_cache:/root/.ahnlich/models" # Model cache storage
+      - "./data/:/root/.ahnlich/data" # Persistence Location

web/ahnlich-web/src/app/page.tsx

@@ -8,18 +8,21 @@ export default function Home() {
   const wget = `wget https://github.com/deven96/ahnlich/releases/download/bin%2Fdb%2F0.0.0/aarch64-darwin-ahnlich-db.tar.gz`;
 
   const dockerCompose = `
-    services:  
-      ahnlich_db:  
-        image: ghcr.io/deven96/ahnlich-db:latest  
-        command: "'ahnlich-db run --host 0.0.0.0'"  
-        ports:  
-          - "1369:1369"  
-
-      ahnlich_ai:  
-        image: ghcr.io/deven96/ahnlich-ai:latest  
-        command: "'ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 --supported-models all-minilm-l6-v2,resnet-50'"  
-        ports:  
-          - "1370:1370"  
+    services:
+      ahnlich_db: 
+        image: ghcr.io/deven96/ahnlich-db:latest
+        command: >
+          "ahnlich-db run --host 0.0.0.0"
+        ports:
+          - "1369:1369"
+
+      ahnlich_ai:
+        image: ghcr.io/deven96/ahnlich-ai:latest
+        command: >
+          "ahnlich-ai run --db-host ahnlich_db --host 0.0.0.0 \
+          --supported-models all-minilm-l6-v2,resnet-50"
+        ports:
+          - "1370:1370"
   `
 
   return (
@@ -48,7 +51,7 @@ export default function Home() {
               </li>
             </ul>
             <p>
-              <code className="native-code">ahnlich-db</code>, <code className="native-code">ahnlich-ai</code> and <code className="native-code">ahnlich-cli</code> 
+              <code className="native-code">ahnlich-db</code>, <code className="native-code">ahnlich-ai</code> and <code className="native-code">ahnlich-cli</code>
               are packaged and released as <a href="https://github.com/deven96/ahnlich/releases" className="mr-1">binaries</a>
               for multiple platforms alongside <a href="https://github.com/deven96?tab=packages&repo_name=ahnlich">docker images</a>. <br />
               The DB can be used without the AI proxy for more fine grained control of the generated vector embeddings as all clients support both.