Merge pull request #6610 from jwhonce/wip/varlink

Add deprecated message to varlink command

cmd/podman/system/varlink.go

@@ -16,11 +16,13 @@ var (
   Tools speaking varlink protocol can remotely manage pods, containers and images.
 `
 	varlinkCmd = &cobra.Command{
-		Use:   "varlink [flags] [URI]",
-		Args:  cobra.MinimumNArgs(1),
-		Short: "Run varlink interface",
-		Long:  varlinkDescription,
-		RunE:  varlinkE,
+		Use:        "varlink [flags] [URI]",
+		Args:       cobra.MinimumNArgs(1),
+		Short:      "Run varlink interface",
+		Long:       varlinkDescription,
+		RunE:       varlinkE,
+		Deprecated: "Please see 'podman system service' for RESTful APIs",
+		Hidden:     true,
 		Example: `podman varlink unix:/run/podman/io.podman
   podman varlink --time 5000 unix:/run/podman/io.podman`,
 	}

docs/source/Commands.rst

@@ -100,8 +100,6 @@ Commands
 
 :doc:`unshare <markdown/podman-unshare.1>` Run a command in a modified user namespace
 
-:doc:`varlink <markdown/podman-varlink.1>` Run varlink interface
-
 :doc:`version <markdown/podman-version.1>` Display the Podman Version Information
 
 :doc:`volume <volume>` Manage volumes

docs/source/index.rst

@@ -6,7 +6,7 @@ Podman_ is a daemonless, open source, Linux native tool designed to make it easy
 
 Containers under the control of Podman can either be run by root or by a non-privileged user. Podman manages the entire container ecosystem which includes pods, containers, container images, and container volumes using the libpod_ library. 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 and container images in a production environment.
 
-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 remote client 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 Mac client. NOTE: 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 RESTful based remote client 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 Mac client.
 
 If you are completely new to containers, we recommend that you check out the :doc:`Introduction`. For power users or those comming from Docker, check out our :doc:`Tutorials`. For advanced users and contributors, you can get very detailed information about the Podman CLI by looking our :doc:`Commands` page. Finally, for Developers looking at how to interact with the Podman API, please see our API documentation :doc:`Reference`.
 

docs/source/markdown/podman-remote.1.md

@@ -17,7 +17,7 @@ Podman uses Buildah(1) internally to create container images. Both tools share i
 (not container) storage, hence each can use or manipulate images (but not containers)
 created by the other.
 
-Podman-remote provides a local client interacting with a Podman backend node through a varlink ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the varlink service activated. Credentials for this session can be passed in using flags, environment variables, or in `podman-remote.conf`
+Podman-remote provides a local client interacting with a Podman backend node through a RESTful API tunneled through a ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the API service activated. Credentials for this session can be passed in using flags, environment variables, or in `podman-remote.conf`
 
 **podman [GLOBAL OPTIONS]**
 

docs/source/markdown/podman-system-service.1.md

@@ -31,13 +31,8 @@ Run an API listening for 5 seconds using the default socket.
 podman system service --timeout 5000
 ```
 
-Run the podman varlink service with an alternate URI and accept the default timeout.
-```
-$ podman system service --varlink unix:/tmp/io.podman
-```
-
 ## SEE ALSO
-podman(1), podman-varlink(1)
+podman(1), podman-system-service(1), podman-system-connection(1)
 
 ## HISTORY
 January 2020, Originally compiled by Brent Baude<[email protected]>

docs/source/markdown/podman.1.md

@@ -207,7 +207,6 @@ the exit codes follow the `chroot` standard, see below:
 | [podman-unpause(1)](podman-unpause.1.md)         | Unpause one or more containers.                                             |
 | [podman-unshare(1)](podman-unshare.1.md)         | Run a command inside of a modified user namespace.                          |
 | [podman-untag(1)](podman-untag.1.md)             | Removes one or more names from a locally-stored image.                      |
-| [podman-varlink(1)](podman-varlink.1.md)         | Runs the varlink backend interface.                                         |
 | [podman-version(1)](podman-version.1.md)         | Display the Podman version information.                                     |
 | [podman-volume(1)](podman-volume.1.md)           | Simple management tool for volumes.                                         |
 | [podman-wait(1)](podman-wait.1.md)               | Wait on one or more containers to stop and print their exit codes.          |