docs: docker install guide - #427
Conversation
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
muchzill4
left a comment
muchzill4
left a comment
There was a problem hiding this comment.
Really great piece of work. Useful as is and happy to get it in.
I do have some reservations about long term maintenance and the amount of detail. I wonder if it’s worth us hand-holding people as much for various installation methods. I’d almost go to the other extreme and just list the suggestions. Consider Docker work arounds “advanced” use case, and let people figure it out. Also curious if we could push topo health to provide guidance in case of broken setup.
|
|
||
| Follow the [Docker Desktop installation instructions](https://docs.docker.com/desktop/setup/install/) for your host. On Windows, configure Docker Desktop to use Linux containers. | ||
|
|
||
| Start Docker Desktop before you use Topo, and keep it running. Signing in to Docker Desktop is optional unless your organization requires it. Sign in to [increase Docker Hub pull limits, access private images, or apply organization security policies](https://docs.docker.com/desktop/setup/sign-in/). |
There was a problem hiding this comment.
Is this needed? My thinking: what’s the minimal set of cromulent instructions. Minimal = less maintenance.
There was a problem hiding this comment.
I was trying to address the pitfall we've seen a couple users fall into where topo deploy fails due to Docker Hub rate limiting or SSO enforcement or whatever. Though iirc the error was pretty clear so will remove.
|
|
||
| Follow the [Rancher Desktop installation instructions](https://docs.rancherdesktop.io/getting-started/installation/) for your host. When Rancher Desktop starts for the first time, select **dockerd (moby)** as the container engine. Topo does not require Kubernetes. You can change these settings later in **Preferences**. | ||
|
|
||
| On macOS and Linux, select **Automatic** to add the Rancher Desktop tools to `PATH`. If you select **Manual**, add `~/.rd/bin` to `PATH` yourself. |
There was a problem hiding this comment.
This also feels a bit too detailed for our docs, thought I can be convinced otherwise.
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Also been thinking about this morning. My other gripe with this doc in its current state is its unclear which of the alternatives we recommend for each OS. I've refactored pretty heavily here to just a table mapping OS/Arch -> recommendation. This shifts maintenance away from detailed install instructions to picking a good container engine for Topo users which feels more in our remit. 4956134 |
2 participants
Changes
topo health) and the install Topo pageWhy the choices of recommendation?
One key bit we miss is a FOSS Windows-on-Arm story. Rancher Desktop is considering/working on this. Docker Desktop already supports it so felt we were well-covered.
Testing
Manually Tested:
Untested but high confidence given the above tests:
Checklist