types

type ARMStackStep struct {
	StepMeta        `json:",inline"`
	Variables       []Variable `json:"variables,omitempty"`
	Template        string     `json:"template,omitempty"`
	Parameters      string     `json:"parameters,omitempty"`
	DeploymentLevel string     `json:"deploymentLevel,omitempty"`

	// ActionOnUnmanage specifies what action to take when a resource previously owned by the deployment stack is no longer
	// specified. 'delete' will delete the resource, 'detach' will leave it as-is.
	ActionOnUnmanage string `json:"actionOnUnmanage,omitempty"`
	// BypassStackOutOfSyncError allows bypassing service errors that indicate the stack resource list is not correctly synchronized.
	BypassStackOutOfSyncError bool `json:"bypassStackOutOfSyncError,omitempty"`
}

type ARMStep struct {
	StepMeta        `json:",inline"`
	Variables       []Variable `json:"variables,omitempty"`
	Template        string     `json:"template,omitempty"`
	Parameters      string     `json:"parameters,omitempty"`
	DeploymentLevel string     `json:"deploymentLevel,omitempty"`
	OutputOnly      bool       `json:"outputOnly,omitempty"`
	DeploymentMode  string     `json:"deploymentMode,omitempty"`
}

type AdoArtifactDownloadPipelineReference struct {
	ADOProject   string `json:"adoProject,omitempty"`
	ArtifactName string `json:"artifactName,omitempty"`
	BuildID      string `json:"buildId,omitempty"`

	// FileSourceToDestination is a mapping of source file paths within the artifact to destination file paths in the local filesystem.
	FileSourceToDestination map[string]string `json:"fileSourceToDestination,omitempty"`
}

type AutomatedRetry struct {
	// ErrorContainsAny determines when a retry should run - if the output of a step contains any of
	// the strings in this array, matching in a case-insensitive manner, a retry will fire.
	// Must contain 16 or fewer items; the total encoded length of this array may not be more than 1KB.
	ErrorContainsAny []string `json:"errorContainsAny,omitempty"`

	// MaximumRetryCount is the maximum number of retires that should fire. Between 1 and 10, defaults to 1.
	MaximumRetryCount int `json:"maximumRetryCount,omitempty"`

	// DurationBetweenRetries is the amount of time to wait between retries. Must be between 1 minute and 3 hours.
	// Formatted using Go's time.Duration syntax.
	DurationBetweenRetries string `json:"durationBetweenRetries,omitempty"`
}

type BuildStep struct {
	// Command is the command to run for the build step.
	Command string `json:"command"`

	// Args are the command-line arguments to pass to the build step.
	Args []string `json:"args"`
}

type CreateCertificateStep struct {
	StepMeta        `json:",inline"`
	VaultBaseUrl    Value `json:"vaultBaseUrl,omitempty"`
	CertificateName Value `json:"certificateName,omitempty"`
	ContentType     Value `json:"contentType,omitempty"`
	SAN             Value `json:"san,omitempty"`
	Issuer          Value `json:"issuer,omitempty"`
	SecretKeyVault  Value `json:"secretKeyVault,omitempty"`
	SecretName      Value `json:"secretName,omitempty"`
	ApplicationId   Value `json:"applicationId,omitempty"`
	CommonName      Value `json:"commonName,omitempty"`
}

type DelegateChildZoneStep struct {
	StepMeta       `json:",inline"`
	ParentZone     Value `json:"parentZone,omitempty"`
	ChildZone      Value `json:"childZone,omitempty"`
	SecretKeyVault Value `json:"secretKeyVault,omitempty"`
	SecretName     Value `json:"secretName,omitempty"`
	DstsHost       Value `json:"dstsHost,omitempty"`
}

type DryRun struct {
	Variables []Variable `json:"variables,omitempty"`
	Command   string     `json:"command,omitempty"`
}

type Ev2RegistrationStep struct {
	StepMeta     `json:",inline"`
	IdentityFrom Input `json:"identityFrom,omitempty"`
}

type Event struct {
	Name    string `json:"name,omitempty"`
	Account string `json:"account,omitempty"`
}

type ExecutionConstraint struct {
	// Singleton defines this pipeline to run once - ever - in the entire history of the universe. No re-deployments
	// will be allowed.
	Singleton bool `json:"singleton"`

	// Clouds define the clouds in which this pipeline should run. If unset, execution will be unconstrained across clouds.
	Clouds []string `json:"clouds,omitempty"`
	// Environments define the environments in which this pipeline should run, for the given clouds. If unset, execution will be unconstrained across environments.
	Environments []string `json:"environments,omitempty"`
	// Regions define the regions in which this pipeline should run, for the given clouds and environments. If unset, execution will be unconstrained across regions.
	Regions []string `json:"regions,omitempty"`
}

