dokkuclient

package
v1.0.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2024 License: MPL-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidUser = errors.New("must use a dokku user for authentication, see the docs")
)

Functions

func DoubleDashArg 

func DoubleDashArg[T ValueString](key string, value T) string

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func New 

func New(client *goph.Client, logSshCommands bool, uploadAppName string, uploadSplitBytes int) *Client

func (*Client) AppCreate 

func (c *Client) AppCreate(ctx context.Context, appName string) error

func (*Client) AppDestroy 

func (c *Client) AppDestroy(ctx context.Context, appName string) error

func (*Client) AppExists 

func (c *Client) AppExists(ctx context.Context, appName string) (bool, error)

func (*Client) ChecksGet 

func (c *Client) ChecksGet(ctx context.Context, appName string) (status string, err error)

func (*Client) ChecksSet 

func (c *Client) ChecksSet(ctx context.Context, appName string, status string) error

func (*Client) ConfigExport 

func (c *Client) ConfigExport(ctx context.Context, appName string) (res map[string]string, err error)

func (*Client) ConfigSet 

func (c *Client) ConfigSet(ctx context.Context, appName string, data map[string]string) error

func (*Client) ConfigUnset 

func (c *Client) ConfigUnset(ctx context.Context, appName string, names []string) error

func (*Client) DeployFromArchive 

func (c *Client) DeployFromArchive(ctx context.Context, appName string, archiveType string, archiveUrl string) error

func (*Client) DeployFromImage 

func (c *Client) DeployFromImage(ctx context.Context, appName string, dockerImage string, allowRebuild bool) (deployed bool, err error)

func (*Client) DeployRebuild 

func (c *Client) DeployRebuild(ctx context.Context, appName string) error

func (*Client) DeploySyncRepository 

func (c *Client) DeploySyncRepository(ctx context.Context, appName string, repositoryUrl string, ref string) error

func (*Client) DeployUnsetSourceImage 

func (c *Client) DeployUnsetSourceImage(ctx context.Context, appName string) error

func (*Client) DockerOptionAdd 

func (c *Client) DockerOptionAdd(ctx context.Context, appName string, phases []string, value string) error

func (*Client) DockerOptionExists 

func (c *Client) DockerOptionExists(ctx context.Context, appName string, phase string, value string) (bool, error)

func (*Client) DockerOptionRemove 

func (c *Client) DockerOptionRemove(ctx context.Context, appName string, phases []string, value string) error

func (*Client) DomainAdd 

func (c *Client) DomainAdd(ctx context.Context, appName string, domain string) error

func (*Client) DomainRemove 

func (c *Client) DomainRemove(ctx context.Context, appName string, domain string) error

func (*Client) DomainsClear 

func (c *Client) DomainsClear(ctx context.Context, appName string) error

func (*Client) DomainsDisable 

func (c *Client) DomainsDisable(ctx context.Context, appName string) error

func (*Client) DomainsEnable 

func (c *Client) DomainsEnable(ctx context.Context, appName string) error

func (*Client) DomainsExport 

func (c *Client) DomainsExport(ctx context.Context, appName string) (res []string, err error)

func (*Client) DomainsSet 

func (c *Client) DomainsSet(ctx context.Context, appName string, domains []string) error

func (*Client) GetVersion 

func (c *Client) GetVersion(ctx context.Context) (rawVersion string, parsedVersion semver.Version, err error)

func (*Client) GitAuth 

func (c *Client) GitAuth(ctx context.Context, host string, login string, password string) error

func (*Client) GlobalDomainAdd 

func (c *Client) GlobalDomainAdd(ctx context.Context, domain string) error

func (*Client) GlobalDomainExists 

func (c *Client) GlobalDomainExists(ctx context.Context, domain string) (bool, error)

func (*Client) GlobalDomainRemove 

func (c *Client) GlobalDomainRemove(ctx context.Context, domain string) error

func (*Client) HttpAuthAddUser 

func (c *Client) HttpAuthAddUser(ctx context.Context, appName string, user string, password string) error

func (*Client) HttpAuthDisable 

func (c *Client) HttpAuthDisable(ctx context.Context, appName string) error

func (*Client) HttpAuthEnable 

func (c *Client) HttpAuthEnable(ctx context.Context, appName string) error

func (*Client) HttpAuthRemoveUser 

func (c *Client) HttpAuthRemoveUser(ctx context.Context, appName string, user string) error

func (*Client) HttpAuthReport 

func (c *Client) HttpAuthReport(ctx context.Context, appName string) (enabled bool, users []string, err error)

func (*Client) LetsencryptAddCronJob 

func (c *Client) LetsencryptAddCronJob(ctx context.Context) error

func (*Client) LetsencryptDisable 

func (c *Client) LetsencryptDisable(ctx context.Context, appName string) error

func (*Client) LetsencryptEnable 

func (c *Client) LetsencryptEnable(ctx context.Context, appName string) error

func (*Client) LetsencryptIsEnabled 

func (c *Client) LetsencryptIsEnabled(ctx context.Context, appName string) (bool, error)

func (*Client) LetsencryptSetEmail 

func (c *Client) LetsencryptSetEmail(ctx context.Context, appName string, email string) error

func (*Client) NetworkCreate 

