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

Support to customize which images/containers to run #756

Open
11 tasks
acuarica opened this issue Aug 28, 2024 · 2 comments
Open
11 tasks

Support to customize which images/containers to run #756

acuarica opened this issue Aug 28, 2024 · 2 comments
Labels
good first issue candidate Issues that can become a good first issue but need more description/context.

Comments

@acuarica
Copy link

acuarica commented Aug 28, 2024

🆕🐥 First Timers Only

This issue is reserved for people who have never contributed to Hedera or any open source project in general.
We know that creating a pull request (PR) is a major barrier for new contributors.
The goal of this issue and all other issues labeled by 'Good First Issue' is to help you make your first contribution to Hedera.

👾 Description of the issue

When using the Local Node for testing purposes or scripting, there are many images/containers that might not be needed.

For example, when working only with the Relay, the Hedera Explorer might not be used. In addition, there are "complementary" containers that usually are not used in testing, e.g., grafana and prometheus.

As another example, a minimal setup with the Relay would have only these images: network-node (consensus-node), mirror-node-rest, json-rpc-relay and any other dependency to run these.

Proposed Solution:

Enable support to specify which images/containers to run. Ultimately, as I dev I would like to configure which containers to start.

Ideally, this configuration should be possible with both the CLI and a config file.

📋 Step by step guide to do a contribution

If you have never contributed to an open source project at GitHub, the following step-by-step guide will introduce you to the workflow. More information and concrete samples for shell commands for each step can be found in our CONTRIBUTING.md file.
A more detailed general documentation of the GitHub PR workflow can be found here.

  • Claim this issue: Comment below that you are interested in working on the issue
  • Wait for assignment: A community member with the given rights will add you as an assignee of the issue
  • Fork the repository: You can do that in GitHub (by simply clicking the 'fork' button).
  • Check out the forked repository
  • Create a feature branch for the issue. We do not have a hard naming definition for branches but it is best practice to prefix the branch name with the issue id.
  • Solve the issue in your branch.
  • Commit your changes: Here, it is needed to add sign-off information to the commit to accept the "Developer Certificate of Origin" (https://developercertificate.org). More details can be found in our CONTRIBUTING.md
  • Start a Pull Request (PR): We have a pattern for naming pull requests that a GitHub Action checks. We use that pattern to support the creation of automatic release notes.
  • Check GitHub Actions: Several GitHub Actions will be triggered automatically for each PR. If a GitHub Action fails and you do not understand the cause of that error do not hesitate to add a comment to the PR and ask the Hedera developer community for support.
  • Wait for reviews: Members of the Hedera developer community will review your PR. If a reviewer finds any missing pieces or a problem, he or she will start a discussion with you and describe the next steps for solving the problem.
  • You did it 🎉: We will merge the fix in the develop branch. Thanks for being part of the Hedera community as an open-source contributor ❤️

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a chance to receive cool goodies like a T-Shirt. 🎽

🤔 Additional Information

If you have any questions, just ask us directly in this issue by adding a comment. You can join our community chat at Discord. A general manual about open-source contributions can be found here.

@Ivo-Yankov Ivo-Yankov added Good first issue Good for newcomers hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. labels Oct 14, 2024
@hendrikebbers hendrikebbers added good first issue candidate Issues that can become a good first issue but need more description/context. and removed Good first issue Good for newcomers hacktoberfest Issues shown by lists for the Hacktoberfest and made for newcomers to do the first contribution. labels Oct 16, 2024
@hendrikebbers
Copy link
Member

@acuarica can you add some more details how to start working on the issue. I would have no clue ;)

@acuarica
Copy link
Author

@hendrikebbers is there something that's not clear about the problem? I wouldn't have a clear idea on how to start on this unless I investigate the repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue candidate Issues that can become a good first issue but need more description/context.
Projects
None yet
Development

No branches or pull requests

3 participants