type ExternalStepDependency struct {
	// ServiceGroup declares which service group the external dependency belongs to.
	ServiceGroup   string `json:"serviceGroup"`
	StepDependency `json:",inline"`
}

type FeatureRegistrationStep struct {
	StepMeta          `json:",inline"`
	SecretKeyVault    Value  `json:"secretKeyVault,omitempty"`
	SecretName        Value  `json:"secretName,omitempty"`
	ProviderConfigRef string `json:"providerConfigRef,omitempty"`
}

type GenericStep struct {
	StepMeta `json:",inline"`
}

type GenericValidationStep struct {
	StepMeta   `json:",inline"`
	Validation []string `json:"validation,omitempty"`
}

type HelmStep struct {
	StepMeta `json:",inline"`

	// AKSCluster is the name of the AKS cluster onto which this Helm release will be deployed.
	AKSCluster string `json:"aksCluster"`
	// SubnetName is an optional specifier for the name of the subnet to which the deployer must connect to before
	// accessing the AKS cluster. Provide this value when deploying to private clusters.
	SubnetName string `json:"subnetName,omitempty"`

	// ReleaseName is the semantically-meaningful name of the Helm release. The first deployment for a given name
	// will install the Helm chart, further deployments to the same name will upgrade it.
	ReleaseName string `json:"releaseName"`
	// ReleaseNamespace is the name of the namespace in which the Helm release should be deployed, analogous to the
	// --namespace flag for the Helm CLI. This namespace will be created before the Helm release is installed.
	ReleaseNamespace string `json:"releaseNamespace"`
	// NamespaceFiles specify namespaces that must be created before the Helm release is installed. It is *not* required
	// to specify the release namespace manifest here, but it may be present if a complex configuration (with labels,
	// annotations, spec, etc.) is required. By default, the release namespace will be created with no additional fields
	// set if no additional manifests are specified in this field.
	// NOTE: These files will be pre-processed as Go templates to resolve configuration fields and input variables.
	NamespaceFiles []string `json:"namespaceFiles,omitempty"`
	// ChartDir is the relative path from the pipeline configuration to the chart being deployed.
	ChartDir string `json:"chartDir"`
	// ValuesFile is the path to the Helm values file to use when deploying the Helm release.
	// NOTE: This file will be pre-processed as a Go template to resolve configuration fields and input variables.
	ValuesFile string `json:"valuesFile,omitempty"`

	// KustoDatabase is the name of the Kusto database within the cluster that holds the logs for this Helm deployment.
	KustoDatabase string `json:"kustoDatabase,omitempty"`
	// KustoTable is the name of the Kusto table that holds the logs for this Helm deployment within the appropriate cluster/database.
	KustoTable string `json:"kustoTable,omitempty"`
	// KustoEndpoint is the input that provides the Kusto endpoint URI for this Helm deployment.
	KustoEndpoint *Input `json:"kustoEndpoint,omitempty"`

	// InputVariables records a mapping from variable names to the output variable that provides the value.
	// For some input variable like:
	//     inputVariables:
	//       someImportantThing:
	//         resourceGroup: regional
	//         step: output
	//         name: outputVariableName
	// Refer to this value in the namespace files or values.yaml with __someImportantThing__.
	InputVariables map[string]Input `json:"inputVariables,omitempty"`

	// IdentityFrom specifies the managed identity with which this deployment will run in Ev2.
	IdentityFrom Input `json:"identityFrom,omitempty"`

	// Timeout is the amount of time to wait for the Helm release to be deployed.
	Timeout string `json:"timeout,omitempty"`

	// RollbackOnFailure indicates whether to rollback to previous version after upgrade failure and uninstall on install failure.
	RollbackOnFailure bool `json:"rollbackOnFailure,omitempty"`
}

type ImageMirrorStep struct {
	StepMeta `json:",inline"`

	TargetACR             Value  `json:"targetACR,omitempty"`
	SourceRegistry        Value  `json:"sourceRegistry,omitempty"`
	Repository            Value  `json:"repository,omitempty"`
	Digest                Value  `json:"digest,omitempty"`
	CopyFrom              string `json:"copyFrom,omitempty"`
	ImageFilePath         Value  `json:"imageFilePath,omitempty"` // optional, if path is same as pipeline.yaml
	ImageTarFileName      Value  `json:"imageTarFileName,omitempty"`
	ImageMetadataFileName Value  `json:"imageMetadataFileName,omitempty"`
	PullSecretKeyVault    Value  `json:"pullSecretKeyVault,omitempty"`
	PullSecretName        Value  `json:"pullSecretName,omitempty"`
	ShellIdentity         Value  `json:"shellIdentity,omitempty"`
	ADOProject            string `json:"adoProject,omitempty"`
	ArtifactName          string `json:"artifactName,omitempty"`
	BuildID               string `json:"buildId,omitempty"`
}

