-
Notifications
You must be signed in to change notification settings - Fork 473
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
base: master
Are you sure you want to change the base?
docs: fix docker link #6142
Conversation
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. |
There was a problem hiding this 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
i'd be tempted to delete the link from this particular page. maybe the whole paragraph about where we use docker |
releases at [solanalabs/solana](https://hub.docker.com/r/solanalabs/solana). | ||
releases at [agavexyz/agave](https://hub.docker.com/r/agavexyz/agave). |
There was a problem hiding this comment.
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:
agave/docs/src/operations/requirements.md
Lines 39 to 47 in 11045e2
## 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). |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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"
I think we can maybe reword it in a later PR. Let me merge this one to fix the outdated info for now! |
Problem
the old things are still living in our code
Summary of Changes
update them