Documentation
¶
Index ¶
- func CreateTemplate(params CreateTemplateParams) (string, error)
- func DeleteTemplate(params GetTemplateParams) error
- func GetDeploymentTemplateFromFolder(params TemplateFromFolderParams) (map[string]*models.DeploymentTemplateInfo, error)
- func GetRemoteDeploymentTemplates(params GetTemplateParams) (map[string]*models.DeploymentTemplateInfo, error)
- func GetTemplate(params GetTemplateParams) (*models.DeploymentTemplateInfo, error)
- func ListTemplates(params ListTemplateParams) (*platform_configuration_templates.GetDeploymentTemplatesOK, error)
- func PullToFolder(params PullTemplateToFolderParams) error
- func UpdateTemplate(params UpdateTemplateParams) error
- type CompareResult
- type CreateTemplateParams
- type DiffTemplateParams
- type GetTemplateParams
- type ListTemplateParams
- type PullTemplateToFolderParams
- type PushTemplateParams
- type TemplateFromFolderParams
- type TemplateOperation
- type TemplateParams
- type TemplateToFolderParams
- type UpdateTemplateParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateTemplate ¶
func CreateTemplate(params CreateTemplateParams) (string, error)
CreateTemplate creates a platform deployment template
func DeleteTemplate ¶
func DeleteTemplate(params GetTemplateParams) error
DeleteTemplate deletes a specific platform deployment template
func GetDeploymentTemplateFromFolder ¶
func GetDeploymentTemplateFromFolder(params TemplateFromFolderParams) (map[string]*models.DeploymentTemplateInfo, error)
GetDeploymentTemplateFromFolder retrieves deployment template from a local folder. It can retrieve all DT definition or a single one. Depends on the id value.
func GetRemoteDeploymentTemplates ¶
func GetRemoteDeploymentTemplates(params GetTemplateParams) (map[string]*models.DeploymentTemplateInfo, error)
GetRemoteDeploymentTemplates retrieves remote deployment templates
func GetTemplate ¶
func GetTemplate(params GetTemplateParams) (*models.DeploymentTemplateInfo, error)
GetTemplate obtains information about a specific platform deployment template
func ListTemplates ¶
func ListTemplates(params ListTemplateParams) (*platform_configuration_templates.GetDeploymentTemplatesOK, error)
ListTemplates obtains all the configured platform deployment templates
func PullToFolder ¶
func PullToFolder(params PullTemplateToFolderParams) error
PullToFolder downloads deployment templates and save them in a local folder
func UpdateTemplate ¶
func UpdateTemplate(params UpdateTemplateParams) error
UpdateTemplate updates a platform deployment template
Types ¶
type CompareResult ¶
type CompareResult struct {
Equals bool
Diff string
DT *models.DeploymentTemplateInfo
Operation TemplateOperation
}
CompareResult contains the diffs between two deployment template after they have been compared.
type CreateTemplateParams ¶
type CreateTemplateParams struct {
*api.API
*models.DeploymentTemplateInfo
}
CreateTemplateParams is the parameter of template create sub-command
func (CreateTemplateParams) Validate ¶
func (params CreateTemplateParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
type DiffTemplateParams ¶
type DiffTemplateParams struct {
TemplateToFolderParams
ID string
Out io.Writer
}
DiffTemplateParams is used to compare deployment templates as defined in a local folder. Optionally you can target only one template.
func (DiffTemplateParams) Validate ¶
func (params DiffTemplateParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
type GetTemplateParams ¶
type GetTemplateParams struct {
TemplateParams
ShowInstanceConfig bool
}
GetTemplateParams is the parameter of template show sub-command
type ListTemplateParams ¶
type ListTemplateParams struct {
*api.API
// If true, will return details for each instance configuration referenced by the template.
ShowInstanceConfig bool
// If present, it will cause the returned deployment templates to be adapted to return only the elements allowed
// in that version.
StackVersion string
// An optional key/value pair in the form of (key:value) that will act as a filter and exclude any templates
// that do not have a matching metadata item associated.
Metadata string
}
ListTemplateParams is the parameter of template list sub-command
func (ListTemplateParams) Validate ¶
func (params ListTemplateParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
type PullTemplateToFolderParams ¶
type PullTemplateToFolderParams struct {
TemplateToFolderParams
}
PullTemplateToFolderParams is the parameter for deployment template pull to folder sub-command
func (PullTemplateToFolderParams) Validate ¶
func (params PullTemplateToFolderParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
type PushTemplateParams ¶
PushTemplateParams is used to push deployment templates as defined from a local folder. Optionally you can target only one deployment template.
func (PushTemplateParams) Validate ¶
func (params PushTemplateParams) Validate() error
Validate ensures that the parameters are correct.
type TemplateFromFolderParams ¶
type TemplateFromFolderParams struct {
Folder, ID string
}
TemplateFromFolderParams retrieve deployment template from folder template ID is optional
func (TemplateFromFolderParams) Validate ¶
func (params TemplateFromFolderParams) Validate() error
Validate ensures that the parameters are correct.
type TemplateOperation ¶
type TemplateOperation uint
TemplateOperation define an operation needed on DT.
const ( // TemplateOperationNone No operation needed on DT TemplateOperationNone TemplateOperation = 0 // TemplateOperationUpdate update DT TemplateOperationUpdate TemplateOperation = 1 // TemplateOperationCreate create DT TemplateOperationCreate TemplateOperation = 2 )
func (TemplateOperation) String ¶
func (a TemplateOperation) String() string
func (TemplateOperation) Valid ¶
func (a TemplateOperation) Valid() bool
Valid check validity of deployment template action
type TemplateParams ¶
TemplateParams is the parameter of template delete sub-command
func (TemplateParams) Validate ¶
func (params TemplateParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
type TemplateToFolderParams ¶
TemplateToFolderParams is the parameter for deployment template pull to folder sub-command
func (TemplateToFolderParams) Validate ¶
func (params TemplateToFolderParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
type UpdateTemplateParams ¶
type UpdateTemplateParams struct {
TemplateParams
*models.DeploymentTemplateInfo
}
UpdateTemplateParams is the parameter of template update sub-command
func (UpdateTemplateParams) Validate ¶
func (params UpdateTemplateParams) Validate() error
Validate is the implementation for the ecctl.Validator interface
Source Files