type Input struct {
	// StepDependency declares from which step we are consuming the output variable.
	StepDependency `json:",inline"`
	// Name is the output variable we consume for input chaining.
	Name string `json:"name"`
}

type KustoStep struct {
	StepMeta         `json:",inline"`
	SecretKeyVault   Value `json:"secretKeyVault,omitempty"`
	SecretName       Value `json:"secretName,omitempty"`
	ApplicationId    Value `json:"applicationId,omitempty"`
	ConnectionString Value `json:"connectionString,omitempty"`
	Command          Value `json:"command,omitempty"`
}

type LogsStep struct {
	StepMeta             `json:",inline"`
	RolloutKind          string           `json:"rolloutKind,omitempty"`
	TypeName             Value            `json:"typeName"`
	SecretKeyVault       Value            `json:"secretKeyVault,omitempty"`
	SecretName           Value            `json:"secretName,omitempty"`
	Environment          Value            `json:"environment"`
	AccountName          Value            `json:"accountName"`
	MetricsAccount       Value            `json:"metricsAccount"`
	AdminAlias           Value            `json:"adminAlias"`
	AdminGroup           Value            `json:"adminGroup"`
	SubscriptionId       Value            `json:"subscriptionId,omitempty"`
	Namespace            Value            `json:"namespace,omitempty"`
	CertSAN              Value            `json:"certsan,omitempty"`
	CertDescription      Value            `json:"certdescription,omitempty"`
	ConfigVersion        Value            `json:"configVersion,omitempty"`
	MonikerDefaultRegion Value            `json:"monikerDefaultRegion,omitempty"`
	Database             Value            `json:"database,omitempty"`
	EventSources         map[string]Event `json:"eventSources,omitempty"`
}

type Pav2Step struct {
	StepMeta                   `json:",inline"`
	SecretKeyVault             Value  `json:"secretKeyVault,omitempty"`
	SecretName                 Value  `json:"secretName,omitempty"`
	StorageAccount             Value  `json:"storageAccount,omitempty"`
	SMEEndpointSuffixParameter Value  `json:"smeEndpointSuffixParameter,omitempty"`
	SMEAppidParameter          Value  `json:"smeAppidParameter,omitempty"`
	Operation                  string `json:"operation,omitempty"`
}

type Pipeline struct {
	Schema         string           `json:"$schema,omitempty"`
	ServiceGroup   string           `json:"serviceGroup"`
	RolloutName    string           `json:"rolloutName"`
	ResourceGroups []*ResourceGroup `json:"resourceGroups"`
	BuildStep      *BuildStep       `json:"buildStep,omitempty"`
}

type ProviderFeatureRegistrationStep struct {
	StepMeta          `json:",inline"`
	ProviderConfigRef string `json:"providerConfigRef,omitempty"`
	IdentityFrom      Input  `json:"identityFrom,omitempty"`
}

type Reference struct {
	// Environment variable name
	Name string `json:"name"`

	// The path to a file.
	FilePath string `json:"filepath"`
}

type ResourceGroup struct {
	*ResourceGroupMeta `json:",inline"`

	SubscriptionProvisioning *SubscriptionProvisioning `json:"subscriptionProvisioning,omitempty"`

	Steps           Steps           `json:"steps"`
	ValidationSteps ValidationSteps `json:"validationSteps,omitempty"`
}

type ResourceGroupMeta struct {
	// Name is the semantic identifier for this group of steps - it must be short and should be shared between pipelines that
	// do work in the same Azure resource group.
	Name string `json:"name"`
	// ResourceGroup is the name of the Azure resource group in which work will occur.
	ResourceGroup string `json:"resourceGroup"`
	// Subscription is the subscription *key* in which work will occur.
	Subscription string `json:"subscription"`

	// ExecutionConstraints define a set of constraints on where this pipeline should be executed.
	// If unset, the default behavior is to deploy to all clouds, environments, regions, and stamps.
	// The set of constraints are evaluated using logical OR - adding to the list adds a set of possible
	// deployment environments.
	ExecutionConstraints []ExecutionConstraint `json:"executionConstraints,omitempty"`
}

type ResourceProviderRegistrationStep struct {
	StepMeta                   `json:",inline"`
	ResourceProviderNamespaces Value `json:"resourceProviderNamespaces,omitempty"`
}

type SecretSyncStep struct {
	StepMeta          `json:",inline"`
	ConfigurationFile string `json:"configurationFile,omitempty"`
	KeyVault          string `json:"keyVault,omitempty"`
	EncryptionKey     string `json:"encryptionKey,omitempty"`
	IdentityFrom      Input  `json:"identityFrom,omitempty"`
}

type SetCertificateIssuerStep struct {
	StepMeta       `json:",inline"`
	VaultBaseUrl   Value `json:"vaultBaseUrl,omitempty"`
	Issuer         Value `json:"issuer,omitempty"`
	SecretKeyVault Value `json:"secretKeyVault,omitempty"`
	SecretName     Value `json:"secretName,omitempty"`
	ApplicationId  Value `json:"applicationId,omitempty"`
}

type ShellStep struct {
	StepMeta   `json:",inline"`
	AKSCluster string      `json:"aksCluster,omitempty"`
	Command    string      `json:"command,omitempty"`
	Variables  []Variable  `json:"variables,omitempty"`
	DryRun     DryRun      `json:"dryRun,omitempty"`
	References []Reference `json:"references,omitempty"`
	SubnetName string      `json:"subnetName,omitempty"`
	// WorkingDir is the relative path from the pipeline definition to the directory which will be the *only* content
	// available to the shell during execution. If and only if this is set will a shell step be eligible for being skipped
	// during incremental execution; it is in the best interest of the author to contain the smallest amount of content
	// in the directory, as any change to any input will cause a re-run. Validation will ensure that this directory does
	// not escape the root directory of the pipeline. `$PWD` for the shell commands will be this directory.
	WorkingDir string `json:"workingDir,omitempty"`
	// ShellIdentity is the ID of the managed identity with which the shell step will execute in an Ev2 context. Required.
	ShellIdentity Value `json:"shellIdentity"`
	// AdoArtifacts is a list of Azure DevOps artifacts to download before executing the shell step.
	AdoArtifacts []AdoArtifactDownloadPipelineReference `json:"adoArtifacts,omitempty"`
}

type ShellValidationStep struct {
	ShellStep  `json:",inline"`
	Validation []string `json:"validation,omitempty"`
}

type Step interface {
	WellFormedChecker
	StepName() string
	ActionType() string
	Description() string
	Dependencies() []StepDependency
	RequiredInputs() []StepDependency
	ExternalDependencies() []ExternalStepDependency
	AutomatedRetries() *AutomatedRetry
	ConsideredForServiceGroupCompletion() bool
}

type StepDependency struct {
	// ResourceGroup is the (semantic/display) name of the group to which the step belongs.
	ResourceGroup string `json:"resourceGroup"`
	// Step is the name of the step being depended on.
	Step string `json:"step"`
}

type StepMeta struct {
	Name              string                   `json:"name"`
	Action            string                   `json:"action"`
	AutomatedRetry    *AutomatedRetry          `json:"automatedRetry,omitempty"`
	DependsOn         []StepDependency         `json:"dependsOn,omitempty"`
	ExternalDependsOn []ExternalStepDependency `json:"externalDependsOn,omitempty"`

	// OmitFromServiceGroupCompletion influences how this step is treated in execution graphs containing multiple
	// service groups - by default, *all* leaf nodes of a service group must finish before *any* root nodes of
	// dependent service groups begin. Setting this flag will omit this particular step from that set of leaf nodes
	// that block execution of dependent steps.
	OmitFromServiceGroupCompletion bool `json:"omitFromServiceGroupCompletion,omitempty"`
}

type Steps []Step

type SubscriptionProvisioning struct {
	DisplayName                   Value  `json:"displayName"`
	AIRSRegisteredUserPrincipalId *Value `json:"airsRegisteredUserPrincipalId,omitempty"`
	CertificateDomains            *Value `json:"certificateDomains,omitempty"`
	BackfillSubscriptionId        *Value `json:"backfillSubscriptionId,omitempty"`

	// RoleAssignmentParameters is a relative path to the .bicepparam file used to deploy the bootstrapping role-assignments
	// for this subscription. Keep in mind that once Ev2 marks a subscription as provisioned, this will not run, so the contents
	// of this ARM template cannot change over time as the template will not be re-executed on existing subscriptions.
	RoleAssignmentParameters string `json:"roleAssignment,omitempty"`
}

type ValidationStep interface {
	Step
	Validations() []string
}

type ValidationSteps []ValidationStep

type Value struct {
	Value     any    `json:"value,omitempty"`
	ConfigRef string `json:"configRef,omitempty"`
	Input     *Input `json:"input,omitempty"`
}

type Variable struct {
	Name  string `json:"name,omitempty"`
	Value `json:",inline"`
}

type WellFormedChecker interface {
	// IsWellFormedOverInputs determines if, given the same (visible) inputs, this step will have the same outputs.
	// Implicit inputs on the filesystem outside the purview of any configuration make a step ill-formed.
	IsWellFormedOverInputs() bool
}