Add guidelines for local run #983
Conversation
| Stop backend container, cause you don't need it.. | ||
|
|
||
|
|
||
| 3. Update your Opik Backend configuration to connect to all databases on the localhost, and run it |
There was a problem hiding this comment.
When you say localhost, do you mean the one set in step 1? If that's the case, I think it's worth mentioning
There was a problem hiding this comment.
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
There was a problem hiding this comment.
@idoberko2 i mean your local backend configuration, not in docker-compose.yaml
There was a problem hiding this comment.
@liyaka like I said, I changed nothing and it worked, are you sure any local config changes are required to the BE?
There was a problem hiding this comment.
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.
| ```bash | ||
| docker compose -f docker-compose.yaml -f docker-compose.override.yaml up -d | ||
| ``` | ||
| Stop backend container, cause you don't need it.. |
There was a problem hiding this comment.
why stop the backend? cant we just disable it in docker compose override?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
deployment/docker-compose/README.md
Outdated
| @@ -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 with docker-compose | |||
There was a problem hiding this comment.
| ## Run Opik backend locally and the rest with docker-compose | |
| ## Run Opik backend locally and the dependencies with docker-compose |
There was a problem hiding this comment.
Frontend is not a dependency :)
|
This was supposed to be a quick commit for our own devs to start working, if we're going to do this for the community we have to do it right, test it, document properly and make any code changes required to support it so that it's easiest for the user to get it working without messing it up. |
|
|
||
|
|
||
| 3. Update your Opik Backend configuration to connect to all databases on the localhost, and run it | ||
|
|
||
|
|
||
| ## Stop opik |
| ```bash | ||
| docker compose -f docker-compose.yaml -f docker-compose.override.yaml up -d | ||
| ``` | ||
| Stop backend container, cause you don't need it.. |
There was a problem hiding this comment.
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.
| Stop backend container, cause you don't need it.. | ||
|
|
||
|
|
||
| 3. Update your Opik Backend configuration to connect to all databases on the localhost, and run it |
There was a problem hiding this comment.
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.
Details
Issues
Resolves #
Testing
Documentation