directives

package

Go to main page

Versions in this module

v1

v1.1.2

Dec 23, 2024

Changes in this version

type GitPushConfig

+ MaxAttempts *int64

v1.1.2-rc.2

Dec 23, 2024

v1.1.2-rc.1

Dec 23, 2024

v1.1.1

Dec 9, 2024

v1.1.1-rc.1

Dec 9, 2024

v1.1.0

Dec 6, 2024

Changes in this version

+ var ReservedStepAliasRegex = regexp.MustCompile(`^step-\d+$`)

+ func ConfigToStruct[T any](c Config) (T, error)

type ArgoCDAppSourceUpdate

+ DesiredRevision string

type ArgoCDKustomizeImageUpdate

+ Digest string

+ Tag string

type Chart

+ Version string

type Checkout

+ Commit string

+ type HTTPConfig struct

+ Body string

+ FailureExpression string

+ Headers []HTTPHeader

+ InsecureSkipTLSVerify bool

+ Method string

+ Outputs []HTTPOutput

+ QueryParams []HTTPQueryParam

+ SuccessExpression string

+ Timeout string

+ URL string

+ type HTTPHeader struct

+ Name string

+ Value string

+ type HTTPOutput struct

+ FromExpression string

+ Name string

+ type HTTPQueryParam struct

+ Name string

+ Value string

type KustomizeSetImageConfigImage

+ Digest string

+ Tag string

type PromotionContext

+ Promotion string

+ Secrets map[string]map[string]string

+ StepExecutionMetadata kargoapi.StepExecutionMetadataList

+ Vars []kargoapi.PromotionVariable

type PromotionResult

+ StepExecutionMetadata kargoapi.StepExecutionMetadataList

type PromotionStep

+ Retry *kargoapi.PromotionStepRetry

+ func (s *PromotionStep) GetConfig(ctx context.Context, cl client.Client, promoCtx PromotionContext, state State) (Config, error)

+ func (s *PromotionStep) GetErrorThreshold(runner any) uint32

+ func (s *PromotionStep) GetTimeout(runner any) *time.Duration

+ func (s *PromotionStep) GetVars(promoCtx PromotionContext) (map[string]any, error)

type PromotionStepContext

+ Promotion string

+ type RetryableStepRunner interface

+ DefaultErrorThreshold func() uint32

+ DefaultTimeout func() *time.Duration

+ type YAMLUpdate struct

+ Key string

+ Value string

+ type YAMLUpdateConfig struct

+ Path string

+ Updates []YAMLUpdate

v1.1.0-rc.5

Dec 5, 2024

v1.1.0-rc.4

Dec 5, 2024

v1.1.0-rc.3

Nov 27, 2024

v1.1.0-rc.2

Nov 23, 2024

v1.1.0-rc.1

Nov 22, 2024

v1.0.4

Dec 2, 2024

v1.0.3

Oct 23, 2024

v1.0.2

Oct 22, 2024

v1.0.1

Oct 22, 2024

v1.0.0

Oct 19, 2024

Changes in this version

type PromotionContext

+ UIBaseURL string

type PromotionStepContext

+ UIBaseURL string

v1.0.0-rc.5

Oct 19, 2024

v1.0.0-rc.4

Oct 18, 2024

v1.0.0-rc.3

Oct 18, 2024

v1.0.0-rc.2

Oct 16, 2024

v1.0.0-rc.1

Oct 11, 2024

v0

v0.9.2

Oct 21, 2024

Changes in this version

+ type Helm struct

+ APIVersions []string

+ KubeVersion string

type KustomizeBuildConfig

+ Plugin *Plugin

+ type Plugin struct

+ Helm *Helm

v0.9.1

Oct 10, 2024

v0.9.0

Oct 7, 2024

Changes in this version

+ type AppFromOrigin struct

+ Kind Kind

+ Name string

+ type ArgoCDAppHealthCheck struct

+ DesiredRevisions []string

+ Name string

+ Namespace string

+ type ArgoCDAppSourceUpdate struct

+ Chart string

+ DesiredCommitFromStep string

+ FromOrigin *AppFromOrigin

+ Helm *ArgoCDHelmParameterUpdates

+ Kustomize *ArgoCDKustomizeImageUpdates

+ RepoURL string

+ UpdateTargetRevision bool

+ type ArgoCDAppStatus struct

+ Name string

+ Namespace string

+ type ArgoCDAppUpdate struct

+ FromOrigin *AppFromOrigin

+ Name string

+ Namespace string

+ Sources []ArgoCDAppSourceUpdate

+ type ArgoCDHealthConfig struct

+ Apps []ArgoCDAppHealthCheck

+ type ArgoCDHelmImageUpdate struct

+ FromOrigin *AppFromOrigin

+ Key string

+ RepoURL string

+ Value Value

+ type ArgoCDHelmParameterUpdates struct

+ FromOrigin *AppFromOrigin

+ Images []ArgoCDHelmImageUpdate

+ type ArgoCDKustomizeImageUpdate struct

+ FromOrigin *AppFromOrigin

+ NewName string

+ RepoURL string

+ UseDigest bool

+ type ArgoCDKustomizeImageUpdates struct

+ FromOrigin *AppFromOrigin

+ Images []ArgoCDKustomizeImageUpdate

+ type ArgoCDUpdateConfig struct

+ Apps []ArgoCDAppUpdate

+ FromOrigin *AppFromOrigin

+ type Author struct

+ Email string

+ Name string

+ type Chart struct

+ FromOrigin *ChartFromOrigin

+ Name string

+ Repository string

+ type ChartFromOrigin struct

+ Kind Kind

+ Name string

+ type Checkout struct

+ Branch string

+ Create bool

+ FromFreight bool

+ FromOrigin *CheckoutFromOrigin

+ Path string

+ Tag string

+ type CheckoutFromOrigin struct

+ Kind Kind

+ Name string

+ type CommonDefs interface

+ type Config map[string]any

+ func (c Config) DeepCopy() Config

+ func (c Config) ToJSON() []byte

+ type CopyConfig struct

+ Ignore string

+ InPath string

+ OutPath string

+ type Engine interface

+ CheckHealth func(context.Context, HealthCheckContext, []HealthCheckStep) kargoapi.Health

+ Promote func(context.Context, PromotionContext, []PromotionStep) (PromotionResult, error)

+ type FakeEngine struct

+ CheckHealthFn func(context.Context, HealthCheckContext, []HealthCheckStep) kargoapi.Health

+ ExecuteFn func(context.Context, PromotionContext, []PromotionStep) (PromotionResult, error)

+ func (e *FakeEngine) CheckHealth(ctx context.Context, healthCtx HealthCheckContext, steps []HealthCheckStep) kargoapi.Health

+ func (e *FakeEngine) Promote(ctx context.Context, promoCtx PromotionContext, steps []PromotionStep) (PromotionResult, error)

+ type GitClearConfig struct

+ Path string

+ type GitCloneConfig struct

+ Checkout []Checkout

+ InsecureSkipTLSVerify bool

+ RepoURL string

+ type GitCommitConfig struct

+ Author *Author

+ Message string

+ MessageFromSteps []string

+ Path string

+ type GitOpenPRConfig struct

+ CreateTargetBranch bool

+ InsecureSkipTLSVerify bool

+ Provider *Provider

+ RepoURL string

+ SourceBranch string

+ SourceBranchFromStep string

+ TargetBranch string

+ type GitPushConfig struct

+ GenerateTargetBranch bool

+ Path string

+ TargetBranch string

+ type GitWaitForPRConfig struct

+ InsecureSkipTLSVerify bool

+ PRNumber int64

+ PRNumberFromStep string

+ Provider *Provider

+ RepoURL string

+ type HealthCheckContext struct

+ Project string

+ Stage string

+ type HealthCheckStep struct

+ Config Config

+ Kind string

+ type HealthCheckStepContext struct

+ ArgoCDClient client.Client

+ Config Config

+ CredentialsDB credentials.Database

+ KargoClient client.Client

+ Project string

+ Stage string

+ type HealthCheckStepResult struct

+ Issues []string

+ Output map[string]any

+ Status kargoapi.HealthState

+ type HealthCheckStepRunner interface

+ Name func() string

+ RunHealthCheckStep func(context.Context, *HealthCheckStepContext) HealthCheckStepResult

+ type HealthCheckStepRunnerRegistration struct

+ Permissions StepRunnerPermissions

+ Runner HealthCheckStepRunner

+ type HelmTemplateConfig struct

+ APIVersions []string

+ DisableHooks bool

+ IncludeCRDs bool

+ KubeVersion string

+ Namespace string

+ OutPath string

+ Path string

+ ReleaseName string

+ SkipTests bool

+ UseReleaseName bool

+ ValuesFiles []string

+ func (c HelmTemplateConfig) OutPathIsFile() bool

+ type HelmUpdateChartConfig struct

+ Charts []Chart

+ Path string

+ type HelmUpdateImageConfig struct

+ Images []HelmUpdateImageConfigImage

+ Path string

+ type HelmUpdateImageConfigImage struct

+ FromOrigin *ChartFromOrigin

+ Image string

+ Key string

+ Value Value

+ type Kind string

+ const Warehouse

+ type KustomizeBuildConfig struct

+ OutPath string

+ Path string

+ type KustomizeSetImageConfig struct

+ Images []KustomizeSetImageConfigImage

+ Path string

+ type KustomizeSetImageConfigImage struct

+ FromOrigin *ChartFromOrigin

+ Image string

+ Name string

+ NewName string

+ UseDigest bool

+ type PromotionContext struct

+ Freight kargoapi.FreightCollection

+ FreightRequests []kargoapi.FreightRequest

+ Project string

+ Stage string

+ StartFromStep int64

+ State State

+ WorkDir string

+ type PromotionResult struct

+ CurrentStep int64

+ HealthCheckSteps []HealthCheckStep

+ Message string

+ State State

+ Status kargoapi.PromotionPhase

+ type PromotionStep struct

+ Alias string

+ Config Config

+ Kind string

+ type PromotionStepContext struct

+ Alias string

+ ArgoCDClient client.Client

+ Config Config

+ CredentialsDB credentials.Database

+ Freight kargoapi.FreightCollection

+ FreightRequests []kargoapi.FreightRequest

+ KargoClient client.Client

+ Project string

+ SharedState State

+ Stage string

+ WorkDir string

+ type PromotionStepResult struct

+ HealthCheckStep *HealthCheckStep

+ Message string

+ Output map[string]any

+ Status kargoapi.PromotionPhase

+ type PromotionStepRunner interface

+ Name func() string

+ RunPromotionStep func(context.Context, *PromotionStepContext) (PromotionStepResult, error)

+ type PromotionStepRunnerRegistration struct

+ Permissions StepRunnerPermissions

+ Runner PromotionStepRunner

+ type Provider string

+ const Github

+ const Gitlab

+ type SimpleEngine struct

+ func NewSimpleEngine(credentialsDB credentials.Database, kargoClient client.Client, ...) *SimpleEngine

+ func (e *SimpleEngine) CheckHealth(ctx context.Context, healthCtx HealthCheckContext, steps []HealthCheckStep) kargoapi.Health

+ func (e *SimpleEngine) Promote(ctx context.Context, promoCtx PromotionContext, steps []PromotionStep) (PromotionResult, error)

+ type State map[string]any

+ func (s *State) DeepCopy() State

+ func (s State) Get(key string) (any, bool)

+ func (s State) Set(key string, value any)

+ func (s State) ToJSON() []byte

+ type StepRunnerPermissions struct

+ AllowArgoCDClient bool

+ AllowCredentialsDB bool

+ AllowKargoClient bool

+ type StepRunnerRegistry struct

+ func NewStepRunnerRegistry() *StepRunnerRegistry

+ func (s StepRunnerRegistry) GetHealthCheckStepRunnerRegistration(name string) (HealthCheckStepRunnerRegistration, error)

+ func (s StepRunnerRegistry) GetPromotionStepRunnerRegistration(name string) (PromotionStepRunnerRegistration, error)

+ func (s StepRunnerRegistry) RegisterHealthCheckStepRunner(runner HealthCheckStepRunner, permissions *StepRunnerPermissions)

+ func (s StepRunnerRegistry) RegisterPromotionStepRunner(runner PromotionStepRunner, permissions *StepRunnerPermissions)

+ type Value string

+ const Digest

+ const ImageAndDigest

+ const ImageAndTag

+ const Tag

v0.9.0-rc.3

Oct 4, 2024

v0.9.0-rc.2

Oct 2, 2024

v0.9.0-rc.1

Sep 30, 2024

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL