Jacques/docker compose docs

README.md

@@ -76,8 +76,8 @@ For more information about the different deployment options, please see our depl
 
 | Installation methods | Docs link |
 | ------------------- | --------- |
-| Local instance | [![All-in-one isntallation](https://img.shields.io/badge/All--in--one%20Installer-%230db7ed)](https://www.comet.com/docs/opik/self-host/self_hosting_opik/#all-in-one-installation?utm_source=opik&utm_medium=github&utm_content=self_host_link)
-| Kubernetes | [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?&logo=kubernetes&logoColor=white)](https://www.comet.com/docs/opik/self-host/self_hosting_opik/#kubernetes-installation?utm_source=opik&utm_medium=github&utm_content=kubernetes_link)
+| Local instance | [![Local Deployment](https://img.shields.io/badge/Local%20Deployments-%232496ED?style=flat&logo=docker&logoColor=white)](https://www.comet.com/docs/opik/self-host/local_deployment?utm_source=opik&utm_medium=github&utm_content=self_host_link)
+| Kubernetes | [![Kubernetes](https://img.shields.io/badge/Kubernetes-%23326ce5.svg?&logo=kubernetes&logoColor=white)](https://www.comet.com/docs/opik/self-host/kubernetes/#kubernetes-installation?utm_source=opik&utm_medium=github&utm_content=kubernetes_link)
 
 
 ## 🏁 Get Started

apps/opik-documentation/documentation/docs/cookbook/evaluate_hallucination_metric.ipynb

@@ -17,7 +17,7 @@
     "\n",
     "[Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.\n",
     "\n",
-    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information."
+    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information."
    ]
   },
   {

apps/opik-documentation/documentation/docs/cookbook/evaluate_hallucination_metric.md

@@ -6,7 +6,7 @@ For this guide we will be evaluating the Hallucination metric included in the LL
 
 [Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.
 
-> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information.
+> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information.
 
 
 ```python

apps/opik-documentation/documentation/docs/cookbook/evaluate_moderation_metric.ipynb

@@ -17,7 +17,7 @@
     "\n",
     "[Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.\n",
     "\n",
-    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information."
+    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information."
    ]
   },
   {

apps/opik-documentation/documentation/docs/cookbook/evaluate_moderation_metric.md

@@ -6,7 +6,7 @@ For this guide we will be evaluating the Moderation metric included in the LLM E
 
 [Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.
 
-> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information.
+> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information.
 
 
 ```python

apps/opik-documentation/documentation/docs/cookbook/langchain.ipynb

@@ -23,7 +23,7 @@
     "\n",
     "[Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.\n",
     "\n",
-    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information."
+    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information."
    ]
   },
   {

apps/opik-documentation/documentation/docs/cookbook/langchain.md

@@ -12,7 +12,7 @@ We will highlight three different parts of the workflow:
 
 [Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.
 
-> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information.
+> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information.
 
 
 ```python

apps/opik-documentation/documentation/docs/cookbook/llama-index.ipynb

@@ -25,7 +25,7 @@
     "\n",
     "[Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.\n",
     "\n",
-    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information."
+    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information."
    ]
   },
   {

apps/opik-documentation/documentation/docs/cookbook/llama-index.md

@@ -14,7 +14,7 @@ For this guide we will be downloading the essays from Paul Graham and use them a
 
 [Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.
 
-> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information.
+> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information.
 
 
 ```python

apps/opik-documentation/documentation/docs/cookbook/openai.ipynb

@@ -17,7 +17,7 @@
     "\n",
     "[Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.\n",
     "\n",
-    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information."
+    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information."
    ]
   },
   {

apps/opik-documentation/documentation/docs/cookbook/openai.md

@@ -7,7 +7,7 @@ Opik integrates with OpenAI to provide a simple way to log traces for all OpenAI
 
 [Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.
 
-> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information.
+> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information.
 
 
 ```python

apps/opik-documentation/documentation/docs/cookbook/ragas.ipynb

@@ -22,7 +22,7 @@
     "\n",
     "[Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.\n",
     "\n",
-    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information."
+    "> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information."
    ]
   },
   {

apps/opik-documentation/documentation/docs/cookbook/ragas.md

@@ -11,7 +11,7 @@ There are two main ways to use Opik with Ragas:
 
 [Comet](https://www.comet.com/site) provides a hosted version of the Opik platform, [simply create an account](https://www.comet.com/signup?from=llm) and grab you API Key.
 
-> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/self_hosting_opik/) for more information.
+> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/) for more information.
 
 
 ```python

apps/opik-documentation/documentation/docs/home.md

@@ -37,4 +37,4 @@ Evaluating the output of your LLM calls is critical to ensure that your applicat
 
 [Comet](https://www.comet.com/site) provides a managed Cloud offering for Opik, simply [create an account](https://www.comet.com/signup?from=llm) to get started.
 
-You can also run Opik locally using our [local installer](/self-host/self_hosting_opik.md#all-in-one-installation). If you are looking for a more production ready deployment, you can also use our [Kubernetes deployment option](/self-host/self_hosting_opik.md#kubernetes-installation).
+You can also run Opik locally using our [local installer](/self-host/local_deployment.md). If you are looking for a more production ready deployment, you can also use our [Kubernetes deployment option](/self-host/kubernetes.md).

apps/opik-documentation/documentation/docs/quickstart.md

@@ -9,7 +9,7 @@ This guide helps you integrate the Opik platform with your existing LLM applicat
 
 ## Set up
 
-Getting started is as simple as creating an [account on Comet](https://www.comet.com/signup?from=llm) or [self-hosting the platform](/self-host/self_hosting_opik.md).
+Getting started is as simple as creating an [account on Comet](https://www.comet.com/signup?from=llm) or [self-hosting the platform](/self-host/overview.md).
 
 Once your account is created, you can start logging traces by installing the Opik Python SDK:
 

apps/opik-documentation/documentation/docs/self-host/kubernetes.md

@@ -0,0 +1,52 @@
+---
+sidebar_position: 1
+sidebar_label: Production (Kubernetes)
+---
+
+# Production ready Kubernetes deployment
+
+For production deployments, we recommend using our Kubernetes Helm chart. This chart is designed to be highly configurable and has been battle-tested in Comet's managed cloud offering.
+
+
+## Prerequisites
+In order to install Opik on a Kubernetes cluster, you will need to have the following tools installed:
+
+- [Docker](https://www.docker.com/)
+- [Helm](https://helm.sh/)
+- [kubectl](https://kubernetes.io/docs/tasks/tools/)
+- [kubectx](https://github.com/ahmetb/kubectx) and [kubens](https://github.com/ahmetb/kubectx) to switch between Kubernetes clusters and namespaces.
+
+## Installation
+
+You will then be able to to install Opik using the helm chart defined in the `deployment/helm_chart/opik` directory of the [Opik repository](https://github.com/comet-ml/opik):
+
+```bash
+# Navigate to the directory
+cd deployment/helm_chart/opik
+
+# Define the version of the Opik server you want to install
+VERSION=latest
+
+# Add helm dependencies
+helm repo add bitnami https://charts.bitnami.com/bitnami
+helm dependency build
+
+# Install Opik
+helm upgrade --install opik -n llm --create-namespace -f values.yaml \
+    --set registry=docker.dev.comet.com/comet-ml \
+    --set component.backend.image.tag=$VERSION --set component.frontend.image.tag=$VERSION-os \
+    --set component.backend.env.ANALYTICS_DB_MIGRATIONS_PASS=opik --set component.backend.env.ANALYTICS_DB_PASS=opik \
+    --set component.backend.env.STATE_DB_PASS=opik .
+```
+
+To access the Opik UI, you will need to port-forward the frontend service:
+
+```bash
+kubectl port-forward -n llm svc/opik-frontend 5173
+```
+
+You can now open the Opik UI at `http://localhost:5173/llm`.
+
+## Configuration
+
+You can find a full list the configuration options in the [helm chart documentation](https://github.com/comet-ml/opik/tree/main/deployment/helm_chart/opik).

apps/opik-documentation/documentation/docs/self-host/local_deployment.md

@@ -0,0 +1,112 @@
+---
+sidebar_position: 1
+sidebar_label: Local (Docker Compose)
+---
+
+# Local Deployments using Docker Compose
+
+To run Opik locally we recommend using [Docker Compose](https://docs.docker.com/compose/). It's easy to setup and allows you to get started in a couple of minutes **but** is not meant for production deployments. If you would like to run Opik in a production environment, we recommend using our [Kubernetes Helm chart](./kubernetes.md).
+
+Before running the installation, make sure you have Docker and Docker Compose installed:
+
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+:::note
+If you are using Mac or Windows, both `docker` and `docker compose` are included in the [Docker Desktop](https://docs.docker.com/desktop/) installation.
+:::
+
+## Installation
+
+To install Opik, you will need to clone the Opik repository and run the `docker-compose.yaml` file:
+
+```bash
+# Clone the Opik repository
+git clone https://github.com/comet-ml/opik.git
+
+# Navigate to the opik/deployment/docker-compose directory
+cd opik/deployment/docker-compose
+
+# Start the Opik platform
+docker compose up --detach
+```
+
+Opik will now be available at `http://localhost:5173`.
+
+:::tip
+You will need to make sure that the Opik Python SDK is configured to point to the Opik server you just started. For this, make sure you set the environment variable `OPIK_BASE_URL` to the URL of the Opik server:
+
+```bash
+export OPIK_BASE_URL=http://localhost:5173/api
+```
+
+or in python:
+
+```python
+import os
+
+os.environ["OPIK_BASE_URL"] = "http://localhost:5173/api"
+```
+:::
+
+All the data logged to the Opik platform will be stored in the `~/opik` directory, which means that you can start and stop the Opik platform without losing any data.
+
+## Starting, stopping and upgrading Opik
+
+:::note
+All the `docker compose` commands should be run from the `opik/deployment/docker-compose` directory.
+:::
+
+The `docker compose up` command can be used to install, start and upgrade Opik:
+
+```bash
+# Start, upgrade or restart the Opik platform
+docker compose up --detach
+```
+
+To stop Opik, you can run:
+
+```bash
+# Stop the Opik platform
+docker compose down
+```
+
+## Removing Opik
+
+To remove Opik, you will need to remove the Opik containers and volumes:
+
+```bash
+# Remove the Opik containers and volumes
+docker compose down --volumes
+```
+
+:::warning
+Removing the volumes will delete all the data stored in the Opik platform and cannot be recovered. We do not recommend this option unless you are sure that you will not need any of the data stored in the Opik platform.
+:::
+
+## Advanced configuration
+
+### Running a specific version of Opik
+
+You can run a specific version of Opik by setting the `OPIK_VERSION` environment variable:
+
+```bash
+OPIK_VERSION=latest docker compose up
+```
+
+### Building the Opik platform from source
+
+You can also build the Opik platform from source by running the following command:
+
+```bash
+# Clone the Opik repository
+git clone https://github.com/comet-ml/opik.git
+
+# Navigate to the opik directory
+cd opik
+
+# Build the Opik platform from source
+docker compose up --build
+```
+
+This will build the Frontend and Backend Docker images and start the Opik platform.

apps/opik-documentation/documentation/docs/self-host/overview.md

@@ -0,0 +1,53 @@
+---
+sidebar_position: 1
+sidebar_label: Overview
+---
+
+# Self-hosting Opik
+
+You can use Opik through [Comet's Managed Cloud offering](https://comet.com/site) or you can self-host Opik on your own infrastructure. When choosing to self-host Opik, you get access to all Opik features including tracing, evaluation, etc but without user management features.
+
+If you choose to self-host Opik, you can choose between two deployment options:
+
+1. [Local installation](./local_deployment.md): Perfect to get started but not production-ready.
+2. [Kubernetes installation](./kubernetes.md): Production ready Opik platform that runs on a Kubernetes cluster.
+
+## Getting started
+
+If you would like to try out Opik locally, we recommend using our Local installation based on `docker compose`. Assuming you have `git` and `docker` installed, you can get started in a couple of minutes:
+
+```bash
+# Clone the Opik repository
+git clone https://github.com/comet-ml/opik.git
+
+# Run the Opik platform
+cd opik/deployment/docker-compose
+docker compose up --detach
+
+```
+```
+
+Opik will now be available at `http://localhost:5173` and all traces logged from your local machine will be logged to this local Opik instance. In order for traces and other data to be logged to your Opik instance, you need to make sure that the Opik Python SDK is configured to point to the Opik server you just started. You can do this by running the following command:
+
+```bash
+# Configure the Python SDK to point to the local Opik platform
+export OPIK_BASE_URL=http://localhost:5173/api
+```
+
+or in Python:
+
+```python
+import os
+
+os.environ["OPIK_BASE_URL"] = "http://localhost:5173/api"
+```
+
+To learn more about how to manage you local Opik deployment, you can refer to our [local deployment guide](./local_deployment.md).
+
+## Advanced deployment options
+
+If you would like to deploy Opik on a Kubernetes cluster, we recommend following our Kubernetes deployment guide [here](./kubernetes.md).
+
+## Comet managed deployments
+
+The Opik platform is being developed and maintained by the Comet team. If you are looking for a managed deployment solution, feel free to reach out to the Comet team at [email protected] or visit the [Comet website](https://comet.com/site) to learn more.