Documentation
¶
Index ¶
- type Component
- func (cp *Component) Delete(params DeleteParams) error
- func (cp *Component) Deploy(params DeployParams) error
- func (cp *Component) Get(params GetParams) error
- func (cp *Component) List(params ListParams) error
- func (cp *Component) ListWorkflowRuns(params ListWorkflowRunsParams) error
- func (cp *Component) Logs(params LogsParams) error
- func (cp *Component) Scaffold(params ScaffoldParams) error
- func (cp *Component) StartWorkflow(params StartWorkflowParams) error
- func (cp *Component) WorkflowRunLogs(params WorkflowRunLogsParams) error
- type DeleteParams
- type DeployParams
- type GetParams
- type ListParams
- type ListWorkflowRunsParams
- type LogsParams
- type ScaffoldParams
- type StartWorkflowParams
- type WorkflowRunLogsParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Component ¶ added in v0.17.0
type Component struct{}
func (*Component) Delete ¶ added in v0.17.0
func (cp *Component) Delete(params DeleteParams) error
Delete deletes a single component
func (*Component) Deploy ¶ added in v0.17.0
func (cp *Component) Deploy(params DeployParams) error
Deploy deploys or promotes a component
func (*Component) List ¶ added in v0.17.0
func (cp *Component) List(params ListParams) error
List lists all components in a project
func (*Component) ListWorkflowRuns ¶ added in v0.17.0
func (cp *Component) ListWorkflowRuns(params ListWorkflowRunsParams) error
ListWorkflowRuns lists workflow runs filtered by component name.
func (*Component) Logs ¶ added in v0.17.0
func (cp *Component) Logs(params LogsParams) error
Logs fetches and displays logs for a component
func (*Component) Scaffold ¶ added in v0.17.0
func (cp *Component) Scaffold(params ScaffoldParams) error
Scaffold generates a scaffold YAML for a component based on its ComponentType and optional Traits and Workflow
func (*Component) StartWorkflow ¶ added in v0.17.0
func (cp *Component) StartWorkflow(params StartWorkflowParams) error
StartWorkflow gets the component, resolves its workflow name, and starts a workflow run.
func (*Component) WorkflowRunLogs ¶ added in v0.17.0
func (cp *Component) WorkflowRunLogs(params WorkflowRunLogsParams) error
WorkflowRunLogs fetches and displays logs for a component's workflow run. If RunName is provided, it delegates directly to workflowrun.Logs. Otherwise, it resolves the component's workflow and finds the latest run.
type DeleteParams ¶ added in v0.17.0
DeleteParams defines parameters for deleting a single component
func (DeleteParams) GetComponentName ¶ added in v0.17.0
func (p DeleteParams) GetComponentName() string
func (DeleteParams) GetNamespace ¶ added in v0.17.0
func (p DeleteParams) GetNamespace() string
type DeployParams ¶ added in v0.17.0
type DeployParams struct {
ComponentName string
Namespace string
Project string
Release string // --release flag (optional release name)
To string // --to flag (target env for promotion)
Set []string // --set values (type.path=value)
OutputFormat string
}
DeployParams defines parameters for deploying or promoting a component
func (DeployParams) GetComponentName ¶ added in v0.17.0
func (p DeployParams) GetComponentName() string
func (DeployParams) GetNamespace ¶ added in v0.17.0
func (p DeployParams) GetNamespace() string
func (DeployParams) GetProject ¶ added in v0.17.0
func (p DeployParams) GetProject() string
type GetParams ¶ added in v0.17.0
GetParams defines parameters for getting a single component
func (GetParams) GetNamespace ¶ added in v0.17.0
type ListParams ¶ added in v0.17.0
ListParams defines parameters for listing components
func (ListParams) GetNamespace ¶ added in v0.17.0
func (p ListParams) GetNamespace() string
type ListWorkflowRunsParams ¶ added in v0.17.0
ListWorkflowRunsParams defines parameters for listing workflow runs by component
func (ListWorkflowRunsParams) GetComponentName ¶ added in v0.17.0
func (p ListWorkflowRunsParams) GetComponentName() string
func (ListWorkflowRunsParams) GetNamespace ¶ added in v0.17.0
func (p ListWorkflowRunsParams) GetNamespace() string
type LogsParams ¶ added in v0.17.0
type LogsParams struct {
Namespace string
Project string
Component string
Environment string
Follow bool
Since string // duration like "1h", "30m", "5m"
}
LogsParams defines parameters for fetching component logs
type ScaffoldParams ¶ added in v0.17.0
type ScaffoldParams struct {
ComponentName string
ComponentType string // format: workloadType/componentTypeName
Traits []string // trait names
WorkflowName string
Namespace string
ProjectName string
OutputPath string
SkipComments bool // skip structural comments and field descriptions
SkipOptional bool // skip optional fields without defaults
}
ScaffoldParams defines parameters for scaffolding a component
type StartWorkflowParams ¶ added in v0.17.0
type StartWorkflowParams struct {
Namespace string
ComponentName string
Project string
Set []string
}
StartWorkflowParams defines parameters for starting a component's workflow
func (StartWorkflowParams) GetComponentName ¶ added in v0.17.0
func (p StartWorkflowParams) GetComponentName() string
func (StartWorkflowParams) GetNamespace ¶ added in v0.17.0
func (p StartWorkflowParams) GetNamespace() string
type WorkflowRunLogsParams ¶ added in v0.17.0
type WorkflowRunLogsParams struct {
Namespace string
ComponentName string
RunName string // optional --workflowrun flag; defaults to latest
Follow bool
Since string
}
WorkflowRunLogsParams defines parameters for fetching component workflow run logs
func (WorkflowRunLogsParams) GetComponentName ¶ added in v0.17.0
func (p WorkflowRunLogsParams) GetComponentName() string
func (WorkflowRunLogsParams) GetNamespace ¶ added in v0.17.0
func (p WorkflowRunLogsParams) GetNamespace() string