Documentation ¶
Index ¶
- Variables
- func Applications(selector string, showSecrets, showLogs, jsonFormat bool)
- func BackupStackInstance(selector, name string, components []string, waitAndTailDeployLogs bool)
- func Backups(selector string, showLogs, jsonFormat bool)
- func BaseStacks(selector string, jsonFormat bool)
- func CloudAccountDownloadCfTemplate(filename string, govcloud bool)
- func CloudAccounts(selector string, ...)
- func Components(selector string, onlyCustomComponents, jsonFormat bool)
- func CreateComponent(req ComponentRequest)
- func CreateEnvironment(name, cloudAccountSelector string)
- func CreateKubernetes(kind, name, environment, template string, ...)
- func CreateSecret(entityKind, selector, name, component, kind string, values map[string]string)
- func CreateStackInstance(req StackInstanceRequest)
- func CreateTemplate(req StackTemplateRequest)
- func CreateWorkerpool(selector, name, instanceType string, count, maxCount int, spotPrice float32, ...)
- func DeleteApplication(selector string, waitAndTailDeployLogs bool)
- func DeleteBackup(selector string)
- func DeleteCloudAccount(selector string, waitAndTailDeployLogs bool)
- func DeleteComponent(selector string)
- func DeleteEnvironment(selector string)
- func DeleteStackInstance(selector string)
- func DeleteTemplate(selector string)
- func DeleteWorkerpool(selector string)
- func DeployStackInstance(selector string, components []string, waitAndTailDeployLogs, dryRun bool)
- func DeployWorkerpool(selector string, waitAndTailDeployLogs, dryRun bool)
- func Environments(selector string, ...)
- func GetParameterOrMaybeCreateSecret(environment, stackInstance, application, name, component string, create bool) (bool, string, []error)
- func GetSecret(entityKind, selector, uuid string, jsonFormat bool)
- func ImportKubernetes(kind, name, environment, template string, ...)
- func InitTemplate(selector string)
- func InstallApplication(req ApplicationRequest, waitAndTailDeployLogs bool)
- func Invoke(method, path string, body io.Reader)
- func KubeconfigStackInstance(selector, filename string)
- func Login(apiBaseUrl, username, password string)
- func Logs(selectors []string, exitOnCompletedOperation bool) int
- func LogsStackInstance(selector, operationId, filename string)
- func OnboardCloudAccount(domain, kind, region string, args []string, zone, awsVpc, awsKeypair string, ...)
- func PatchApplication(selector string, change ApplicationPatch, waitAndTailDeployLogs bool)
- func PatchComponent(selector string, change ComponentPatch)
- func PatchEnvironment(selector string, change EnvironmentPatch)
- func PatchStackInstanceForCmd(selector string, change StackInstancePatch, replace bool)
- func PatchTemplate(selector string, change StackTemplatePatch)
- func RawCreateComponent(body io.Reader)
- func RawCreateStackInstance(body io.Reader)
- func RawCreateTemplate(body io.Reader)
- func RawInstallApplication(body io.Reader, waitAndTailDeployLogs bool)
- func RawPatchApplication(selector string, body io.Reader, waitAndTailDeployLogs bool)
- func RawPatchComponent(selector string, body io.Reader)
- func RawPatchEnvironment(selector string, body io.Reader)
- func RawPatchStackInstance(selector string, body io.Reader, replace bool)
- func RawPatchTemplate(selector string, body io.Reader)
- func ScaleWorkerpool(selector, instanceType string, count, maxCount int, ...)
- func StackInstances(selector, environmentSelector string, ...)
- func SyncStackInstance(selector, status string, stateFilenames []string)
- func Tasks(environmentSelector string, jsonFormat bool)
- func Templates(selector string, ...)
- func TerminateTask(id string)
- func UndeployStackInstance(selector string, components []string, waitAndTailDeployLogs bool)
- func UndeployWorkerpool(selector string, useWorkerpoolApi, waitAndTailDeployLogs bool)
- func VerifyWorkerpool(selector string)
- func Workerpools(selector, environmentSelector string, showSecrets, showLogs, jsonFormat bool)
- type ApiError
- type ApiErrors
- type Application
- type ApplicationPatch
- type ApplicationRequest
- type AuthLoginToken
- type AuthPingResponse
- type AuthUserPass
- type AwsSecurityCredentials
- type Backup
- type BackupBundle
- type BackupRequest
- type BaseStack
- type CloudAccount
- type CloudAccountRequest
- type ClusterOptions
- type Component
- type ComponentBackup
- type ComponentBackupOutput
- type ComponentGitRef
- type ComponentGitRefRequest
- type ComponentMetadata
- type ComponentOutput
- type ComponentPatch
- type ComponentRef
- type ComponentRequest
- type ComponentStatus
- type CreateSecretResponse
- type DeploymentKey
- type Environment
- type EnvironmentPatch
- type EnvironmentRef
- type EnvironmentRequest
- type Filter
- type GitRef
- type GitRefPatch
- type ImportConfig
- type InflightOperation
- type License
- type LifecyclePhase
- type LoginTokenResponse
- type Output
- type Parameter
- type PlatformRef
- type Provider
- type Secret
- type ServiceAccount
- type SigninResponse
- type StackComponent
- type StackInstance
- type StackInstanceLifecycleRequest
- type StackInstanceLifecycleResponse
- type StackInstancePatch
- type StackInstanceRef
- type StackInstanceRequest
- type StackInstanceStatus
- type StackRef
- type StackTemplate
- type StackTemplatePatch
- type StackTemplateRef
- type StackTemplateRequest
- type Task
- type TaskLifecycleRequest
- type Team
- type TemplateStatus
- type Timestamps
- type WorkerpoolLifecycleResponse
- type WorkerpoolPatch
- type WorkerpoolRequest
- type WsMessage
Constants ¶
This section is empty.
Variables ¶
View Source
var (
GovCloudRegions = []string{"us-gov-east-1", "us-gov-west-1"}
)
View Source
var (
MethodsWithJsonBody = []string{"POST", "PUT", "PATCH"}
)
Functions ¶
func Applications ¶
func BackupStackInstance ¶
func BaseStacks ¶
func CloudAccounts ¶
func Components ¶
func CreateComponent ¶
func CreateComponent(req ComponentRequest)
func CreateEnvironment ¶
func CreateEnvironment(name, cloudAccountSelector string)
func CreateKubernetes ¶
func CreateKubernetes(kind, name, environment, template string, autoCreateTemplate, createNewTemplate, waitAndTailDeployLogs, dryRun bool, nativeRegion, nativeZone, nativeClusterName, eksAdmin, azureResourceGroup string, options ClusterOptions)
func CreateSecret ¶
func CreateStackInstance ¶
func CreateStackInstance(req StackInstanceRequest)
func CreateTemplate ¶
func CreateTemplate(req StackTemplateRequest)
func CreateWorkerpool ¶
func DeleteApplication ¶
func DeleteBackup ¶
func DeleteBackup(selector string)
func DeleteCloudAccount ¶
func DeleteComponent ¶
func DeleteComponent(selector string)
func DeleteEnvironment ¶
func DeleteEnvironment(selector string)
func DeleteStackInstance ¶
func DeleteStackInstance(selector string)
func DeleteTemplate ¶
func DeleteTemplate(selector string)
func DeleteWorkerpool ¶
func DeleteWorkerpool(selector string)
func DeployStackInstance ¶
func DeployWorkerpool ¶
func Environments ¶
func ImportKubernetes ¶
func ImportKubernetes(kind, name, environment, template string, autoCreateTemplate, createNewTemplate, waitAndTailDeployLogs, dryRun bool, pems io.Reader, clusterBearerToken, nativeRegion, nativeZone, nativeEndpoint, nativeClusterName, ingressIpOrHost, azureResourceGroup string, options ClusterOptions)
func InitTemplate ¶
func InitTemplate(selector string)
func InstallApplication ¶
func InstallApplication(req ApplicationRequest, waitAndTailDeployLogs bool)
func KubeconfigStackInstance ¶
func KubeconfigStackInstance(selector, filename string)
func LogsStackInstance ¶
func LogsStackInstance(selector, operationId, filename string)
func OnboardCloudAccount ¶
func PatchApplication ¶
func PatchApplication(selector string, change ApplicationPatch, waitAndTailDeployLogs bool)
func PatchComponent ¶
func PatchComponent(selector string, change ComponentPatch)
func PatchEnvironment ¶
func PatchEnvironment(selector string, change EnvironmentPatch)
func PatchStackInstanceForCmd ¶
func PatchStackInstanceForCmd(selector string, change StackInstancePatch, replace bool)
func PatchTemplate ¶
func PatchTemplate(selector string, change StackTemplatePatch)
func RawCreateComponent ¶
func RawCreateStackInstance ¶
func RawCreateTemplate ¶
func RawInstallApplication ¶
func RawPatchApplication ¶
func RawPatchComponent ¶
func RawPatchEnvironment ¶
func RawPatchStackInstance ¶
func RawPatchTemplate ¶
func ScaleWorkerpool ¶
func StackInstances ¶
func SyncStackInstance ¶
func TerminateTask ¶
func TerminateTask(id string)
func UndeployStackInstance ¶
func UndeployWorkerpool ¶
func VerifyWorkerpool ¶
func VerifyWorkerpool(selector string)
func Workerpools ¶
Types ¶
type Application ¶
type Application struct { Id string `json:"id"` Name string `json:"name"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Application string `json:"application"` Status string `json:"status"` Environment EnvironmentRef `json:"environment"` Environments []EnvironmentRef `json:"environments,omitempty"` // not implemented Platform PlatformRef `json:"platform"` Requires []string `json:"requires"` Parameters []Parameter `json:"parameters,omitempty"` Outputs []Output `json:"outputs,omitempty"` StateFiles []string `json:"stateFiles,omitempty"` InflightOperations []InflightOperation `json:"inflightOperations,omitempty"` }
type ApplicationPatch ¶
type ApplicationRequest ¶
type ApplicationRequest struct { Name string `json:"name"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Application string `json:"application"` Requires []string `json:"requires"` Platform string `json:"platform"` Parameters []Parameter `json:"parameters,omitempty"` }
type AuthLoginToken ¶
type AuthLoginToken struct {
LoginToken string `json:"loginToken"`
}
type AuthPingResponse ¶
type AuthPingResponse struct {
Exp int64 `json:"exp"`
}
type AuthUserPass ¶
type AwsSecurityCredentials ¶
type Backup ¶
type Backup struct { Id string `json:"id"` Name string `json:"name"` Status string `json:"status"` Timestamp time.Time `json:"timestamp"` Components []string `json:"components,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Environment EnvironmentRef `json:"environment"` StackInstance StackInstanceRef `json:"stackInstance"` Logs string `json:"logs,omitempty"` Bundle BackupBundle `json:"bundle"` }
type BackupBundle ¶
type BackupRequest ¶
type CloudAccount ¶
type CloudAccount struct { Id string `json:"id"` Name string `json:"name"` Tags []string `json:"tags,omitempty"` Kind string `json:"kind"` Status string `json:"status"` BaseDomain string `json:"baseDomain"` Parameters []Parameter `json:"parameters,omitempty"` InflightOperations []InflightOperation `json:"inflightOperations,omitempty"` TeamsPermissions []Team `json:"teamsPermissions"` }
type CloudAccountRequest ¶
type ClusterOptions ¶
type Component ¶
type Component struct { Id string `json:"id,omitempty"` QName string `json:"qname"` Title string `json:"title"` Brief string `json:"brief,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Category string `json:"category,omitempty"` License string `json:"license,omitempty"` Icon string `json:"icon,omitempty"` Template *StackTemplateRef `json:"template,omitempty"` Git *ComponentGitRef `json:"git,omitempty"` Version string `json:"version,omitempty"` Maturity string `json:"maturity,omitempty"` Requires []string `json:"requires,omitempty"` Provides []string `json:"provides,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type ComponentBackup ¶
type ComponentBackup struct { Kind string `json:"kind"` Status string `json:"status"` Timestamp time.Time `json:"timestamp"` Outputs []ComponentBackupOutput `json:"outputs,omitempty"` }
type ComponentBackupOutput ¶
type ComponentGitRef ¶
type ComponentGitRefRequest ¶
type ComponentGitRefRequest struct {
SubDir string `json:"subDir,omitempty"`
}
type ComponentMetadata ¶
type ComponentMetadata struct { Origin string `json:"origin,omitempty"` Kind string `json:"kind,omitempty"` Title string `json:"title,omitempty"` Brief string `json:"brief,omitempty"` Description string `json:"description,omitempty"` Version string `json:"version,omitempty"` Maturity string `json:"maturity,omitempty"` Icon string `json:"icon,omitempty"` }
type ComponentOutput ¶
type ComponentPatch ¶
type ComponentPatch struct { Title string `json:"title,omitempty"` Brief string `json:"brief,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Category string `json:"category,omitempty"` License string `json:"license,omitempty"` Icon string `json:"icon,omitempty"` Version string `json:"version,omitempty"` Maturity string `json:"maturity,omitempty"` Requires []string `json:"requires,omitempty"` Provides []string `json:"provides,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type ComponentRef ¶
type ComponentRequest ¶
type ComponentRequest struct { Name string `json:"name"` Title string `json:"title"` Brief string `json:"brief,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Category string `json:"category,omitempty"` License string `json:"license,omitempty"` Icon string `json:"icon,omitempty"` Template string `json:"template,omitempty"` Git *ComponentGitRefRequest `json:"git,omitempty"` Version string `json:"version,omitempty"` Maturity string `json:"maturity,omitempty"` Requires []string `json:"requires,omitempty"` Provides []string `json:"provides,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type ComponentStatus ¶
type ComponentStatus struct { Name string `json:"name"` Status string `json:"status"` Version string `json:"version,omitempty"` // TODO deprecate in favor of Meta.Version Meta *ComponentMetadata `json:"meta,omitempty"` Message string `json:"message,omitempty"` Outputs []ComponentOutput `json:"outputs,omitempty"` Timestamps *Timestamps `json:"timestamps,omitempty"` }
type CreateSecretResponse ¶
type CreateSecretResponse struct {
Id string
}
type DeploymentKey ¶
type DeploymentKey struct {
DeploymentKey string `json:"deploymentKey"`
}
type Environment ¶
type Environment struct { Id string `json:"id"` Name string `json:"name"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` CloudAccount string `json:"cloudAccount"` Parameters []Parameter `json:"parameters,omitempty"` Providers []Provider `json:"providers,omitempty"` TeamsPermissions []Team `json:"teamsPermissions"` }
type EnvironmentPatch ¶
type EnvironmentPatch struct { Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Parameters []Parameter `json:"parameters,omitempty"` Providers []Provider `json:"providers,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type EnvironmentRef ¶
type EnvironmentRequest ¶
type EnvironmentRequest struct { Name string `json:"name"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` CloudAccount string `json:"cloudAccount"` Parameters []Parameter `json:"parameters,omitempty"` Providers []Provider `json:"providers,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type GitRefPatch ¶
type ImportConfig ¶
type InflightOperation ¶
type InflightOperation struct { Id string `json:"id"` Operation string `json:"operation"` Timestamp time.Time `json:"timestamp"` Status string `json:"status,omitempty"` Options map[string]interface{} `json:"options,omitempty"` Description string `json:"description,omitempty"` Initiator string `json:"initiator,omitempty"` Location string `json:"location,omitempty"` Logs string `json:"logs,omitempty"` Phases []LifecyclePhase `json:"phases,omitempty"` // applications JobName string `json:"jobName,omitempty"` PlatformDomain string `json:"platformDomain,omitempty"` }
type LifecyclePhase ¶
type LoginTokenResponse ¶
type LoginTokenResponse struct {
LoginToken string `json:"loginToken"`
}
type PlatformRef ¶
type ServiceAccount ¶
type SigninResponse ¶
type StackComponent ¶
type StackInstance ¶
type StackInstance struct { Id string `json:"id"` Name string `json:"name"` Domain string `json:"domain"` Description string `json:"description,omitempty"` Verbs []string `json:"verbs,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Environment EnvironmentRef `json:"environment,omitempty"` Stack StackRef `json:"stack,omitempty"` Template StackTemplateRef `json:"template,omitempty"` Platform *PlatformRef `json:"platform,omitempty"` ComponentsEnabled []string `json:"componentsEnabled,omitempty"` GitRemote GitRef `json:"gitRemote,omitempty"` Parameters []Parameter `json:"parameters,omitempty"` Outputs []Output `json:"outputs,omitempty"` Provides map[string][]string `json:"provides,omitempty"` StateFiles []string `json:"stateFiles,omitempty"` Status StackInstanceStatus `json:"status"` InflightOperations []InflightOperation `json:"inflightOperations,omitempty"` }
func PatchStackInstance ¶
func PatchStackInstance(selector string, change StackInstancePatch, replace bool) (*StackInstance, error)
type StackInstanceLifecycleRequest ¶
type StackInstanceLifecycleRequest struct {
Components []string `json:"components,omitempty"`
}
type StackInstancePatch ¶
type StackInstancePatch struct { Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Verbs []string `json:"verbs,omitempty"` ComponentsEnabled []string `json:"componentsEnabled,omitempty"` StateFiles []string `json:"stateFiles,omitempty"` Parameters []Parameter `json:"parameters,omitempty"` GitRemote *GitRefPatch `json:"gitRemote,omitempty"` Status *StackInstanceStatus `json:"status,omitempty"` InflightOperations []InflightOperation `json:"inflightOperations,omitempty"` Outputs []Output `json:"outputs,omitempty"` Provides map[string][]string `json:"provides,omitempty"` }
func TransformStateToApi ¶
func TransformStateToApi(state *state.StateManifest) StackInstancePatch
type StackInstanceRef ¶
type StackInstanceRequest ¶
type StackInstanceRequest struct { Name string `json:"name"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Environment string `json:"environment"` Template string `json:"template"` Platform string `json:"platform,omitempty"` ComponentsEnabled []string `json:"componentsEnabled,omitempty"` Parameters []Parameter `json:"parameters,omitempty"` }
type StackInstanceStatus ¶
type StackInstanceStatus struct { Status string `json:"status,omitempty"` Template *TemplateStatus `json:"template,omitempty"` K8s *TemplateStatus `json:"k8s,omitempty"` Components []ComponentStatus `json:"components,omitempty"` }
type StackTemplate ¶
type StackTemplate struct { Id string `json:"id"` Name string `json:"name"` Description string `json:"description,omitempty"` Status string `json:"status"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Stack *StackRef `json:"stack,omitempty"` ComponentsEnabled []string `json:"componentsEnabled,omitempty"` Component *ComponentRef `json:"component,omitempty"` Verbs []string `json:"verbs,omitempty"` GitRemote GitRef `json:"gitRemote"` Parameters []Parameter `json:"parameters,omitempty"` TeamsPermissions []Team `json:"teamsPermissions"` }
type StackTemplatePatch ¶
type StackTemplatePatch struct { Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` ComponentsEnabled []string `json:"componentsEnabled,omitempty"` Verbs []string `json:"verbs,omitempty"` Parameters []Parameter `json:"parameters,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type StackTemplateRef ¶
type StackTemplateRequest ¶
type StackTemplateRequest struct { Name string `json:"name"` Description string `json:"description,omitempty"` Tags []string `json:"tags,omitempty"` UI map[string]interface{} `json:"ui,omitempty"` Stack string `json:"stack,omitempty"` ComponentsEnabled []string `json:"componentsEnabled,omitempty"` Component string `json:"component,omitempty"` Verbs []string `json:"verbs,omitempty"` Parameters []Parameter `json:"parameters,omitempty"` TeamsPermissions []Team `json:"teamsPermissions,omitempty"` }
type Task ¶
type Task struct { Id string `json:"id"` JobId string `json:"jobId"` EntityType string `json:"entityType"` Kind string `json:"kind"` Operation string `json:"operation"` Status string `json:"status"` StartTime *time.Time `json:"startTime"` CompletionTime *time.Time `json:"completionTime"` Entity struct { Name string `json:"name"` Domain string `json:"domain"` Kind string `json:"kind"` BaseDomain string `json:"baseDomain"` } `json:"entity"` }
type TaskLifecycleRequest ¶
type TaskLifecycleRequest struct {
Terminate bool `json:"terminate"`
}
type TemplateStatus ¶
type Timestamps ¶
type WorkerpoolLifecycleResponse ¶
type WorkerpoolLifecycleResponse struct { Id string `json:"id"` JobId string `json:"jobId"` Instance StackInstance `json:"instance"` }
type WorkerpoolPatch ¶
type WorkerpoolPatch struct {
Parameters []Parameter `json:"parameters,omitempty"`
}
type WorkerpoolRequest ¶
Click to show internal directories.
Click to hide internal directories.