Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v1

v1.6.0

Oct 15, 2025

v1.5.0

Oct 15, 2025

v1.4.0

Oct 15, 2025

Changes in this version

+ const DefaultUnixSocket

type Client

+ func NewClientAuto(addr string) (*Client, error)

v1.3.0

Oct 14, 2025

Changes in this version

type Client

+ func (c *Client) RollbackService(id string) error

+ func (c *Client) UpdateServiceImage(id string, image string, strategy string, updateConfig *proto.UpdateConfig) error

v1.1.1

Oct 13, 2025

Changes in this version

type Client

+ func (c *Client) ListContainers(serviceID, nodeID string) ([]*proto.Container, error)

v1.1.0

Oct 12, 2025

Changes in this version

+ type Client struct

+ func NewClient(addr string) (*Client, error)

+ func NewClientWithToken(addr, token string) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) CreateIngress(req *proto.CreateIngressRequest) (*proto.Ingress, error)

+ func (c *Client) CreateSecret(name string, data []byte) (*proto.Secret, error)

+ func (c *Client) CreateService(name, image string, replicas int32, env map[string]string) (*proto.Service, error)

+ func (c *Client) CreateServiceWithOptions(req *proto.CreateServiceRequest) (*proto.Service, error)

+ func (c *Client) CreateTLSCertificate(req *proto.CreateTLSCertificateRequest) (*proto.TLSCertificate, error)

+ func (c *Client) CreateVolume(name, driver string, options map[string]string) (*proto.Volume, error)

+ func (c *Client) DeleteIngress(req *proto.DeleteIngressRequest) error

+ func (c *Client) DeleteSecret(name string) error

+ func (c *Client) DeleteService(id string) error

+ func (c *Client) DeleteTLSCertificate(req *proto.DeleteTLSCertificateRequest) error

+ func (c *Client) DeleteVolume(name string) error

+ func (c *Client) GenerateJoinToken(role string) (string, error)

+ func (c *Client) GetClusterInfo() (*proto.GetClusterInfoResponse, error)

+ func (c *Client) GetIngress(req *proto.GetIngressRequest) (*proto.Ingress, error)

+ func (c *Client) GetNode(id string) (*proto.Node, error)

+ func (c *Client) GetSecretByName(name string) (*proto.Secret, error)

+ func (c *Client) GetService(nameOrID string) (*proto.Service, error)

+ func (c *Client) GetTLSCertificate(req *proto.GetTLSCertificateRequest) (*proto.TLSCertificate, error)

+ func (c *Client) GetVolumeByName(name string) (*proto.Volume, error)

+ func (c *Client) JoinCluster(nodeID, bindAddr, token string) error

+ func (c *Client) ListIngresses() ([]*proto.Ingress, error)

+ func (c *Client) ListNodes() ([]*proto.Node, error)

+ func (c *Client) ListSecrets() ([]*proto.Secret, error)

+ func (c *Client) ListServices() ([]*proto.Service, error)

+ func (c *Client) ListTLSCertificates() ([]*proto.TLSCertificate, error)

+ func (c *Client) ListTasks(serviceID, nodeID string) ([]*proto.Task, error)

+ func (c *Client) ListVolumes() ([]*proto.Volume, error)

+ func (c *Client) UpdateIngress(req *proto.UpdateIngressRequest) (*proto.Ingress, error)

+ func (c *Client) UpdateService(id string, replicas int32) (*proto.Service, error)