Skip to content

docs: fix docker link #6142

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

yihau
Copy link
Member

@yihau yihau commented May 7, 2025

Problem

the old things are still living in our code

Summary of Changes

update them

@yihau yihau requested review from t-nelson and steviez May 7, 2025 15:49
@yihau yihau added the v2.2 Backport to v2.2 branch label May 7, 2025
Copy link

mergify bot commented May 7, 2025

Backports to the beta branch are to be avoided unless absolutely necessary for fixing bugs, security issues, and perf regressions. Changes intended for backport should be structured such that a minimum effective diff can be committed separately from any refactoring, plumbing, cleanup, etc that are not strictly necessary to achieve the goal. Any of the latter should go only into master and ride the normal stabilization schedule. Exceptions include CI/metrics changes, CLI improvements and documentation updates on a case by case basis.

Copy link

@steviez steviez left a comment

Choose a reason for hiding this comment

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

We obviously don't want these being used in prod, but we give that warning in docs and have given this warning when people ask about it. So, updating to the current location seems like correct thing to do.

LGTM

@t-nelson
Copy link

t-nelson commented May 7, 2025

i'd be tempted to delete the link from this particular page. maybe the whole paragraph about where we use docker

@steviez steviez self-requested a review May 7, 2025 19:12
releases at [solanalabs/solana](https://hub.docker.com/r/solanalabs/solana).
releases at [agavexyz/agave](https://hub.docker.com/r/agavexyz/agave).
Copy link

@steviez steviez May 7, 2025

Choose a reason for hiding this comment

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

i'd be tempted to delete the link from this particular page. maybe the whole paragraph about where we use docker

Didn't notice this in my first pass, but I agree. This page is Requirements under the Operating a Validator section: https://docs.anza.xyz/operations/requirements

Since we do NOT recommend using Docker to run production validators, there is no reason to mention Docker on the validator page. So, I think we should rip out this whole section:

## Docker
Running an Agave validator for live clusters (including mainnet-beta) inside Docker is
not recommended and generally not supported. This is due to concerns of general
Docker's containerization overhead and resultant performance degradation unless
specially configured.
We use Docker only for development purposes. Docker Hub contains images for all
releases at [solanalabs/solana](https://hub.docker.com/r/solanalabs/solana).

Copy link

Choose a reason for hiding this comment

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

i do think we should keep the no support warning and other discouragements in the first paragraph of this section

Copy link

Choose a reason for hiding this comment

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

That works for me. My thought was that even mentioning Docker on this page would plant the idea in someone's head that it is an option they may pursue.

But to your point, keeping the warning/discouragement around gives us something we can point at if someone says "I found your Docker images, but my validator doesn't work when running them"

@yihau
Copy link
Member Author

yihau commented May 8, 2025

I think we can maybe reword it in a later PR. Let me merge this one to fix the outdated info for now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v2.2 Backport to v2.2 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants