Skip to content
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

Clarify Windows/Mac support in whatis #210

Merged
merged 1 commit into from
Apr 16, 2020

Conversation

TomSweeneyRedHat
Copy link
Member

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]

@TomSweeneyRedHat
Copy link
Member Author

@rhatdan @baude @mheon PTAL

@jwhonce
Copy link
Member

jwhonce commented Mar 28, 2020

@TomSweeneyRedHat More details can be found in mac_client.md

On macos

$ podman --remote-host 192.168.xxx.yyy --username root ...

-or-

$ export PODMAN_VARLINK_BRIDGE=$'ssh -T [email protected] -- "/usr/bin/varlink -A \'/usr/bin/podman varlink \$VARLINK_ADDRESS\' bridge"'
$ podman ...

On Windows

C:> set PODMAN_VARLINK_BRIDGE=C:\Windows\System32\OpenSSH\ssh.exe -T -p59450 [email protected] -- varlink -A "podman varlink $VARLINK_ADDRESS" bridge
C:> podman...

@TomSweeneyRedHat
Copy link
Member Author

Thanks @jwhonce. Should I not be pointing that the remote_client tutorial or add a pointer to the mac_client too?

@jwhonce
Copy link
Member

jwhonce commented Mar 31, 2020

@TomSweeneyRedHat I would add the mac_client pointer.

@TomSweeneyRedHat TomSweeneyRedHat force-pushed the dev/tsweeney/fixwhatis branch 2 times, most recently from 865381e to 33c51d1 Compare March 31, 2020 21:03
@TomSweeneyRedHat
Copy link
Member Author

@jwhonce think I've captured what you're saying. I was trying to keep it as concise as possible and just provide pointers. PTAL

@TomSweeneyRedHat
Copy link
Member Author

re-ping @jwhonce

Copy link
Member

@jwhonce jwhonce left a comment

Choose a reason for hiding this comment

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

Small changes which I hope clarify services vs. clients.

whatis.html Outdated
Comment on lines 23 to 26
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.
The Podman service runs only on Linux platforms, however a REST API and clients are currently under development which will
allow Mac and Windows platforms to call the service. 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.

whatis.html Outdated
@@ -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>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<li>Allow the Podman CLI to use a REST API to connect to remote Podman instances on Linux from Mac and Windows.</li>
<li>Allow the Podman CLI to use a REST API to connect to remote Podman services on Linux from Mac and Windows.</li>

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]>
@TomSweeneyRedHat
Copy link
Member Author

Updated with @jwhonce 's latest comments. @rhatdan PTAL and merge if it LGTY.

@rhatdan rhatdan merged commit e1a9421 into containers:master Apr 16, 2020
@TomSweeneyRedHat TomSweeneyRedHat deleted the dev/tsweeney/fixwhatis branch August 14, 2020 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants