model

Documentation

Overview

Package model contains definitions of model objects that are stored in the datastore.

Index

• Constants
• func ApplicationKindStrings() []string
• func CanUpdateDeploymentStatus(cur, next DeploymentStatus) bool
• func CanUpdateStageStatus(cur, next StageStatus) bool
• func DeploymentStatusStrings() []string
• func ExtractAPIKeyID(key string) (string, error)
• func GenerateAPIKey(id string) (key, hash string, err error)
• func GeneratePipedKey() (key, hash string, err error)
• func GenerateRandomString(n int) string
• func IsCompletedDeployment(status DeploymentStatus) bool
• func IsCompletedStage(status StageStatus) bool
• type AnalysisProviderType
  • func (t AnalysisProviderType) String() string
• type CloudProviderType
  • func (t CloudProviderType) String() string
• type DataStoreType
  • func (t DataStoreType) String() string
• type Event
  • func (e Event) Group() EventGroup
• type FileStoreType
  • func (t FileStoreType) String() string
• type ImageName
  • func (i ImageName) Name() string
  • func (i ImageName) String() string
• type ImageProviderType
  • func (t ImageProviderType) String() string
• type ImageRef
  • func (i ImageRef) String() string
• type ReportableCommand
• type SealedSecretManagementType
  • func (t SealedSecretManagementType) String() string
• type Stage
  • func (s Stage) String() string

Constants

const DefaultDeploymentConfigFileName = ".pipe.yaml"

Functions

func ApplicationKindStrings

func ApplicationKindStrings() []string

ApplicationKindStrings returns a list of available deployment kinds in string.

func CanUpdateDeploymentStatus

func CanUpdateDeploymentStatus(cur, next DeploymentStatus) bool

CanUpdateDeploymentStatus checks whether the deployment can transit to the given status.

func CanUpdateStageStatus

func CanUpdateStageStatus(cur, next StageStatus) bool

CanUpdateStageStatus checks whether the stage can transit to the given status.

func DeploymentStatusStrings

func DeploymentStatusStrings() []string

DeploymentStatusStrings returns a list of available deployment statuses in string.

func ExtractAPIKeyID

func ExtractAPIKeyID(key string) (string, error)

func GenerateAPIKey

func GenerateAPIKey(id string) (key, hash string, err error)

func GeneratePipedKey

func GeneratePipedKey() (key, hash string, err error)

GeneratePipedKey generates a new key for piped. This returns raw key value for used by piped and a hash value of the key for storing in datastore.

func GenerateRandomString

func GenerateRandomString(n int) string

GenerateRandomString makes a random string with the given length. This implementation was referenced from the link below. https://stackoverflow.com/questions/22892120/how-to-generate-a-random-string-of-a-fixed-length-in-go

func IsCompletedDeployment

func IsCompletedDeployment(status DeploymentStatus) bool

IsCompletedDeployment checks whether the deployment is at a completion state.

func IsCompletedStage

func IsCompletedStage(status StageStatus) bool

IsCompletedStage checks whether the stage is at a completion state.

Types

type AnalysisProviderType

type AnalysisProviderType string

const (
	AnalysisProviderPrometheus  AnalysisProviderType = "PROMETHEUS"
	AnalysisProviderDatadog     AnalysisProviderType = "DATADOG"
	AnalysisProviderStackdriver AnalysisProviderType = "STACKDRIVER"
)

func (AnalysisProviderType) String

func (t AnalysisProviderType) String() string

type CloudProviderType

type CloudProviderType string

const (
	CloudProviderKubernetes CloudProviderType = "KUBERNETES"
	CloudProviderTerraform  CloudProviderType = "TERRAFORM"
	CloudProviderCloudRun   CloudProviderType = "CLOUDRUN"
	CloudProviderLambda     CloudProviderType = "LAMBDA"
)

func (CloudProviderType) String

func (t CloudProviderType) String() string

type DataStoreType

type DataStoreType string

const (
	DataStoreFirestore DataStoreType = "FIRESTORE"
	DataStoreDynamoDB  DataStoreType = "DYNAMODB"
	DataStoreMongoDB   DataStoreType = "MONGODB"
)

func (DataStoreType) String

func (t DataStoreType) String() string

type Event

type Event struct {
	Type     EventType
	Metadata interface{}
}

func (Event) Group

func (e Event) Group() EventGroup

type FileStoreType

type FileStoreType string

const (
	FileStoreGCS   FileStoreType = "GCS"
	FileStoreS3    FileStoreType = "S3"
	FileStoreMINIO FileStoreType = "MINIO"
)

func (FileStoreType) String

func (t FileStoreType) String() string

type ImageName

type ImageName struct {
	Domain string
	Repo   string
}

ImageName represents an untagged image. Note that images may have the domain omitted (e.g. Docker Hub). If they only have single path element, the prefix `library` is implied.

Examples:

• alpine
• library/alpine
• gcr.io/pipecd/helloworld

func (ImageName) Name

func (i ImageName) Name() string

Name gives back just repository name without domain.

func (ImageName) String

func (i ImageName) String() string

type ImageProviderType

type ImageProviderType string

const (
	ImageProviderTypeDockerHub ImageProviderType = "DOCKER_HUB"
	ImageProviderTypeGCR       ImageProviderType = "GCR"
	ImageProviderTypeECR       ImageProviderType = "ECR"
)

func (ImageProviderType) String

func (t ImageProviderType) String() string

type ImageRef

type ImageRef struct {
	ImageName
	Tag string
}

ImageRef represents a tagged image. The tag is allowed to be empty, though it is in general undefined what that means

Examples:

• alpine:3.0
• library/alpine:3.0
• gcr.io/pipecd/helloworld:0.1.0

func (ImageRef) String

func (i ImageRef) String() string

type ReportableCommand

type ReportableCommand struct {
	*Command
	Report func(ctx context.Context, status CommandStatus, metadata map[string]string) error
}

type SealedSecretManagementType

type SealedSecretManagementType string

const (
	SealedSecretManagementNone       SealedSecretManagementType = "NONE"
	SealedSecretManagementSealingKey SealedSecretManagementType = "SEALING_KEY"
	SealedSecretManagementGCPKMS     SealedSecretManagementType = "GCP_KMS"
	SealedSecretManagementAWSKMS     SealedSecretManagementType = "AWS_KMS"
)

func (SealedSecretManagementType) String

func (t SealedSecretManagementType) String() string

type Stage

type Stage string

Stage represents the middle and temporary state of application before reaching its final desired state.

const (
	// StageWait represents the waiting state for a specified period of time.
	StageWait Stage = "WAIT"
	// StageWaitApproval represents the waiting state until getting an approval
	// from one of the specified approvers.
	StageWaitApproval Stage = "WAIT_APPROVAL"
	// StageAnalysis represents the waiting state for analysing
	// the application status based on metrics, log, http request...
	StageAnalysis Stage = "ANALYSIS"

	// StageK8sSync represents the state where
	// all resources should be synced with the Git state.
	StageK8sSync Stage = "K8S_SYNC"
	// StageK8sPrimaryRollout represents the state where
	// the PRIMARY variant resources has been updated to the new version/configuration.
	StageK8sPrimaryRollout Stage = "K8S_PRIMARY_ROLLOUT"
	// StageK8sCanaryRollout represents the state where
	// the CANARY variant resources has been rolled out with the new version/configuration.
	StageK8sCanaryRollout Stage = "K8S_CANARY_ROLLOUT"
	// StageK8sCanaryClean represents the state where
	// the CANARY variant resources has been cleaned.
	StageK8sCanaryClean Stage = "K8S_CANARY_CLEAN"
	// StageK8sBaselineRollout represents the state where
	// the BASELINE variant resources has been rolled out.
	StageK8sBaselineRollout Stage = "K8S_BASELINE_ROLLOUT"
	// StageK8sBaselineClean represents the state where
	// the BASELINE variant resources has been cleaned.
	StageK8sBaselineClean Stage = "K8S_BASELINE_CLEAN"
	// StageK8sTrafficRouting represents the state where the traffic to application
	// should be splitted as the specified percentage to PRIMARY, CANARY, BASELINE variants.
	StageK8sTrafficRouting Stage = "K8S_TRAFFIC_ROUTING"

	// StageTerraformSync synced infrastructure with all the tf defined in Git.
	// Firstly, it does plan and if there are any changes detected it applies those changes automatically.
	StageTerraformSync Stage = "TERRAFORM_SYNC"
	// StageTerraformPlan shows terraform plan result.
	StageTerraformPlan Stage = "TERRAFORM_PLAN"
	// StageTerraformApply represents the state where
	// the new configuration has been applied.
	StageTerraformApply Stage = "TERRAFORM_APPLY"

	// StageCloudRunSync does quick sync by rolling out the new version
	// and switching all traffic to it.
	StageCloudRunSync Stage = "CLOUDRUN_SYNC"
	// StageCloudRunPromote promotes the new version to receive amount of traffic.
	StageCloudRunPromote Stage = "CLOUDRUN_PROMOTE"

	// StageLambdaSync does quick sync by rolling out the new version
	// and switching all traffic to it.
	StageLambdaSync Stage = "LAMBDA_SYNC"
	// StageLambdaCanaryRollout represents the state where
	// the workloads of the new version has been rolled out.
	StageLambdaCanaryRollout Stage = "LAMBDA_CANARY_ROLLOUT"
	// StageLambdaPromote prmotes the new version to receive amount of traffic.
	StageLambdaPromote Stage = "LAMBDA_PROMOTE"

	// StageRollback represents a state where
	// the all temporarily created stages will be reverted to
	// bring back the pre-deploy stage.
	// This stage is AUTOMATICALLY GENERATED and can not be used
	// to specify in configuration file.
	StageRollback Stage = "ROLLBACK"
)

func (Stage) String

func (s Stage) String() string