Skip to content

Commit

Permalink
Clarify Windows/Mac support in whatis
Browse files Browse the repository at this point in the history
We've had comments in containers/podman#4364 that it's unclear
that we don't actually run Podman on Windows and Mac, rather it runs only on Linux and
you need remote clients on the other platforms.

This updates the whatis document to hopefully clarify.

Signed-off-by: TomSweeneyRedHat <[email protected]>
  • Loading branch information
TomSweeneyRedHat committed Mar 31, 2020
1 parent 00a01e2 commit 33c51d1
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion whatis.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ <h2>What is Podman? Simply put: `alias docker=podman`</h2>
Podman specializes in all of the commands and functions that help you to maintain and
modify OCI container images, such as pulling and tagging. It allows you to create, run,
and maintain those containers created from those images in a production environment.
<br><br>
Podman runs only on Linux platforms, however a REST API is currently under development which will
allow Mac and Windows platforms to call the server. There is currently a Varlink based <a href="https://github.com/containers/libpod/blob/master/docs/tutorials/remote_client.md">remote client</a> which
runs on Mac or Windows platforms that allows the remote client to talk to the Podman
server on a Linux platform. In addition to those clients, there is also a <a href="https://github.com/containers/libpod/blob/master/docs/tutorials/mac_client.md">Mac client</a>. <b>NOTE:</b> the Varlink remote client will be deprecated after the REST API is completed.

<h3>Overview and scope</h3>

Expand All @@ -35,7 +40,7 @@ <h3>Overview and scope</h3>

<h3>Roadmap</h3>
<ul>
<li>Allow the Podman CLI to use a Varlink backend to connect to remote Podman instances from Mac and Windows.</li>
<li>Allow the Podman CLI to use a REST API to connect to remote Podman instances on Linux from Mac and Windows.</li>
<li>Integrate libpod into CRI-O to replace its existing container management backend.</li>
<li>Further work on the podman pod command.</li>
<li>Further improvements on rootless containers.</li>
Expand Down

0 comments on commit 33c51d1

Please sign in to comment.