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.

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

Merged
merged 6 commits into from
Jan 20, 2025
Merged

Conversation

liyaka
Copy link
Contributor

@liyaka liyaka commented Jan 5, 2025

Details

Added some guidelines for local docker-compose run for backend developers - running the backend locally and the rest of the components with docker-compose and backend locally

Issues

Resolves #

Testing

Documentation

@liyaka liyaka requested a review from amirzatcomet January 5, 2025 13:08
@liyaka liyaka requested review from a team as code owners January 5, 2025 13:08
amirzatcomet
amirzatcomet previously approved these changes Jan 5, 2025
Copy link

@amirzatcomet amirzatcomet left a comment

Choose a reason for hiding this comment

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

lgtm

```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

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.

deployment/docker-compose/README.md Outdated Show resolved Hide resolved
@amirzatcomet
Copy link

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.

Copy link
Collaborator

@andrescrz andrescrz left a comment

Choose a reason for hiding this comment

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

Left some comments, but it should be good to go soon.

Please update the PR description.

```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

@andrescrz andrescrz Jan 7, 2025

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.

deployment/docker-compose/README.md Outdated Show resolved Hide resolved
@liyaka liyaka force-pushed the liya/add-guidelines-for-local-run branch from 826dfe9 to dc866eb Compare January 13, 2025 14:32
@andrescrz
Copy link
Collaborator

@liyaka I'm happy to move forward with this. Any impediment to merge it?

@andrescrz andrescrz requested a review from Nimrod007 January 20, 2025 08:54
@andrescrz andrescrz dismissed Nimrod007’s stale review January 20, 2025 08:54

Just documentation, it can be send as follow-up PR.

@andrescrz andrescrz merged commit 2ac2557 into main Jan 20, 2025
@andrescrz andrescrz deleted the liya/add-guidelines-for-local-run branch January 20, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants