service

Documentation

Index

• Constants
• type CommonOptions
• type Extensions
• type KusionExtensions
• type PreviewOptions
• type PreviewResult
  • func NewEmptyPreviewResult() PreviewResult
  • func NewPreviewResultOnlyError(err error) PreviewResult
• type PreviewResults
  • func (r PreviewResults) Error() error
• type PullOptions
• type SyncOptions
• type SyncResult
  • func NewEmptySyncResult() SyncResult
  • func NewSyncResultOnlyError(err error) SyncResult
• type SyncResults
  • func (r SyncResults) Error() error
• type TerraformExtensions

Constants

const DefaultMaxRoutines = 10

Types

type CommonOptions

type CommonOptions struct {
	PullOptions `json:",inline" yaml:",inline"`
	// Envs lets you set the env when executes in the form "key=value".
	Envs []string `json:"envs,omitempty" yaml:"envs,omitempty"`
	// DisableState is the flag to disable state management.
	DisableState bool `json:"disableState,omitempty"`
	// Extensions is the extensions for the stack request.
	Extensions Extensions `json:"extensions,omitempty"`
}

CommonOptions is the common options for preview and sync operation.

type Extensions

type Extensions struct {
	Kusion    KusionExtensions    `json:"kusion,omitempty"`
	Terraform TerraformExtensions `json:"terraform,omitempty"`
}

Extensions is the extensions for the stack request.

type KusionExtensions

type KusionExtensions struct {
	IgnoreFields []string `json:"ignoreFields,omitempty"`
	KCLArguments []string `json:"kclArguments,omitempty" yaml:"kclArguments,omitempty"`
	Color        bool     `json:"color,omitempty" yaml:"color,omitempty"`
	SpecFile     string   `json:"specFile,omitempty" yaml:"specFile,omitempty"`
	Version      string   `json:"version,omitempty" yaml:"version,omitempty"`
}

KusionExtensions is the extensions for the Kusion stack request.

type PreviewOptions

type PreviewOptions struct {
	CommonOptions `json:",inline" yaml:",inline"`
	// TODO: need to implement
	DriftMode bool `json:"driftMode,omitempty" yaml:"driftMode,omitempty"`
	// OutputFormat specify the output format, one of ”, 'json',
	// default is empty (”).
	OutputFormat string `json:"outputFormat,omitempty" yaml:"outputFormat,omitempty"`
}

PreviewOptions is the options for preview.

type PreviewResult

type PreviewResult struct {
	HasChange bool   `json:"hasChange" yaml:"hasChange"`
	Raw       string `json:"raw" yaml:"raw"`
	JSON      string `json:"json,omitempty" yaml:"json,omitempty"`
	Error     error  `json:"error,omitempty" yaml:"error,omitempty" swaggertype:"string"`
}

PreviewResult represents the result of a preview operation.

func NewEmptyPreviewResult

func NewEmptyPreviewResult() PreviewResult

NewEmptyPreviewResult creates an empty PreviewResult struct.

func NewPreviewResultOnlyError

func NewPreviewResultOnlyError(err error) PreviewResult

NewPreviewResultOnlyError creates a PreviewResult struct containing only an error.

type PreviewResults

type PreviewResults []PreviewResult

Represents a group of PreviewResult structs

func (PreviewResults) Error

func (r PreviewResults) Error() error

Error returns the error of all PreviewResult structs.

type PullOptions

type PullOptions struct {
	// SourceProviderType is the type of the source provider.
	SourceProviderType string `json:"sourceProviderType,omitempty" yaml:"sourceProviderType,omitempty"`
	// The version of the stack to be pulled. If not specified,
	// use the desired of stack.
	Version         string   `json:"version,omitempty" yaml:"version,omitempty"`
	AdditionalPaths []string `json:"additionalPaths,omitempty" yaml:"additionalPaths,omitempty"`
}

PullOptions is the options for pull.

type SyncOptions

type SyncOptions struct {
	CommonOptions `json:",inline" yaml:",inline"`
}

SyncOptions is the options for sync.

type SyncResult

type SyncResult struct {
	Raw   string `json:"raw" yaml:"raw"`
	Error error  `json:"error,omitempty" yaml:"error,omitempty" swaggertype:"string"`
}

SyncResult represents the result of a sync operation.

func NewEmptySyncResult

func NewEmptySyncResult() SyncResult

NewEmptySyncResult creates an empty SyncResult struct.

func NewSyncResultOnlyError

func NewSyncResultOnlyError(err error) SyncResult

NewSyncResultOnlyError creates a SyncResult struct containing only an error.

type SyncResults

type SyncResults []SyncResult

Represents a group of SyncResult structs

func (SyncResults) Error

func (r SyncResults) Error() error

Error returns the error of all SyncResult structs.

type TerraformExtensions

type TerraformExtensions struct{}

TerraformExtensions is the extensions for the Terraform stack request.