Documentation ¶
Index ¶
- Constants
- Variables
- type AppAppJsonReport
- type AppBuilder
- type AppBuilderDockerfileReport
- type AppBuilderPackReport
- type AppBuilderReport
- type AppBuildpacksReport
- type AppCertsReport
- type AppChecksReport
- type AppCronReport
- type AppDockerOptionsReport
- type AppDockerRegistryReport
- type AppDomainsReport
- type AppJsonProperty
- type AppJsonReport
- type AppLambdaBuilderReport
- type AppManagementOptions
- type AppNetworkReport
- type AppNginxReport
- type AppProcessReport
- type AppProxyReport
- type AppReport
- type AppResourceReport
- type AppSchedulerDockerLocalReport
- type AppSchedulerReport
- type AppStorageReport
- type AppsReport
- type BaseClient
- func (c *BaseClient) AddAppBuildpack(appName string, buildpack string) error
- func (c *BaseClient) AddAppBuildpackAtIndex(appName string, buildpack string, index int) error
- func (c *BaseClient) AddAppCert(appName string, crt string, key string) error
- func (c *BaseClient) AddAppDomain(appName string, domain string) error
- func (c *BaseClient) AddAppPhaseDockerOption(appName string, phase string, option string) error
- func (c *BaseClient) AddAppProxyPort(appName string, port ProxyPortMapping) error
- func (c *BaseClient) AddAppProxyPorts(appName string, ports []ProxyPortMapping) error
- func (c *BaseClient) AddGlobalDomain(domain string) error
- func (c *BaseClient) AddLetsEncryptCronJob() error
- func (c *BaseClient) AddSSHKey(name string, key []byte) error
- func (c *BaseClient) BuildAllProxyConfig(parallel *ParallelismOptions) error
- func (c *BaseClient) BuildAppProxyConfig(appName string, parallel *ParallelismOptions) error
- func (c *BaseClient) CheckAppExists(name string) (bool, error)
- func (c *BaseClient) CheckNetworkExists(name string) (bool, error)
- func (c *BaseClient) ClearAllProxyConfig() error
- func (c *BaseClient) ClearAppBuildpacks(appName string) error
- func (c *BaseClient) ClearAppConfig(appName string, restart bool) error
- func (c *BaseClient) ClearAppDefaultResourceLimit(appName string, resource ResourceSpec) error
- func (c *BaseClient) ClearAppDefaultResourceLimits(appName string) error
- func (c *BaseClient) ClearAppDockerRegistryProperty(appName string, property DockerRegistryProperty) error
- func (c *BaseClient) ClearAppDomains(appName string) error
- func (c *BaseClient) ClearAppLetsEncryptProperty(appName string, property LetsEncryptProperty) error
- func (c *BaseClient) ClearAppPhaseDockerOptions(appName string, phase string) error
- func (c *BaseClient) ClearAppProcessResourceLimit(appName string, process string, resource ResourceSpec) error
- func (c *BaseClient) ClearAppProcessResourceLimits(appName string, process string) error
- func (c *BaseClient) ClearAppProcessResourceReservation(appName string, process string, resource ResourceSpec) error
- func (c *BaseClient) ClearAppProcessResourceReservations(appName string, process string) error
- func (c *BaseClient) ClearAppProxyConfig(appName string) error
- func (c *BaseClient) ClearAppProxyPorts(appName string) error
- func (c *BaseClient) ClearAppResourceReservation(appName string, resource ResourceSpec) error
- func (c *BaseClient) ClearAppResourceReservations(appName string) error
- func (c *BaseClient) ClearGlobalConfig(restart bool) error
- func (c *BaseClient) ClearGlobalDomains() error
- func (c *BaseClient) ClearGlobalLetsEncryptProperty(property LetsEncryptProperty) error
- func (c *BaseClient) CloneApp(oldName string, newName string, opts *AppManagementOptions) error
- func (c *BaseClient) CreateApp(name string) error
- func (c *BaseClient) CreateNetwork(name string) error
- func (c *BaseClient) DestroyApp(name string) error
- func (c *BaseClient) DestroyNetwork(name string) error
- func (c *BaseClient) DisableAppDeployChecks(appName string) error
- func (c *BaseClient) DisableAppDomains(appName string) error
- func (c *BaseClient) DisableAppLetsEncrypt(appName string) error
- func (c *BaseClient) DisableAppProcessesDeployChecks(appName string, processes []string) error
- func (c *BaseClient) DockerCleanup(appName string) error
- func (c *BaseClient) DockerCleanupAll() error
- func (c *BaseClient) EnableAppDeployChecks(appName string) error
- func (c *BaseClient) EnableAppDomains(appName string) error
- func (c *BaseClient) EnableAppLetsEncrypt(appName string) error
- func (c *BaseClient) EnableAppProcessesDeployChecks(appName string, processes []string) error
- func (c *BaseClient) EnsureStorageDirectory(directory string, chown StorageChownOption) error
- func (c *BaseClient) Exec(command string) (string, error)
- func (c *BaseClient) ExecStreaming(command string) (*CommandOutputStream, error)
- func (c *BaseClient) ExecWithInput(command string, input io.Reader) (string, error)
- func (c *BaseClient) ExecWithInputStreaming(command string, input io.Reader) (*CommandOutputStream, error)
- func (c *BaseClient) ExportAppConfig(appName string, format ConfigExportFormat) (string, error)
- func (c *BaseClient) ExportGlobalConfig(format ConfigExportFormat) (string, error)
- func (c *BaseClient) GenerateAppCert(appName string, domain string) error
- func (c *BaseClient) GetAllAppCronReport() (CronReport, error)
- func (c *BaseClient) GetAllAppJsonReport() (AppJsonReport, error)
- func (c *BaseClient) GetAllAppProxyReport() (ProxyReport, error)
- func (c *BaseClient) GetAllAppReport() (AppsReport, error)
- func (c *BaseClient) GetAllFailedDeployLogs() (string, error)
- func (c *BaseClient) GetAllProcessReport() (ProcessReport, error)
- func (c *BaseClient) GetAppBuilderDockerfileReport(appName string) (*AppBuilderDockerfileReport, error)
- func (c *BaseClient) GetAppBuilderPackReport(appName string) (*AppBuilderPackReport, error)
- func (c *BaseClient) GetAppBuilderReport(appName string) (*AppBuilderReport, error)
- func (c *BaseClient) GetAppBuildpacksReport(appName string) (*AppBuildpacksReport, error)
- func (c *BaseClient) GetAppCertsReport(appName string) (*AppCertsReport, error)
- func (c *BaseClient) GetAppConfig(appName string) (map[string]string, error)
- func (c *BaseClient) GetAppConfigKeys(appName string) ([]string, error)
- func (c *BaseClient) GetAppConfigValue(appName string, key string, quoted bool) (string, error)
- func (c *BaseClient) GetAppCronReport(appName string) (*AppCronReport, error)
- func (c *BaseClient) GetAppDeployChecksReport(appName string) (*AppChecksReport, error)
- func (c *BaseClient) GetAppDockerOptionsReport(appName string) (*AppDockerOptionsReport, error)
- func (c *BaseClient) GetAppDockerRegistryReport(appName string) (*AppDockerRegistryReport, error)
- func (c *BaseClient) GetAppDomainsReport(appName string) (*AppDomainsReport, error)
- func (c *BaseClient) GetAppFailedDeployLogs(appName string) (string, error)
- func (c *BaseClient) GetAppJsonReport(appName string) (*AppAppJsonReport, error)
- func (c *BaseClient) GetAppLambdaBuilderReport(appName string) (*AppLambdaBuilderReport, error)
- func (c *BaseClient) GetAppLetsEncryptEnabled(appName string) (bool, error)
- func (c *BaseClient) GetAppLogs(appName string) (string, error)
- func (c *BaseClient) GetAppNetworkReport(appName string) (*AppNetworkReport, error)
- func (c *BaseClient) GetAppNginxAccessLogs(appName string) (string, error)
- func (c *BaseClient) GetAppNginxConfig(appName string) (string, error)
- func (c *BaseClient) GetAppNginxErrorLogs(appName string) (string, error)
- func (c *BaseClient) GetAppNginxReport(appName string) (*AppNginxReport, error)
- func (c *BaseClient) GetAppProcessLogs(appName, process string) (string, error)
- func (c *BaseClient) GetAppProcessReport(appName string) (*AppProcessReport, error)
- func (c *BaseClient) GetAppProcessScale(appName string) (map[string]int, error)
- func (c *BaseClient) GetAppProxyPortMappings(appName string) ([]ProxyPortMapping, error)
- func (c *BaseClient) GetAppProxyReport(appName string) (*AppProxyReport, error)
- func (c *BaseClient) GetAppReport(name string) (*AppReport, error)
- func (c *BaseClient) GetAppResourceReport(appName string) (*AppResourceReport, error)
- func (c *BaseClient) GetAppSchedulerDockerLocalReport(appName string) (*AppSchedulerDockerLocalReport, error)
- func (c *BaseClient) GetAppSchedulerReport(appName string) (*AppSchedulerReport, error)
- func (c *BaseClient) GetAppStorageReport(appName string) (*AppStorageReport, error)
- func (c *BaseClient) GetCertsReport() (CertsReport, error)
- func (c *BaseClient) GetDeployChecksReport() (ChecksReport, error)
- func (c *BaseClient) GetDockerRegistryReport() (DockerRegistryReport, error)
- func (c *BaseClient) GetDokkuVersion() (string, error)
- func (c *BaseClient) GetDomainsReport() (DomainsReport, error)
- func (c *BaseClient) GetEventLogs() (string, error)
- func (c *BaseClient) GetGlobalConfig() (map[string]string, error)
- func (c *BaseClient) GetGlobalConfigKeys() ([]string, error)
- func (c *BaseClient) GetGlobalConfigValue(key string, quoted bool) (string, error)
- func (c *BaseClient) GetGlobalDockerOptionsReport() (DockerOptionsReport, error)
- func (c *BaseClient) GetGlobalDomainsReport() (*GlobalDomainsReport, error)
- func (c *BaseClient) GetGlobalNginxReport() (NginxReport, error)
- func (c *BaseClient) GetLetsEncryptAppList() ([]LetsEncryptAppInfo, error)
- func (c *BaseClient) GetLetsEncryptAppReport(appName string) (*LetsEncryptAppReport, error)
- func (c *BaseClient) GetLetsEncryptCronJobEnabled() (bool, error)
- func (c *BaseClient) GetNAppLogs(appName string, numLines int) (string, error)
- func (c *BaseClient) GetNetworkInfo(name string) (interface{}, error)
- func (c *BaseClient) GetNetworkReport() (NetworkReport, error)
- func (c *BaseClient) GetProcessInfo(appName string) error
- func (c *BaseClient) GetResourceReport() (ResourceReport, error)
- func (c *BaseClient) GetSchedulerDockerLocalReport() (SchedulerDockerLocalReport, error)
- func (c *BaseClient) GetSchedulerReport() (SchedulerReport, error)
- func (c *BaseClient) GetStorageReport() (StorageReport, error)
- func (c *BaseClient) GitAllowHost(host string) error
- func (c *BaseClient) GitCreateFromArchive(appName string, url string, opt *GitArchiveOptions) (*CommandOutputStream, error)
- func (c *BaseClient) GitCreateFromImage(appName string, image string, opt *GitImageOptions) (*CommandOutputStream, error)
- func (c *BaseClient) GitGetAppReport(appName string) (*GitAppReport, error)
- func (c *BaseClient) GitGetPublicKey() (string, error)
- func (c *BaseClient) GitGetReport() (GitReport, error)
- func (c *BaseClient) GitInitializeApp(appName string) error
- func (c *BaseClient) GitPurgeRepoCache(appName string) error
- func (c *BaseClient) GitRemoveAppProperty(appName string, property GitProperty) error
- func (c *BaseClient) GitRemoveAuth(host string) error
- func (c *BaseClient) GitRunRepoGC(appName string) error
- func (c *BaseClient) GitSetAppProperty(appName string, property GitProperty, val string) error
- func (c *BaseClient) GitSetAuth(host string, username string, password string) error
- func (c *BaseClient) GitSyncAppRepo(appName string, repo string, opt *GitSyncOptions) (*CommandOutputStream, error)
- func (c *BaseClient) GitUnlockApp(appName string, force bool) error
- func (c *BaseClient) IsLocked(name string) (bool, error)
- func (c *BaseClient) LetsEncryptAutoRenew() error
- func (c *BaseClient) LetsEncryptAutoRenewApp(appName string) error
- func (c *BaseClient) LetsEncryptCleanup(appName string) error
- func (c *BaseClient) ListAppBuildpacks(appName string) ([]string, error)
- func (c *BaseClient) ListAppCronTasks(appName string) ([]CronTask, error)
- func (c *BaseClient) ListAppRunContainers(appName string) ([]string, error)
- func (c *BaseClient) ListAppStorage(appName string) ([]StorageBindMount, error)
- func (c *BaseClient) ListApps() ([]string, error)
- func (c *BaseClient) ListLoggedEvents() ([]string, error)
- func (c *BaseClient) ListNetworks() ([]string, error)
- func (c *BaseClient) ListPlugins() ([]PluginInfo, error)
- func (c *BaseClient) ListSSHKeys() ([]SSHKey, error)
- func (c *BaseClient) ListSSHKeysForName(name string) ([]SSHKey, error)
- func (c *BaseClient) LockApp(name string) error
- func (c *BaseClient) LoginDockerRegistry(server string, username string, password string) error
- func (c *BaseClient) MountAppStorage(appName string, mount StorageBindMount) error
- func (c *BaseClient) RebuildAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) RebuildAllNetworks() error
- func (c *BaseClient) RebuildApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) RebuildNetwork(name string) error
- func (c *BaseClient) RemoveAppBuildpack(appName string, buildpack string) error
- func (c *BaseClient) RemoveAppCerts(appName string) error
- func (c *BaseClient) RemoveAppDomain(appName string, domain string) error
- func (c *BaseClient) RemoveAppNetworkProperty(appName string, property NetworkProperty) error
- func (c *BaseClient) RemoveAppPhaseDockerOption(appName string, phase string, option string) error
- func (c *BaseClient) RemoveAppProxyPort(appName string, port ProxyPortMapping) error
- func (c *BaseClient) RemoveAppProxyPorts(appName string, ports []ProxyPortMapping) error
- func (c *BaseClient) RemoveGlobalDomain(domain string) error
- func (c *BaseClient) RemoveGlobalNetworkProperty(property NetworkProperty) error
- func (c *BaseClient) RemoveLetsEncryptCronJob() error
- func (c *BaseClient) RemoveSSHKeyByFingerprint(fingerprint string) error
- func (c *BaseClient) RemoveSSHKeyByName(name string) error
- func (c *BaseClient) RenameApp(oldName string, newName string, opts *AppManagementOptions) error
- func (c *BaseClient) RestartAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) RestartApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) RestartAppProcess(appName string, process string, p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) RevokeAppLetsEncryptCertificate(appName string) error
- func (c *BaseClient) RunAppCommand(appName string, runCmd string, options *DockerRunOptions) (string, error)
- func (c *BaseClient) SetAppBuilderDockerfileProperty(appName string, property DockerfileProperty, value string) error
- func (c *BaseClient) SetAppBuilderPackProperty(appName string, property BuildpackProperty, value string) error
- func (c *BaseClient) SetAppBuilderProperty(appName string, property BuilderProperty, value string) error
- func (c *BaseClient) SetAppBuildpack(appName string, buildpack string) error
- func (c *BaseClient) SetAppBuildpackIndex(appName string, buildpack string, index int) error
- func (c *BaseClient) SetAppBuildpacksProperty(appName string, property BuildpackProperty, value string) error
- func (c *BaseClient) SetAppConfigValue(appName string, key string, value string, restart bool) error
- func (c *BaseClient) SetAppConfigValues(appName string, config map[string]string, restart bool) error
- func (c *BaseClient) SetAppDefaultResourceLimit(appName string, resource ResourceSpec, limit int) error
- func (c *BaseClient) SetAppDeployChecksSkipped(appName string) error
- func (c *BaseClient) SetAppDockerRegistryProperty(appName string, property DockerRegistryProperty, value string) error
- func (c *BaseClient) SetAppDomains(appName string, domains []string) error
- func (c *BaseClient) SetAppJsonProperty(appName string, property AppJsonProperty, value string) error
- func (c *BaseClient) SetAppLambdaBuilderProperty(appName string, property LambdaBuilderProperty, value string) error
- func (c *BaseClient) SetAppLetsEncryptProperty(appName string, property LetsEncryptProperty, value string) error
- func (c *BaseClient) SetAppNetworkProperty(appName string, property NetworkProperty, value string) error
- func (c *BaseClient) SetAppNginxProperty(appName string, property NginxProperty, value string) error
- func (c *BaseClient) SetAppProcessResourceLimit(appName string, process string, resource ResourceSpec, limit int) error
- func (c *BaseClient) SetAppProcessResourceReservation(appName string, process string, resource ResourceSpec, reserve int) error
- func (c *BaseClient) SetAppProcessScale(appName string, processName string, scale int, skipDeploy bool) (*CommandOutputStream, error)
- func (c *BaseClient) SetAppProcessesDeployChecksSkipped(appName string, processes []string) error
- func (c *BaseClient) SetAppProcfilePath(appName string, procPath string) error
- func (c *BaseClient) SetAppProxyDisabled(appName string) error
- func (c *BaseClient) SetAppProxyEnabled(appName string) error
- func (c *BaseClient) SetAppProxyPorts(appName string, ports []ProxyPortMapping) error
- func (c *BaseClient) SetAppProxyType(appName string, proxyType ProxyType) error
- func (c *BaseClient) SetAppResourceReservation(appName string, resource ResourceSpec, reserve int) error
- func (c *BaseClient) SetAppRestartPolicy(appName string, p RestartPolicy) error
- func (c *BaseClient) SetAppSchedulerProperty(appName string, property SchedulerProperty, value string) error
- func (c *BaseClient) SetAppSelectedBuilder(appName string, builder AppBuilder) error
- func (c *BaseClient) SetEventLoggingEnabled(enabled bool) error
- func (c *BaseClient) SetGlobalBuildpacksProperty(property BuildpackProperty, value string) error
- func (c *BaseClient) SetGlobalConfigValue(key string, value string, restart bool) error
- func (c *BaseClient) SetGlobalConfigValues(config map[string]string, restart bool) error
- func (c *BaseClient) SetGlobalDomains(domains []string) error
- func (c *BaseClient) SetGlobalLambdaBuilderProperty(property LambdaBuilderProperty, value string) error
- func (c *BaseClient) SetGlobalLetsEncryptProperty(property LetsEncryptProperty, value string) error
- func (c *BaseClient) SetGlobalNetworkProperty(property NetworkProperty, value string) error
- func (c *BaseClient) SetGlobalProcfilePath(procPath string) error
- func (c *BaseClient) SetGlobalRestartPolicy(p RestartPolicy) error
- func (c *BaseClient) SetSchedulerDockerLocalProperty(appName string, property DockerLocalSchedulerProperty, value string) error
- func (c *BaseClient) ShowAppCertCRT(appName string) (string, error)
- func (c *BaseClient) ShowAppCertKey(appName string) (string, error)
- func (c *BaseClient) StartAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) StartApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) StopAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) StopApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
- func (c *BaseClient) TailAppLogs(appName string) (io.Reader, error)
- func (c *BaseClient) UnlockApp(name string) error
- func (c *BaseClient) UnmountAppStorage(appName string, mount StorageBindMount) error
- func (c *BaseClient) UnsetAppConfigValue(appName string, key string, restart bool) error
- func (c *BaseClient) UnsetAppConfigValues(appName string, keys []string, restart bool) error
- func (c *BaseClient) UnsetGlobalConfigValue(key string, restart bool) error
- func (c *BaseClient) UnsetGlobalConfigValues(keys []string, restart bool) error
- func (c *BaseClient) UpdateAppCert(appName string, crt string, key string) error
- func (c *BaseClient) ValidateAllNginxConfig(clean bool) error
- func (c *BaseClient) ValidateAppNginxConfig(appName string, clean bool) error
- type BuilderProperty
- type BuildpackProperty
- type CertsReport
- type ChecksReport
- type Client
- type CommandOutputStream
- type ConfigExportFormat
- type CronReport
- type CronTask
- type DockerLocalSchedulerProperty
- type DockerOptionsReport
- type DockerRegistryProperty
- type DockerRegistryReport
- type DockerRunOptions
- type DockerfileProperty
- type DomainsReport
- type ExitCodeError
- type GitAppReport
- type GitArchiveOptions
- type GitAuthorDetails
- type GitImageOptions
- type GitProperty
- type GitReport
- type GitSyncOptions
- type GlobalDomainsReport
- type LambdaBuilderProperty
- type LetsEncryptAppInfo
- type LetsEncryptAppReport
- type LetsEncryptProperty
- type NetworkProperty
- type NetworkReport
- type NginxProperty
- type NginxReport
- type ParallelismOptions
- type PluginInfo
- type ProcessReport
- type ProxyPortMapping
- type ProxyReport
- type ProxyType
- type Resource
- type ResourceReport
- type ResourceSettings
- type ResourceSpec
- type ResourceUnits
- type RestartPolicy
- type SSHClient
- type SSHClientConfig
- type SSHKey
- type SchedulerDockerLocalReport
- type SchedulerProperty
- type SchedulerReport
- type StorageBindMount
- type StorageChownOption
- type StorageReport
Constants ¶
View Source
const ( AppBuilderDockerfile = AppBuilder("dockerfile") AppBuilderHerokuish = AppBuilder("herokuish") AppBuilderLambda = AppBuilder("lambda") AppBuilderNull = AppBuilder("null") AppBuilderPack = AppBuilder("pack") BuilderPropertySelected = BuilderProperty("selected") BuilderPropertyBuildDir = BuilderProperty("build-dir") BuildpackPropertyProjectTomlPath = BuildpackProperty("projecttoml-path") BuildpackPropertyStackBuilder = BuildpackProperty("stack") DockerfilePropertyPath = DockerfileProperty("dockerfile-path") LambdaBuilderPropertyYml = DockerfileProperty("lambdayml-path") )
View Source
const ( ConfigExportFormatShell = ConfigExportFormat("shell") ConfigExportFormatEval = ConfigExportFormat("eval") ConfigExportFormatTarBundle = ConfigExportFormat("tar") )
View Source
const ( DockerRegistryPropertyServer = DockerRegistryProperty("server") DockerRegistryPropertyImageRepo = DockerRegistryProperty("image-repo") DockerRegistryPropertyPushOnRelease = DockerRegistryProperty("push-on-release") )
View Source
const ( GitPropertyDeployBranch = GitProperty("deploy-branch") GitPropertyRevEnvVar = GitProperty("rev-env-var") GitPropertyKeepGitDir = GitProperty("keep-git-dir") )
View Source
const ( LetsEncryptPropertyDnsProvider = LetsEncryptProperty("dns-provider") LetsEncryptPropertyEmail = LetsEncryptProperty("email") LetsEncryptPropertyGracePeriod = LetsEncryptProperty("graceperiod") LetsEncryptPropertyLegoDockerArgs = LetsEncryptProperty("lego-docker-args") LetsEncryptPropertyServer = LetsEncryptProperty("server") )
View Source
const ( NetworkPropertyStaticWebListener = NetworkProperty("static-web-listener") NetworkPropertyTLD = NetworkProperty("tld") NetworkPropertyBindAllInterfaces = NetworkProperty("bind-all-interfaces") NetworkPropertyInitialNetwork = NetworkProperty("initial-network") NetworkPropertyAttachPostCreate = NetworkProperty("attach-post-create") NetworkPropertyAttachPostDeploy = NetworkProperty("attach-post-deploy") )
View Source
const ( NginxPropertyBindAddressIPv4 = NginxProperty("bind-address-ipv4") NginxPropertyBindAddressIPv6 = NginxProperty("bind-address-ipv6") NginxPropertyHSTSHeader = NginxProperty("hsts") NginxPropertyAccessLogPath = NginxProperty("access-log-path") // check /etc/nginx/conf.d/00-log-formats.conf NginxPropertyAccessLogFormat = NginxProperty("access-log-format") NginxPropertyErrorLogPath = NginxProperty("error-log-path") NginxPropertyProxyReadTimeout = NginxProperty("proxy-read-timeout") NginxPropertyClientMaxBodySize = NginxProperty("client-max-body-size") NginxDisableCustomConfig = NginxProperty("disable-custom-config") )
View Source
const ( SchedulerPropertySelected = SchedulerProperty("selected") DockerLocalSchedulerPropertyDisableChown = DockerLocalSchedulerProperty("disable-chown") DockerLocalSchedulerPropertyParallelScheduleCount = DockerLocalSchedulerProperty("parallel-schedule-count") )
View Source
const ( StorageChownOptionHerokuish = StorageChownOption("herokuish") StorageChownOptionHeroku = StorageChownOption("heroku") StorageChownOptionPacketo = StorageChownOption("packeto") StorageChownOptionNone = StorageChownOption("false") )
View Source
const (
AppJsonPropertyPath = AppJsonProperty("appjson-path")
)
View Source
const (
ProxyTypeNginx = ProxyType("nginx")
)
Variables ¶
View Source
var ( InvalidAppError = errors.New("app does not exist") AppNotDeployedError = errors.New("app is not deployed") NoDeployedAppsError = errors.New("no apps have been deployed") NotImplementedError = errors.New("method not implemented") UnexpectedMessageError = errors.New("unexpected confirmation message") NameTakenError = errors.New("app name already in use") )
View Source
var ( RestartPolicyAlways = restartPolicy{/* contains filtered or unexported fields */} RestartPolicyNever = restartPolicy{/* contains filtered or unexported fields */} RestartPolicyUnlessStopped = restartPolicy{/* contains filtered or unexported fields */} RestartPolicyOnFailure = restartPolicy{/* contains filtered or unexported fields */} )
View Source
var ( ResourceCPU = ResourceSpec{"cpu", ""} ResourceMemoryBytes = ResourceSpec{"memory", "b"} ResourceMemoryKilobytes = ResourceSpec{"memory", "k"} ResourceMemoryMegabytes = ResourceSpec{"memory", "m"} ResourceMemoryGigabytes = ResourceSpec{"memory", "g"} ResourceMemorySwapBytes = ResourceSpec{"memory-swap", "b"} ResourceMemorySwapKilobytes = ResourceSpec{"memory-swap", "k"} ResourceMemorySwapMegabytes = ResourceSpec{"memory-swap", "m"} ResourceMemorySwapGigabytes = ResourceSpec{"memory-swap", "g"} ResourceNetwork = ResourceSpec{"network", ""} ResourceNetworkIngress = ResourceSpec{"network-ingress", ""} ResourceNetworkEgress = ResourceSpec{"network-egress", ""} ResourceNvidiaGPU = ResourceSpec{"nvidia-gpu", ""} )
View Source
var (
InvalidPrivateKeyError = errors.New("invalid private key")
)
View Source
var (
NginxNoConfigErr = errors.New("no nginx.conf exists for app")
)
Functions ¶
This section is empty.
Types ¶
type AppAppJsonReport ¶
type AppBuilder ¶
type AppBuilder string
type AppBuilderPackReport ¶
type AppBuilderReport ¶
type AppBuilderReport struct { BuildDir string `dokku:"Builder build dir"` ComputedBuildDir string `dokku:"Builder computed build dir"` GlobalBuildDir string `dokku:"Builder global build dir"` SelectedBuilder string `dokku:"Builder selected"` ComputedSelectedBuilder string `dokku:"Builder computed selected"` GlobalSelectedBuilder string `dokku:"Builder global selected"` }
type AppBuildpacksReport ¶
type AppCertsReport ¶
type AppCertsReport struct { Dir string `dokku:"Ssl dir"` Enabled bool `dokku:"Ssl enabled"` Verified string `dokku:"Ssl verified"` StartsAt string `dokku:"Ssl starts at"` ExpiresAt string `dokku:"Ssl expires at"` Hostnames string `dokku:"Ssl hostnames"` Issuer string `dokku:"Ssl issuer"` Subject string `dokku:"Ssl subject"` }
type AppChecksReport ¶
type AppCronReport ¶
type AppCronReport struct {
TaskCount int `dokku:"Cron task count"`
}
type AppDockerOptionsReport ¶
type AppDockerRegistryReport ¶
type AppDockerRegistryReport struct { ImageRepo string `dokku:"Registry image repo"` ComputedImageRepo string `dokku:"Registry computed image repo"` PushOnRelease string `dokku:"Registry push on release"` GlobalPushOnRelease bool `dokku:"Registry global push on release"` ComputedPushOnRelease bool `dokku:"Registry computed push on release"` Server string `dokku:"Registry server"` GlobalServer string `dokku:"Registry global server"` ComputedServer string `dokku:"Registry computed server"` TagVersion string `dokku:"Registry tag version"` }
type AppDomainsReport ¶
type AppJsonProperty ¶
type AppJsonProperty string
type AppJsonReport ¶
type AppJsonReport map[string]*AppAppJsonReport
type AppLambdaBuilderReport ¶
type AppManagementOptions ¶
type AppNetworkReport ¶
type AppNetworkReport struct { AttachPostCreate string `dokku:"Network attach post create"` GlobalAttachPostCreate string `dokku:"Network global attach post create"` ComputedAttachPostCreate string `dokku:"Network computed attach post create"` AttachPostDeploy string `dokku:"Network attach post deploy"` GlobalAttachPostDeploy string `dokku:"Network global attach post deploy"` ComputedAttachPostDeploy string `dokku:"Network computed attach post deploy"` BindAllInterfaces bool `dokku:"Network bind all interfaces"` GlobalBindAllInterfaces bool `dokku:"Network global bind all interfaces"` ComputedBindAllInterfaces bool `dokku:"Network computed bind all interfaces"` InitialNetwork string `dokku:"Network initial network"` GlobalInitialNetwork bool `dokku:"Network global initial network"` ComputedInitialNetwork string `dokku:"Network computed initial network"` TLD string `dokku:"Network tld"` GlobalTLD string `dokku:"Network global tld"` ComputedTLD string `dokku:"Network computed tld"` WebListeners string `dokku:"Network web listeners"` }
type AppNginxReport ¶
type AppNginxReport struct { AccessLogFormat string `dokku:"Nginx access log format"` AccessLogPath string `dokku:"Nginx access log path"` BindAddressIPv4 string `dokku:"Nginx bind address ipv4"` BindAddressIPv6 string `dokku:"Nginx bind address ipv6"` ClientMaxBodySize int `dokku:"Nginx client max body size"` DisableCustomConfig bool `dokku:"Nginx disable custom config"` ErrorLogPath string `dokku:"Nginx error log path"` GlobalHSTS bool `dokku:"Nginx global hsts"` ComputedHSTS bool `dokku:"Nginx computed hsts"` HSTS bool `dokku:"Nginx hsts"` HSTSIncludeSubdomains bool `dokku:"Nginx hsts include subdomains"` HSTSMaxAge int `dokku:"Nginx hsts max age"` HSTSPreload bool `dokku:"Nginx hsts preload"` ProxyBufferSize int `dokku:"Nginx proxy buffer size"` ProxyBuffering string `dokku:"Nginx proxy buffering"` ProxyBuffers string `dokku:"Nginx proxy buffers"` ProxyBusyBuffersSize int `dokku:"Nginx proxy busy buffers size"` ProxyReadTimeout string `dokku:"Nginx proxy read timeout"` LastVisitedAt string `dokku:"Nginx last visited at"` XForwardedForValue string `dokku:"Nginx x forwarded for value"` XForwardedPortValue string `dokku:"Nginx x forwarded port value"` XForwardedProtoValue string `dokku:"Nginx x forwarded proto value"` XForwardedSSL bool `dokku:"Nginx x forwarded ssl"` }
type AppProcessReport ¶
type AppProcessReport struct { Deployed bool `json:"deployed" dokku:"Deployed"` Processes int `json:"processes" dokku:"Processes"` CanScale bool `json:"can_scale" dokku:"Ps can scale"` ComputedProcfilePath string `json:"computed_procfile_path" dokku:"Ps computed procfile path"` GlobalProcfilePath string `json:"global_procfile_path" dokku:"Ps global procfile path"` ProcfilePath string `json:"procfile_path" dokku:"Ps procfile path"` RestartPolicy string `json:"restart_policy" dokku:"Ps restart policy"` Restore bool `json:"restore" dokku:"Restore"` Running bool `json:"running" dokku:"Running"` }
type AppProxyReport ¶
type AppResourceReport ¶
type AppResourceReport struct { Defaults ResourceSettings `json:"defaults"` Processes map[string]ResourceSettings `json:"processes"` }
type AppSchedulerReport ¶
type AppStorageReport ¶
type AppStorageReport struct { BuildMounts []StorageBindMount DeployMounts []StorageBindMount RunMounts []StorageBindMount }
type AppsReport ¶
type BaseClient ¶
type BaseClient struct {
// contains filtered or unexported fields
}
func (*BaseClient) AddAppBuildpack ¶
func (c *BaseClient) AddAppBuildpack(appName string, buildpack string) error
func (*BaseClient) AddAppBuildpackAtIndex ¶
func (c *BaseClient) AddAppBuildpackAtIndex(appName string, buildpack string, index int) error
func (*BaseClient) AddAppCert ¶
func (c *BaseClient) AddAppCert(appName string, crt string, key string) error
func (*BaseClient) AddAppDomain ¶
func (c *BaseClient) AddAppDomain(appName string, domain string) error
func (*BaseClient) AddAppPhaseDockerOption ¶
func (c *BaseClient) AddAppPhaseDockerOption(appName string, phase string, option string) error
func (*BaseClient) AddAppProxyPort ¶
func (c *BaseClient) AddAppProxyPort(appName string, port ProxyPortMapping) error
func (*BaseClient) AddAppProxyPorts ¶
func (c *BaseClient) AddAppProxyPorts(appName string, ports []ProxyPortMapping) error
func (*BaseClient) AddGlobalDomain ¶
func (c *BaseClient) AddGlobalDomain(domain string) error
func (*BaseClient) AddLetsEncryptCronJob ¶
func (c *BaseClient) AddLetsEncryptCronJob() error
func (*BaseClient) BuildAllProxyConfig ¶
func (c *BaseClient) BuildAllProxyConfig(parallel *ParallelismOptions) error
func (*BaseClient) BuildAppProxyConfig ¶
func (c *BaseClient) BuildAppProxyConfig(appName string, parallel *ParallelismOptions) error
func (*BaseClient) CheckAppExists ¶
func (c *BaseClient) CheckAppExists(name string) (bool, error)
func (*BaseClient) CheckNetworkExists ¶
func (c *BaseClient) CheckNetworkExists(name string) (bool, error)
func (*BaseClient) ClearAllProxyConfig ¶
func (c *BaseClient) ClearAllProxyConfig() error
func (*BaseClient) ClearAppBuildpacks ¶
func (c *BaseClient) ClearAppBuildpacks(appName string) error
func (*BaseClient) ClearAppConfig ¶
func (c *BaseClient) ClearAppConfig(appName string, restart bool) error
func (*BaseClient) ClearAppDefaultResourceLimit ¶
func (c *BaseClient) ClearAppDefaultResourceLimit(appName string, resource ResourceSpec) error
func (*BaseClient) ClearAppDefaultResourceLimits ¶
func (c *BaseClient) ClearAppDefaultResourceLimits(appName string) error
func (*BaseClient) ClearAppDockerRegistryProperty ¶
func (c *BaseClient) ClearAppDockerRegistryProperty(appName string, property DockerRegistryProperty) error
func (*BaseClient) ClearAppDomains ¶
func (c *BaseClient) ClearAppDomains(appName string) error
func (*BaseClient) ClearAppLetsEncryptProperty ¶
func (c *BaseClient) ClearAppLetsEncryptProperty(appName string, property LetsEncryptProperty) error
func (*BaseClient) ClearAppPhaseDockerOptions ¶
func (c *BaseClient) ClearAppPhaseDockerOptions(appName string, phase string) error
func (*BaseClient) ClearAppProcessResourceLimit ¶
func (c *BaseClient) ClearAppProcessResourceLimit(appName string, process string, resource ResourceSpec) error
func (*BaseClient) ClearAppProcessResourceLimits ¶
func (c *BaseClient) ClearAppProcessResourceLimits(appName string, process string) error
func (*BaseClient) ClearAppProcessResourceReservation ¶
func (c *BaseClient) ClearAppProcessResourceReservation(appName string, process string, resource ResourceSpec) error
func (*BaseClient) ClearAppProcessResourceReservations ¶
func (c *BaseClient) ClearAppProcessResourceReservations(appName string, process string) error
func (*BaseClient) ClearAppProxyConfig ¶
func (c *BaseClient) ClearAppProxyConfig(appName string) error
func (*BaseClient) ClearAppProxyPorts ¶
func (c *BaseClient) ClearAppProxyPorts(appName string) error
func (*BaseClient) ClearAppResourceReservation ¶
func (c *BaseClient) ClearAppResourceReservation(appName string, resource ResourceSpec) error
func (*BaseClient) ClearAppResourceReservations ¶
func (c *BaseClient) ClearAppResourceReservations(appName string) error
func (*BaseClient) ClearGlobalConfig ¶
func (c *BaseClient) ClearGlobalConfig(restart bool) error
func (*BaseClient) ClearGlobalDomains ¶
func (c *BaseClient) ClearGlobalDomains() error
func (*BaseClient) ClearGlobalLetsEncryptProperty ¶
func (c *BaseClient) ClearGlobalLetsEncryptProperty(property LetsEncryptProperty) error
func (*BaseClient) CloneApp ¶
func (c *BaseClient) CloneApp(oldName string, newName string, opts *AppManagementOptions) error
func (*BaseClient) CreateApp ¶
func (c *BaseClient) CreateApp(name string) error
func (*BaseClient) CreateNetwork ¶
func (c *BaseClient) CreateNetwork(name string) error
func (*BaseClient) DestroyApp ¶
func (c *BaseClient) DestroyApp(name string) error
func (*BaseClient) DestroyNetwork ¶
func (c *BaseClient) DestroyNetwork(name string) error
func (*BaseClient) DisableAppDeployChecks ¶
func (c *BaseClient) DisableAppDeployChecks(appName string) error
func (*BaseClient) DisableAppDomains ¶
func (c *BaseClient) DisableAppDomains(appName string) error
func (*BaseClient) DisableAppLetsEncrypt ¶
func (c *BaseClient) DisableAppLetsEncrypt(appName string) error
func (*BaseClient) DisableAppProcessesDeployChecks ¶
func (c *BaseClient) DisableAppProcessesDeployChecks(appName string, processes []string) error
func (*BaseClient) DockerCleanup ¶
func (c *BaseClient) DockerCleanup(appName string) error
func (*BaseClient) DockerCleanupAll ¶
func (c *BaseClient) DockerCleanupAll() error
func (*BaseClient) EnableAppDeployChecks ¶
func (c *BaseClient) EnableAppDeployChecks(appName string) error
func (*BaseClient) EnableAppDomains ¶
func (c *BaseClient) EnableAppDomains(appName string) error
func (*BaseClient) EnableAppLetsEncrypt ¶
func (c *BaseClient) EnableAppLetsEncrypt(appName string) error
func (*BaseClient) EnableAppProcessesDeployChecks ¶
func (c *BaseClient) EnableAppProcessesDeployChecks(appName string, processes []string) error
func (*BaseClient) EnsureStorageDirectory ¶
func (c *BaseClient) EnsureStorageDirectory(directory string, chown StorageChownOption) error
func (*BaseClient) ExecStreaming ¶
func (c *BaseClient) ExecStreaming(command string) (*CommandOutputStream, error)
func (*BaseClient) ExecWithInput ¶
func (*BaseClient) ExecWithInputStreaming ¶
func (c *BaseClient) ExecWithInputStreaming(command string, input io.Reader) (*CommandOutputStream, error)
func (*BaseClient) ExportAppConfig ¶
func (c *BaseClient) ExportAppConfig(appName string, format ConfigExportFormat) (string, error)
func (*BaseClient) ExportGlobalConfig ¶
func (c *BaseClient) ExportGlobalConfig(format ConfigExportFormat) (string, error)
func (*BaseClient) GenerateAppCert ¶
func (c *BaseClient) GenerateAppCert(appName string, domain string) error
func (*BaseClient) GetAllAppCronReport ¶
func (c *BaseClient) GetAllAppCronReport() (CronReport, error)
func (*BaseClient) GetAllAppJsonReport ¶
func (c *BaseClient) GetAllAppJsonReport() (AppJsonReport, error)
func (*BaseClient) GetAllAppProxyReport ¶
func (c *BaseClient) GetAllAppProxyReport() (ProxyReport, error)
func (*BaseClient) GetAllAppReport ¶
func (c *BaseClient) GetAllAppReport() (AppsReport, error)
func (*BaseClient) GetAllFailedDeployLogs ¶
func (c *BaseClient) GetAllFailedDeployLogs() (string, error)
func (*BaseClient) GetAllProcessReport ¶
func (c *BaseClient) GetAllProcessReport() (ProcessReport, error)
func (*BaseClient) GetAppBuilderDockerfileReport ¶
func (c *BaseClient) GetAppBuilderDockerfileReport(appName string) (*AppBuilderDockerfileReport, error)
func (*BaseClient) GetAppBuilderPackReport ¶
func (c *BaseClient) GetAppBuilderPackReport(appName string) (*AppBuilderPackReport, error)
func (*BaseClient) GetAppBuilderReport ¶
func (c *BaseClient) GetAppBuilderReport(appName string) (*AppBuilderReport, error)
func (*BaseClient) GetAppBuildpacksReport ¶
func (c *BaseClient) GetAppBuildpacksReport(appName string) (*AppBuildpacksReport, error)
func (*BaseClient) GetAppCertsReport ¶
func (c *BaseClient) GetAppCertsReport(appName string) (*AppCertsReport, error)
func (*BaseClient) GetAppConfig ¶
func (c *BaseClient) GetAppConfig(appName string) (map[string]string, error)
func (*BaseClient) GetAppConfigKeys ¶
func (c *BaseClient) GetAppConfigKeys(appName string) ([]string, error)
func (*BaseClient) GetAppConfigValue ¶
func (*BaseClient) GetAppCronReport ¶
func (c *BaseClient) GetAppCronReport(appName string) (*AppCronReport, error)
func (*BaseClient) GetAppDeployChecksReport ¶
func (c *BaseClient) GetAppDeployChecksReport(appName string) (*AppChecksReport, error)
func (*BaseClient) GetAppDockerOptionsReport ¶
func (c *BaseClient) GetAppDockerOptionsReport(appName string) (*AppDockerOptionsReport, error)
func (*BaseClient) GetAppDockerRegistryReport ¶
func (c *BaseClient) GetAppDockerRegistryReport(appName string) (*AppDockerRegistryReport, error)
func (*BaseClient) GetAppDomainsReport ¶
func (c *BaseClient) GetAppDomainsReport(appName string) (*AppDomainsReport, error)
func (*BaseClient) GetAppFailedDeployLogs ¶
func (c *BaseClient) GetAppFailedDeployLogs(appName string) (string, error)
func (*BaseClient) GetAppJsonReport ¶
func (c *BaseClient) GetAppJsonReport(appName string) (*AppAppJsonReport, error)
func (*BaseClient) GetAppLambdaBuilderReport ¶
func (c *BaseClient) GetAppLambdaBuilderReport(appName string) (*AppLambdaBuilderReport, error)
func (*BaseClient) GetAppLetsEncryptEnabled ¶
func (c *BaseClient) GetAppLetsEncryptEnabled(appName string) (bool, error)
func (*BaseClient) GetAppLogs ¶
func (c *BaseClient) GetAppLogs(appName string) (string, error)
func (*BaseClient) GetAppNetworkReport ¶
func (c *BaseClient) GetAppNetworkReport(appName string) (*AppNetworkReport, error)
func (*BaseClient) GetAppNginxAccessLogs ¶
func (c *BaseClient) GetAppNginxAccessLogs(appName string) (string, error)
func (*BaseClient) GetAppNginxConfig ¶
func (c *BaseClient) GetAppNginxConfig(appName string) (string, error)
func (*BaseClient) GetAppNginxErrorLogs ¶
func (c *BaseClient) GetAppNginxErrorLogs(appName string) (string, error)
func (*BaseClient) GetAppNginxReport ¶
func (c *BaseClient) GetAppNginxReport(appName string) (*AppNginxReport, error)
func (*BaseClient) GetAppProcessLogs ¶
func (c *BaseClient) GetAppProcessLogs(appName, process string) (string, error)
func (*BaseClient) GetAppProcessReport ¶
func (c *BaseClient) GetAppProcessReport(appName string) (*AppProcessReport, error)
func (*BaseClient) GetAppProcessScale ¶
func (c *BaseClient) GetAppProcessScale(appName string) (map[string]int, error)
func (*BaseClient) GetAppProxyPortMappings ¶
func (c *BaseClient) GetAppProxyPortMappings(appName string) ([]ProxyPortMapping, error)
func (*BaseClient) GetAppProxyReport ¶
func (c *BaseClient) GetAppProxyReport(appName string) (*AppProxyReport, error)
func (*BaseClient) GetAppReport ¶
func (c *BaseClient) GetAppReport(name string) (*AppReport, error)
func (*BaseClient) GetAppResourceReport ¶
func (c *BaseClient) GetAppResourceReport(appName string) (*AppResourceReport, error)
func (*BaseClient) GetAppSchedulerDockerLocalReport ¶
func (c *BaseClient) GetAppSchedulerDockerLocalReport(appName string) (*AppSchedulerDockerLocalReport, error)
func (*BaseClient) GetAppSchedulerReport ¶
func (c *BaseClient) GetAppSchedulerReport(appName string) (*AppSchedulerReport, error)
func (*BaseClient) GetAppStorageReport ¶
func (c *BaseClient) GetAppStorageReport(appName string) (*AppStorageReport, error)
func (*BaseClient) GetCertsReport ¶
func (c *BaseClient) GetCertsReport() (CertsReport, error)
func (*BaseClient) GetDeployChecksReport ¶
func (c *BaseClient) GetDeployChecksReport() (ChecksReport, error)
func (*BaseClient) GetDockerRegistryReport ¶
func (c *BaseClient) GetDockerRegistryReport() (DockerRegistryReport, error)
func (*BaseClient) GetDokkuVersion ¶
func (c *BaseClient) GetDokkuVersion() (string, error)
func (*BaseClient) GetDomainsReport ¶
func (c *BaseClient) GetDomainsReport() (DomainsReport, error)
func (*BaseClient) GetEventLogs ¶
func (c *BaseClient) GetEventLogs() (string, error)
func (*BaseClient) GetGlobalConfig ¶
func (c *BaseClient) GetGlobalConfig() (map[string]string, error)
func (*BaseClient) GetGlobalConfigKeys ¶
func (c *BaseClient) GetGlobalConfigKeys() ([]string, error)
func (*BaseClient) GetGlobalConfigValue ¶
func (c *BaseClient) GetGlobalConfigValue(key string, quoted bool) (string, error)
func (*BaseClient) GetGlobalDockerOptionsReport ¶
func (c *BaseClient) GetGlobalDockerOptionsReport() (DockerOptionsReport, error)
func (*BaseClient) GetGlobalDomainsReport ¶
func (c *BaseClient) GetGlobalDomainsReport() (*GlobalDomainsReport, error)
func (*BaseClient) GetGlobalNginxReport ¶
func (c *BaseClient) GetGlobalNginxReport() (NginxReport, error)
func (*BaseClient) GetLetsEncryptAppList ¶
func (c *BaseClient) GetLetsEncryptAppList() ([]LetsEncryptAppInfo, error)
func (*BaseClient) GetLetsEncryptAppReport ¶
func (c *BaseClient) GetLetsEncryptAppReport(appName string) (*LetsEncryptAppReport, error)
func (*BaseClient) GetLetsEncryptCronJobEnabled ¶
func (c *BaseClient) GetLetsEncryptCronJobEnabled() (bool, error)
func (*BaseClient) GetNAppLogs ¶
func (c *BaseClient) GetNAppLogs(appName string, numLines int) (string, error)
func (*BaseClient) GetNetworkInfo ¶
func (c *BaseClient) GetNetworkInfo(name string) (interface{}, error)
func (*BaseClient) GetNetworkReport ¶
func (c *BaseClient) GetNetworkReport() (NetworkReport, error)
func (*BaseClient) GetProcessInfo ¶
func (c *BaseClient) GetProcessInfo(appName string) error
func (*BaseClient) GetResourceReport ¶
func (c *BaseClient) GetResourceReport() (ResourceReport, error)
func (*BaseClient) GetSchedulerDockerLocalReport ¶
func (c *BaseClient) GetSchedulerDockerLocalReport() (SchedulerDockerLocalReport, error)
func (*BaseClient) GetSchedulerReport ¶
func (c *BaseClient) GetSchedulerReport() (SchedulerReport, error)
func (*BaseClient) GetStorageReport ¶
func (c *BaseClient) GetStorageReport() (StorageReport, error)
func (*BaseClient) GitAllowHost ¶
func (c *BaseClient) GitAllowHost(host string) error
func (*BaseClient) GitCreateFromArchive ¶
func (c *BaseClient) GitCreateFromArchive(appName string, url string, opt *GitArchiveOptions) (*CommandOutputStream, error)
func (*BaseClient) GitCreateFromImage ¶
func (c *BaseClient) GitCreateFromImage(appName string, image string, opt *GitImageOptions) (*CommandOutputStream, error)
func (*BaseClient) GitGetAppReport ¶
func (c *BaseClient) GitGetAppReport(appName string) (*GitAppReport, error)
func (*BaseClient) GitGetPublicKey ¶
func (c *BaseClient) GitGetPublicKey() (string, error)
func (*BaseClient) GitGetReport ¶
func (c *BaseClient) GitGetReport() (GitReport, error)
func (*BaseClient) GitInitializeApp ¶
func (c *BaseClient) GitInitializeApp(appName string) error
func (*BaseClient) GitPurgeRepoCache ¶
func (c *BaseClient) GitPurgeRepoCache(appName string) error
func (*BaseClient) GitRemoveAppProperty ¶
func (c *BaseClient) GitRemoveAppProperty(appName string, property GitProperty) error
func (*BaseClient) GitRemoveAuth ¶
func (c *BaseClient) GitRemoveAuth(host string) error
func (*BaseClient) GitRunRepoGC ¶
func (c *BaseClient) GitRunRepoGC(appName string) error
func (*BaseClient) GitSetAppProperty ¶
func (c *BaseClient) GitSetAppProperty(appName string, property GitProperty, val string) error
func (*BaseClient) GitSetAuth ¶
func (c *BaseClient) GitSetAuth(host string, username string, password string) error
func (*BaseClient) GitSyncAppRepo ¶
func (c *BaseClient) GitSyncAppRepo(appName string, repo string, opt *GitSyncOptions) (*CommandOutputStream, error)
func (*BaseClient) GitUnlockApp ¶
func (c *BaseClient) GitUnlockApp(appName string, force bool) error
func (*BaseClient) LetsEncryptAutoRenew ¶
func (c *BaseClient) LetsEncryptAutoRenew() error
func (*BaseClient) LetsEncryptAutoRenewApp ¶
func (c *BaseClient) LetsEncryptAutoRenewApp(appName string) error
func (*BaseClient) LetsEncryptCleanup ¶
func (c *BaseClient) LetsEncryptCleanup(appName string) error
func (*BaseClient) ListAppBuildpacks ¶
func (c *BaseClient) ListAppBuildpacks(appName string) ([]string, error)
func (*BaseClient) ListAppCronTasks ¶
func (c *BaseClient) ListAppCronTasks(appName string) ([]CronTask, error)
func (*BaseClient) ListAppRunContainers ¶
func (c *BaseClient) ListAppRunContainers(appName string) ([]string, error)
TODO: implement
func (*BaseClient) ListAppStorage ¶
func (c *BaseClient) ListAppStorage(appName string) ([]StorageBindMount, error)
func (*BaseClient) ListApps ¶
func (c *BaseClient) ListApps() ([]string, error)
func (*BaseClient) ListLoggedEvents ¶
func (c *BaseClient) ListLoggedEvents() ([]string, error)
func (*BaseClient) ListNetworks ¶
func (c *BaseClient) ListNetworks() ([]string, error)
func (*BaseClient) ListPlugins ¶
func (c *BaseClient) ListPlugins() ([]PluginInfo, error)
func (*BaseClient) ListSSHKeys ¶
func (c *BaseClient) ListSSHKeys() ([]SSHKey, error)
func (*BaseClient) ListSSHKeysForName ¶
func (c *BaseClient) ListSSHKeysForName(name string) ([]SSHKey, error)
func (*BaseClient) LockApp ¶
func (c *BaseClient) LockApp(name string) error
func (*BaseClient) LoginDockerRegistry ¶
func (c *BaseClient) LoginDockerRegistry(server string, username string, password string) error
func (*BaseClient) MountAppStorage ¶
func (c *BaseClient) MountAppStorage(appName string, mount StorageBindMount) error
func (*BaseClient) RebuildAllApps ¶
func (c *BaseClient) RebuildAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) RebuildAllNetworks ¶
func (c *BaseClient) RebuildAllNetworks() error
func (*BaseClient) RebuildApp ¶
func (c *BaseClient) RebuildApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) RebuildNetwork ¶
func (c *BaseClient) RebuildNetwork(name string) error
func (*BaseClient) RemoveAppBuildpack ¶
func (c *BaseClient) RemoveAppBuildpack(appName string, buildpack string) error
func (*BaseClient) RemoveAppCerts ¶
func (c *BaseClient) RemoveAppCerts(appName string) error
func (*BaseClient) RemoveAppDomain ¶
func (c *BaseClient) RemoveAppDomain(appName string, domain string) error
func (*BaseClient) RemoveAppNetworkProperty ¶
func (c *BaseClient) RemoveAppNetworkProperty(appName string, property NetworkProperty) error
func (*BaseClient) RemoveAppPhaseDockerOption ¶
func (c *BaseClient) RemoveAppPhaseDockerOption(appName string, phase string, option string) error
func (*BaseClient) RemoveAppProxyPort ¶
func (c *BaseClient) RemoveAppProxyPort(appName string, port ProxyPortMapping) error
func (*BaseClient) RemoveAppProxyPorts ¶
func (c *BaseClient) RemoveAppProxyPorts(appName string, ports []ProxyPortMapping) error
func (*BaseClient) RemoveGlobalDomain ¶
func (c *BaseClient) RemoveGlobalDomain(domain string) error
func (*BaseClient) RemoveGlobalNetworkProperty ¶
func (c *BaseClient) RemoveGlobalNetworkProperty(property NetworkProperty) error
func (*BaseClient) RemoveLetsEncryptCronJob ¶
func (c *BaseClient) RemoveLetsEncryptCronJob() error
func (*BaseClient) RemoveSSHKeyByFingerprint ¶
func (c *BaseClient) RemoveSSHKeyByFingerprint(fingerprint string) error
func (*BaseClient) RemoveSSHKeyByName ¶
func (c *BaseClient) RemoveSSHKeyByName(name string) error
func (*BaseClient) RenameApp ¶
func (c *BaseClient) RenameApp(oldName string, newName string, opts *AppManagementOptions) error
func (*BaseClient) RestartAllApps ¶
func (c *BaseClient) RestartAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) RestartApp ¶
func (c *BaseClient) RestartApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) RestartAppProcess ¶
func (c *BaseClient) RestartAppProcess(appName string, process string, p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) RevokeAppLetsEncryptCertificate ¶
func (c *BaseClient) RevokeAppLetsEncryptCertificate(appName string) error
func (*BaseClient) RunAppCommand ¶
func (c *BaseClient) RunAppCommand(appName string, runCmd string, options *DockerRunOptions) (string, error)
func (*BaseClient) SetAppBuilderDockerfileProperty ¶
func (c *BaseClient) SetAppBuilderDockerfileProperty(appName string, property DockerfileProperty, value string) error
func (*BaseClient) SetAppBuilderPackProperty ¶
func (c *BaseClient) SetAppBuilderPackProperty(appName string, property BuildpackProperty, value string) error
func (*BaseClient) SetAppBuilderProperty ¶
func (c *BaseClient) SetAppBuilderProperty(appName string, property BuilderProperty, value string) error
func (*BaseClient) SetAppBuildpack ¶
func (c *BaseClient) SetAppBuildpack(appName string, buildpack string) error
func (*BaseClient) SetAppBuildpackIndex ¶
func (c *BaseClient) SetAppBuildpackIndex(appName string, buildpack string, index int) error
func (*BaseClient) SetAppBuildpacksProperty ¶
func (c *BaseClient) SetAppBuildpacksProperty(appName string, property BuildpackProperty, value string) error
func (*BaseClient) SetAppConfigValue ¶
func (*BaseClient) SetAppConfigValues ¶
func (*BaseClient) SetAppDefaultResourceLimit ¶
func (c *BaseClient) SetAppDefaultResourceLimit(appName string, resource ResourceSpec, limit int) error
func (*BaseClient) SetAppDeployChecksSkipped ¶
func (c *BaseClient) SetAppDeployChecksSkipped(appName string) error
func (*BaseClient) SetAppDockerRegistryProperty ¶
func (c *BaseClient) SetAppDockerRegistryProperty(appName string, property DockerRegistryProperty, value string) error
func (*BaseClient) SetAppDomains ¶
func (c *BaseClient) SetAppDomains(appName string, domains []string) error
func (*BaseClient) SetAppJsonProperty ¶
func (c *BaseClient) SetAppJsonProperty(appName string, property AppJsonProperty, value string) error
func (*BaseClient) SetAppLambdaBuilderProperty ¶
func (c *BaseClient) SetAppLambdaBuilderProperty(appName string, property LambdaBuilderProperty, value string) error
func (*BaseClient) SetAppLetsEncryptProperty ¶
func (c *BaseClient) SetAppLetsEncryptProperty(appName string, property LetsEncryptProperty, value string) error
func (*BaseClient) SetAppNetworkProperty ¶
func (c *BaseClient) SetAppNetworkProperty(appName string, property NetworkProperty, value string) error
func (*BaseClient) SetAppNginxProperty ¶
func (c *BaseClient) SetAppNginxProperty(appName string, property NginxProperty, value string) error
func (*BaseClient) SetAppProcessResourceLimit ¶
func (c *BaseClient) SetAppProcessResourceLimit(appName string, process string, resource ResourceSpec, limit int) error
func (*BaseClient) SetAppProcessResourceReservation ¶
func (c *BaseClient) SetAppProcessResourceReservation(appName string, process string, resource ResourceSpec, reserve int) error
func (*BaseClient) SetAppProcessScale ¶
func (c *BaseClient) SetAppProcessScale(appName string, processName string, scale int, skipDeploy bool) (*CommandOutputStream, error)
func (*BaseClient) SetAppProcessesDeployChecksSkipped ¶
func (c *BaseClient) SetAppProcessesDeployChecksSkipped(appName string, processes []string) error
func (*BaseClient) SetAppProcfilePath ¶
func (c *BaseClient) SetAppProcfilePath(appName string, procPath string) error
func (*BaseClient) SetAppProxyDisabled ¶
func (c *BaseClient) SetAppProxyDisabled(appName string) error
func (*BaseClient) SetAppProxyEnabled ¶
func (c *BaseClient) SetAppProxyEnabled(appName string) error
func (*BaseClient) SetAppProxyPorts ¶
func (c *BaseClient) SetAppProxyPorts(appName string, ports []ProxyPortMapping) error
func (*BaseClient) SetAppProxyType ¶
func (c *BaseClient) SetAppProxyType(appName string, proxyType ProxyType) error
func (*BaseClient) SetAppResourceReservation ¶
func (c *BaseClient) SetAppResourceReservation(appName string, resource ResourceSpec, reserve int) error
func (*BaseClient) SetAppRestartPolicy ¶
func (c *BaseClient) SetAppRestartPolicy(appName string, p RestartPolicy) error
func (*BaseClient) SetAppSchedulerProperty ¶
func (c *BaseClient) SetAppSchedulerProperty(appName string, property SchedulerProperty, value string) error
func (*BaseClient) SetAppSelectedBuilder ¶
func (c *BaseClient) SetAppSelectedBuilder(appName string, builder AppBuilder) error
func (*BaseClient) SetEventLoggingEnabled ¶
func (c *BaseClient) SetEventLoggingEnabled(enabled bool) error
func (*BaseClient) SetGlobalBuildpacksProperty ¶
func (c *BaseClient) SetGlobalBuildpacksProperty(property BuildpackProperty, value string) error
func (*BaseClient) SetGlobalConfigValue ¶
func (c *BaseClient) SetGlobalConfigValue(key string, value string, restart bool) error
func (*BaseClient) SetGlobalConfigValues ¶
func (c *BaseClient) SetGlobalConfigValues(config map[string]string, restart bool) error
func (*BaseClient) SetGlobalDomains ¶
func (c *BaseClient) SetGlobalDomains(domains []string) error
func (*BaseClient) SetGlobalLambdaBuilderProperty ¶
func (c *BaseClient) SetGlobalLambdaBuilderProperty(property LambdaBuilderProperty, value string) error
func (*BaseClient) SetGlobalLetsEncryptProperty ¶
func (c *BaseClient) SetGlobalLetsEncryptProperty(property LetsEncryptProperty, value string) error
func (*BaseClient) SetGlobalNetworkProperty ¶
func (c *BaseClient) SetGlobalNetworkProperty(property NetworkProperty, value string) error
func (*BaseClient) SetGlobalProcfilePath ¶
func (c *BaseClient) SetGlobalProcfilePath(procPath string) error
func (*BaseClient) SetGlobalRestartPolicy ¶
func (c *BaseClient) SetGlobalRestartPolicy(p RestartPolicy) error
func (*BaseClient) SetSchedulerDockerLocalProperty ¶
func (c *BaseClient) SetSchedulerDockerLocalProperty(appName string, property DockerLocalSchedulerProperty, value string) error
func (*BaseClient) ShowAppCertCRT ¶
func (c *BaseClient) ShowAppCertCRT(appName string) (string, error)
func (*BaseClient) ShowAppCertKey ¶
func (c *BaseClient) ShowAppCertKey(appName string) (string, error)
func (*BaseClient) StartAllApps ¶
func (c *BaseClient) StartAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) StartApp ¶
func (c *BaseClient) StartApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) StopAllApps ¶
func (c *BaseClient) StopAllApps(p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) StopApp ¶
func (c *BaseClient) StopApp(appName string, p *ParallelismOptions) (*CommandOutputStream, error)
func (*BaseClient) TailAppLogs ¶
func (c *BaseClient) TailAppLogs(appName string) (io.Reader, error)
func (*BaseClient) UnlockApp ¶
func (c *BaseClient) UnlockApp(name string) error
func (*BaseClient) UnmountAppStorage ¶
func (c *BaseClient) UnmountAppStorage(appName string, mount StorageBindMount) error
func (*BaseClient) UnsetAppConfigValue ¶
func (c *BaseClient) UnsetAppConfigValue(appName string, key string, restart bool) error
func (*BaseClient) UnsetAppConfigValues ¶
func (c *BaseClient) UnsetAppConfigValues(appName string, keys []string, restart bool) error
func (*BaseClient) UnsetGlobalConfigValue ¶
func (c *BaseClient) UnsetGlobalConfigValue(key string, restart bool) error
func (*BaseClient) UnsetGlobalConfigValues ¶
func (c *BaseClient) UnsetGlobalConfigValues(keys []string, restart bool) error
func (*BaseClient) UpdateAppCert ¶
func (c *BaseClient) UpdateAppCert(appName string, crt string, key string) error
func (*BaseClient) ValidateAllNginxConfig ¶
func (c *BaseClient) ValidateAllNginxConfig(clean bool) error
func (*BaseClient) ValidateAppNginxConfig ¶
func (c *BaseClient) ValidateAppNginxConfig(appName string, clean bool) error
type BuilderProperty ¶
type BuilderProperty string
type BuildpackProperty ¶
type BuildpackProperty string
type CertsReport ¶
type CertsReport map[string]*AppCertsReport
type ChecksReport ¶
type ChecksReport map[string]*AppChecksReport
type CommandOutputStream ¶
type ConfigExportFormat ¶
type ConfigExportFormat string
type CronReport ¶
type CronReport map[string]*AppCronReport
type DockerLocalSchedulerProperty ¶
type DockerLocalSchedulerProperty string
type DockerOptionsReport ¶
type DockerOptionsReport map[string]*AppDockerOptionsReport
type DockerRegistryProperty ¶
type DockerRegistryProperty string
type DockerRegistryReport ¶
type DockerRegistryReport map[string]AppDockerRegistryReport
type DockerRunOptions ¶
type DockerfileProperty ¶
type DockerfileProperty string
type DomainsReport ¶
type DomainsReport map[string]*AppDomainsReport
type ExitCodeError ¶
type ExitCodeError struct {
// contains filtered or unexported fields
}
func (*ExitCodeError) Error ¶
func (xe *ExitCodeError) Error() string
func (*ExitCodeError) ExitStatus ¶
func (xe *ExitCodeError) ExitStatus() int
func (*ExitCodeError) Output ¶
func (xe *ExitCodeError) Output() string
func (*ExitCodeError) Unwrap ¶
func (xe *ExitCodeError) Unwrap() error
type GitAppReport ¶
type GitAppReport struct { DeployBranch string `json:"deploy_branch" dokku:"Git deploy branch"` GlobalDeployBranch string `json:"global_deploy_branch" dokku:"Git global deploy branch"` KeepGitDir bool `json:"keep_git_dir" dokku:"Git keep git dir"` RevisionEnvVar string `json:"rev_env_var" dokku:"Git rev env var"` SHA string `json:"sha" dokku:"Git sha"` LastUpdatedAt string `json:"last_updated_at" dokku:"Git last updated at"` }
type GitArchiveOptions ¶
type GitArchiveOptions struct { ArchiveType string AuthorDetails *GitAuthorDetails }
type GitAuthorDetails ¶
func (*GitAuthorDetails) String ¶
func (ad *GitAuthorDetails) String() string
type GitImageOptions ¶
type GitImageOptions struct { BuildDir string AuthorDetails *GitAuthorDetails }
type GitProperty ¶
type GitProperty string
type GitReport ¶
type GitReport map[string]*GitAppReport
type GitSyncOptions ¶
type GlobalDomainsReport ¶
type LambdaBuilderProperty ¶
type LambdaBuilderProperty string
type LetsEncryptAppInfo ¶
type LetsEncryptAppInfo struct{}
type LetsEncryptAppReport ¶
type LetsEncryptAppReport struct { Active bool `json:"active" dokku:"Letsencrypt active"` AutoRenew bool `json:"autorenew" dokku:"Letsencrypt autorenew"` ComputedDnsProvider string `json:"computed_dns_provider" dokku:"Letsencrypt computed dns provider"` GlobalDnsProvider string `json:"global_dns_provider" dokku:"Letsencrypt global dns provider"` DnsProvider string `json:"dns_provider" dokku:"Letsencrypt dns provider"` ComputedEmail string `json:"computed_email" dokku:"Letsencrypt computed email"` GlobalEmail string `json:"global_email" dokku:"Letsencrypt global email"` Email string `json:"email" dokku:"Letsencrypt email"` Expiration int `json:"expiration" dokku:"Letsencrypt expiration"` ComputedGracePeriod int `json:"computed_grace_period" dokku:"Letsencrypt computed graceperiod"` GlobalGracePeriod int `json:"global_grace_period" dokku:"Letsencrypt global graceperiod"` GracePeriod int `json:"grace_period" dokku:"Letsencrypt graceperiod"` ComputedLegoDockerArgs string `json:"computed_lego_docker_args" dokku:"Letsencrypt computed lego docker args"` GlobalLegoDockerArgs string `json:"global_lego_docker_args" dokku:"Letsencrypt global lego docker args"` LegoDockerArgs string `json:"lego_docker_args" dokku:"Letsencrypt lego docker args"` ComputedServer string `json:"computed_server" dokku:"Letsencrypt computed server"` GlobalServer string `json:"global_server" dokku:"Letsencrypt global server"` Server string `json:"server" dokku:"Letsencrypt server"` }
type LetsEncryptProperty ¶
type LetsEncryptProperty string
type NetworkProperty ¶
type NetworkProperty string
type NetworkReport ¶
type NetworkReport map[string]*AppNetworkReport
type NginxProperty ¶
type NginxProperty string
type NginxReport ¶
type NginxReport map[string]*AppNginxReport
type ParallelismOptions ¶
type PluginInfo ¶
type ProcessReport ¶
type ProcessReport map[string]*AppProcessReport
type ProxyPortMapping ¶
func (*ProxyPortMapping) String ¶
func (m *ProxyPortMapping) String() string
type ProxyReport ¶
type ProxyReport map[string]*AppProxyReport
type Resource ¶
type Resource struct { Type ResourceSpec `json:"type"` Amount int `json:"amount"` }
type ResourceReport ¶
type ResourceReport map[string]*AppResourceReport
type ResourceSettings ¶
type ResourceSettings struct { Limits ResourceUnits `json:"limits"` Reservations ResourceUnits `json:"reservations"` }
type ResourceSpec ¶
type ResourceUnits ¶
type ResourceUnits struct { CPU *Resource `json:"cpu"` Memory *Resource `json:"memory"` MemorySwap *Resource `json:"memory_swap"` Network *Resource `json:"network"` NetworkIngress *Resource `json:"network_ingress"` NetworkEgress *Resource `json:"network_egress"` NvidiaGPU *Resource `json:"nvidia_gpu"` }
type RestartPolicy ¶
type RestartPolicy interface {
GetPolicy() string
}
func RetryableRestartPolicy ¶
func RetryableRestartPolicy(maxRetries int) RestartPolicy
type SSHClient ¶
type SSHClient struct { BaseClient // contains filtered or unexported fields }
func NewSSHClient ¶
func NewSSHClient(cfg *SSHClientConfig) (*SSHClient, error)
type SSHClientConfig ¶
type SSHClientConfig struct { Host string // optional, defaults to 22 Port string PrivateKey *rsa.PrivateKey PrivateKeyBytes []byte PrivateKeyPassphrase []byte // optional, defaults to 5 seconds ConnectionTimeout *time.Duration // optional, defaults to using $HOME/.ssh/known_hosts HostKeyCallback ssh.HostKeyCallback }
type SchedulerDockerLocalReport ¶
type SchedulerDockerLocalReport map[string]*AppSchedulerDockerLocalReport
type SchedulerProperty ¶
type SchedulerProperty string
type SchedulerReport ¶
type SchedulerReport map[string]*AppSchedulerReport
type StorageBindMount ¶
func (*StorageBindMount) String ¶
func (m *StorageBindMount) String() string
type StorageChownOption ¶
type StorageChownOption string
type StorageReport ¶
type StorageReport map[string]*AppStorageReport
Source Files ¶
Click to show internal directories.
Click to hide internal directories.