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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 9, 2025
+4 −4
Merged

docs: fix docker link #6142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docker-solana/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## Minimal Solana Docker image
This image is automatically updated by CI

https://hub.docker.com/r/solanalabs/solana/
https://hub.docker.com/r/anzaxyz/agave/

### Usage:
Run the latest beta image:
```bash
$ docker run --rm -p 8899:8899 --ulimit nofile=1000000 solanalabs/solana:beta
$ docker run --rm -p 8899:8899 --ulimit nofile=1000000 agavexyz/agave:beta
```

Run the latest edge image:
```bash
$ docker run --rm -p 8899:8899 --ulimit nofile=1000000 solanalabs/solana:edge
$ docker run --rm -p 8899:8899 --ulimit nofile=1000000 agavexyz/agave:edge
```

Port *8899* is the JSON RPC port, which is used by clients to communicate with the network.
2 changes: 1 addition & 1 deletion docs/src/operations/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ 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).
releases at [agavexyz/agave](https://hub.docker.com/r/agavexyz/agave).
Copy link

@steviez steviez May 7, 2025 •
edited
Loading

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).

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"


## Software

Expand Down