Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guidelines for local run #983

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add guidelines for local run #983

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71d0069
Add guidelines for local run
liyaka Jan 5, 2025
345b1ad
update readme
liyaka Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions deployment/docker-compose/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,31 @@ This will expose the following services to the host machine
- Backend: Available on ports 8080 and 3003


## Run Opik backend locally and the rest of the components with docker-compose
1. In `nginx_default_local.conf` replace
```bash
http://backend:8080
```
with your localhost

For Mac/Windows (Docker Desktop)
```bash
http://host.docker.internal:8080
```
For Linux
```bash
http://172.17.0.1:8080
```

2. Run docker-compose including exposing ports to localhost
```bash
docker compose -f docker-compose.yaml -f docker-compose.override.yaml up -d
```
Stop backend container, cause you don't need it..
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why stop the backend? cant we just disable it in docker compose override?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these instructions were without code changes (at least for now)
If you run docker-compose with the list of the components without the backend, it still runs because frontend is dependent on it
You can comment-out the depend_on for frontend service and run it as

docker compose -f docker-compose.yaml -f docker-compose.override.yaml up -d mysql redis clickhouse frontend

Copy link
Collaborator

@andrescrz andrescrz Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can improve this in the near future by adding docker compose groups, so by default we start everything while we can choose to start: databases only, databases + BE, everything but BE etc.

In the meantime, documenting that that the BE container should be stop is good enough.



3. Update your Opik Backend configuration to connect to all databases on the localhost, and run it
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you say localhost, do you mean the one set in step 1? If that's the case, I think it's worth mentioning

Copy link

@amirzatcomet amirzatcomet Jan 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't have to add special setup for my Opik BE, it looks like it's already set up with those default ports
Just had to change the nginx setting above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@idoberko2 i mean your local backend configuration, not in docker-compose.yaml

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@liyaka like I said, I changed nothing and it worked, are you sure any local config changes are required to the BE?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amir is right here, values in apps/opik-backend/config.yml already default to this. If not, we should fix it like I recently did here: #958

I think we can remove this bullet point number 3.



## Stop opik
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?


Expand Down