func (c *Client) NetworkCreate(ctx context.Context, name string) error

func (*Client) NetworkEnsureAndSetForApp 

func (c *Client) NetworkEnsureAndSetForApp(ctx context.Context, appName string, networkType string, name string) error

func (*Client) NetworkExists 

func (c *Client) NetworkExists(ctx context.Context, name string) (bool, error)

func (*Client) NetworkGetNameForApp 

func (c *Client) NetworkGetNameForApp(ctx context.Context, appName string, networkType string) (string, error)

func (*Client) NetworkUnsetForApp 

func (c *Client) NetworkUnsetForApp(ctx context.Context, appName string, networkType string) error

func (*Client) NetworksReport 

func (c *Client) NetworksReport(ctx context.Context, name string) (networks map[string]string, err error)

func (*Client) NginxConfigGetValue added in v1.0.20 

func (c *Client) NginxConfigGetValue(ctx context.Context, appName string, property string) (string, error)

func (*Client) NginxConfigResetValue added in v1.0.20 

func (c *Client) NginxConfigResetValue(ctx context.Context, appName string, property string) error

func (*Client) NginxConfigSetValue added in v1.0.20 

func (c *Client) NginxConfigSetValue(ctx context.Context, appName string, property string, value string) error

func (*Client) PluginIsInstalled 

func (c *Client) PluginIsInstalled(ctx context.Context, pluginNameToFind string) (bool, error)

func (*Client) PortAdd 

func (c *Client) PortAdd(ctx context.Context, appName string, scheme string, hostPort int64, containerPort int64) error

func (*Client) PortRemove 

func (c *Client) PortRemove(ctx context.Context, appName string, hostPort int64) error

func (*Client) PortsClear 

func (c *Client) PortsClear(ctx context.Context, appName string) error

func (*Client) PortsExport 

func (c *Client) PortsExport(ctx context.Context, appName string) (res []Port, err error)

func (*Client) PortsSet 

func (c *Client) PortsSet(ctx context.Context, appName string, ports []Port) error

func (*Client) ProcessRestart 

func (c *Client) ProcessRestart(ctx context.Context, appName string) error

func (*Client) ProxyBuildConfig added in v1.0.21 

func (c *Client) ProxyBuildConfig(ctx context.Context, appName string) error

func (*Client) ProxyDisable 

func (c *Client) ProxyDisable(ctx context.Context, appName string) error

func (*Client) ProxyEnable 

func (c *Client) ProxyEnable(ctx context.Context, appName string) error

func (*Client) RegistryLogin 

func (c *Client) RegistryLogin(ctx context.Context, host string, login string, password string) error

func (*Client) Run deprecated 

func (c *Client) Run(ctx context.Context, cmd string, sensitiveStrings ...string) (stdout string, status int, err error)

Run runs any ssh command

Deprecated: Use specific methods.

func (*Client) RunQuiet deprecated 

func (c *Client) RunQuiet(ctx context.Context, cmd string, sensitiveStrings ...string) (stdout string, status int, err error)

RunQuiet runs any ssh command with "--quiet" flag

Deprecated: Use specific methods.

func (*Client) SimpleServiceCreate 

func (c *Client) SimpleServiceCreate(ctx context.Context, servicePluginName string, serviceName string, args ...string) error

func (*Client) SimpleServiceDestroy 

func (c *Client) SimpleServiceDestroy(ctx context.Context, servicePluginName string, serviceName string) error

func (*Client) SimpleServiceExists 

func (c *Client) SimpleServiceExists(ctx context.Context, servicePluginName string, serviceName string) (bool, error)

func (*Client) SimpleServiceExpose 

func (c *Client) SimpleServiceExpose(ctx context.Context, servicePluginName string, serviceName string, expose string) error

func (*Client) SimpleServiceInfo 

func (c *Client) SimpleServiceInfo(ctx context.Context, servicePluginName string, serviceName string) (map[string]string, error)

func (*Client) SimpleServiceLinkCreate 

func (c *Client) SimpleServiceLinkCreate(ctx context.Context, servicePluginName string, serviceName string, appName string, args ...string) error

func (*Client) SimpleServiceLinkExists 

func (c *Client) SimpleServiceLinkExists(ctx context.Context, servicePluginName string, serviceName string, appName string) (bool, error)

func (*Client) SimpleServiceLinkRemove 

func (c *Client) SimpleServiceLinkRemove(ctx context.Context, servicePluginName string, serviceName string, appName string) error

func (*Client) SimpleServiceUnexpose 

func (c *Client) SimpleServiceUnexpose(ctx context.Context, servicePluginName string, serviceName string) error

func (*Client) StorageEnsure 

func (c *Client) StorageEnsure(ctx context.Context, name string, localDirectory *string) error

func (*Client) StorageExport 

func (c *Client) StorageExport(ctx context.Context, appName string) (res map[string]string, err error)

func (*Client) StorageMount 

func (c *Client) StorageMount(ctx context.Context, appName string, name string, mountPath string) error

func (*Client) StorageUnmount 

func (c *Client) StorageUnmount(ctx context.Context, appName string, name string, mountPath string) error

type Port 

type Port struct {
	Scheme        string
	HostPort      string
	ContainerPort string
}

type ValueString 

type ValueString interface {
	ValueString() string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.