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

docker compose file and extended documentation #854

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

xai
Copy link
Contributor

@xai xai commented Feb 12, 2024

As discussed with @kkistm, this PR adds a docker-compose.yml and extends the existing documentation to make running a test environment as easy as possible.

Changes:

  • Update @anibalsolon's PR Speed-up development with docker-compose #625 with current versions and build instructions
  • Add profiles to the docker-compose.yml to let users decide which services to start in a container:
    • no selection of a profile starts only Postgres and Elasticsearch. This is suited for building and running the openvsx services on the local machine.
    • "openvsx" profile additionally builds and starts all openvsx-related services in separate containers
    • "backend", "frontend", "commandline" profiles for more fine-grained choices.
    • "kibana" profile can optionally be added to explore the Elasticsearch instance more conveniently,
  • Add information on how to register example extensions with the local registry.

How to test:

  • Run docker compose --profile openvsx up to start Postgres, Elasticsearch, and all three openvsx-related containers (server, webui, cli tools).
  • Verify with docker ps that all containers are running.
  • Verify that ports 8080 (server) and 3000 (webui) are exposed and that the local deployment works as expected.
  • docker compose down (or Ctrl-c in the original shell) for tearing down all containers.

Contributed on behalf of STMicroelectronics

@xai
Copy link
Contributor Author

xai commented Feb 29, 2024

For the docker-compose.yml, I changed the restart policy of the elasticsearch and postgres containers.

Copy link
Contributor

@amvanbaren amvanbaren left a comment

Choose a reason for hiding this comment

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

Hi @xai and @anibalsolon. The PR looks good overall. There's one small change I'd like to request. Can you change marketplace to registry in doc/development.md on line 11 and line 29?

@xai
Copy link
Contributor Author

xai commented Mar 18, 2024

Hi @xai and @anibalsolon. The PR looks good overall. There's one small change I'd like to request. Can you change marketplace to registry in doc/development.md on line 11 and line 29?

Sure! I rebased against current master and added a commit to correct our wording.

@amvanbaren
Copy link
Contributor

@xai Alright, can you squash your commits so that this PR can be merged into master as one feature?

We provide profiles in the docker compose file to allow
users to specify which services they want to start:

- no selection of a profile starts only Postgres and Elasticsearch.
  This is suited for building and running the openvsx services
  on the local machine.
- "openvsx" profile additionally builds and starts
  all openvsx-related services in separate containers
- "backend", "frontend", "commandline" profiles
  for more fine-grained choices.
- "kibana" profile can optionally be added to explore
  the Elasticsearch instance more conveniently,

Contributed on behalf of STMicroelectronics

Signed-off-by: Olaf Lessenich <olessenich@eclipsesource.com>
Co-authored-by: Anibal <anibalsolon@gmail.com>
@xai
Copy link
Contributor Author

xai commented Mar 19, 2024

@xai Alright, can you squash your commits so that this PR can be merged into master as one feature?

Done. I will do the same for my other PRs.

@amvanbaren amvanbaren merged commit 9a8db4b into eclipse:master Mar 20, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants