package/gvisor-tap-vsock
1
0
Fork 0
mirror of https://github.com/containers/gvisor-tap-vsock.git synced 2025-10-04 00:16:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for REST api and client package

Browse Source 
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
This commit is contained in:
Christophe Fergeau
2025-09-24 16:07:01 +02:00
parent 976f29d2d4
commit f93fc774a1
1 changed files with 42 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
pkg/client/client.go
View File

@@ -1,3 +1,5 @@
// Package client provides go bindings for gvisor-tap-vsock HTTP API
// This API is accessible over the endpoint specified with the `--services` or `--listen` arguments to `gvproxy`
package client package client
import ( import (
@@ -17,6 +19,7 @@ type Client struct {
base string base string
} }
// New returns a new instance of a Client. client will be used for the HTTP communication, and base specifies the base path the HTTP API is available at.
func New(client *http.Client, base string) *Client { func New(client *http.Client, base string) *Client {
return &Client{ return &Client{
client: client, client: client,
@@ -24,6 +27,12 @@ func New(client *http.Client, base string) *Client {
} }
} }
// List lists all the forwarded ports between host and guest
//
// Request:
// GET /services/forwarder/all
// Response:
// [{"local":"127.0.0.1:2223","remote":"192.168.127.2:22","protocol":"tcp"}]
func (c *Client) List() ([]types.ExposeRequest, error) { func (c *Client) List() ([]types.ExposeRequest, error) {
res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/forwarder/all")) res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/forwarder/all"))
if err != nil { if err != nil {
@@ -41,6 +50,13 @@ func (c *Client) List() ([]types.ExposeRequest, error) {
return ports, nil return ports, nil
} }
// Expose forwards a new port between host and guest
//
// Request:
// POST /services/forwarder/expose
// {"local":"127.0.0.1:2224","remote":"192.168.127.2:22","protocol":"tcp"}
// Response:
// HTTP Status Code
func (c *Client) Expose(req *types.ExposeRequest) error { func (c *Client) Expose(req *types.ExposeRequest) error {
bin, err := json.Marshal(req) bin, err := json.Marshal(req)
if err != nil { if err != nil {
@@ -61,6 +77,13 @@ func (c *Client) Expose(req *types.ExposeRequest) error {
return nil return nil
} }
// Unexpose stops forwarding a port between host and guest
//
// Request:
// POST /services/forwarder/unexpose
// {"local":"127.0.0.1:2224","protocol":"tcp"}
// Response:
// HTTP Status Code
func (c *Client) Unexpose(req *types.UnexposeRequest) error { func (c *Client) Unexpose(req *types.UnexposeRequest) error {
bin, err := json.Marshal(req) bin, err := json.Marshal(req)
if err != nil { if err != nil {
@@ -81,6 +104,12 @@ func (c *Client) Unexpose(req *types.UnexposeRequest) error {
return nil return nil
} }
// ListDNS shows the configuration of the built-in DNS server
//
// Request:
// GET /services/dns/all
// Response:
// [{"Name":"containers.internal.","Records":[{"Name":"gateway","IP":"192.168.127.1","Regexp":null},{"Name":"host","IP":"192.168.127.254","Regexp":null}],"DefaultIP":""},{"Name":"docker.internal.","Records":[{"Name":"gateway","IP":"192.168.127.1","Regexp":null},{"Name":"host","IP":"192.168.127.254","Regexp":null}],"DefaultIP":""}]
func (c *Client) ListDNS() ([]types.Zone, error) { func (c *Client) ListDNS() ([]types.Zone, error) {
res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/dns/all")) res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/dns/all"))
if err != nil { if err != nil {
@@ -98,6 +127,13 @@ func (c *Client) ListDNS() ([]types.Zone, error) {
return dnsZone, nil return dnsZone, nil
} }
// AddDNS adds a new DNS zone to the built-in DNS server
//
// Request:
// POST /services/dns/add
// {"Name":"test.internal.","Records":[{"Name":"gateway","IP":"192.168.127.1"}]}
// Response:
// HTTP Status Code
func (c *Client) AddDNS(req *types.Zone) error { func (c *Client) AddDNS(req *types.Zone) error {
bin, err := json.Marshal(req) bin, err := json.Marshal(req)
if err != nil { if err != nil {
@@ -118,6 +154,12 @@ func (c *Client) AddDNS(req *types.Zone) error {
return nil return nil
} }
// ListDHCPLeases shows the configuration of the built-in DNS server
//
// Request:
// GET /services/dhcp/leases
// Response:
// {"192.168.127.1":"5a:94:ef:e4:0c:dd","192.168.127.2":"5a:94:ef:e4:0c:ee"}
func (c *Client) ListDHCPLeases() (map[string]string, error) { func (c *Client) ListDHCPLeases() (map[string]string, error) {
res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/dhcp/leases")) res, err := c.client.Get(fmt.Sprintf("%s%s", c.base, "/services/dhcp/leases"))
if err != nil { if err != nil {