mirror of
https://github.com/sourcegraph/sourcegraph.git
synced 2026-02-06 15:51:43 +00:00
6c59b02534
Closes CORE-121 The dependency on the generated `tfvars` file is frustrating for first-time MSP setup because it currently requires `-stable=false` to update, and doesn't actually serve any purpose for deploy types other than `subscription` (which uses it to isolate image changes that happen on via GitHub actions). This makes it so that we don't generate, or depend on, the dynamic `tfvars` file unless you are using `subscription`. I've also added a rollout spec configuration, `initialImageTag`, to make the initial tag we provision environments with configurable (as some services might not publish `insiders` images) - see the docstring. ## Test plan Inspect output of `sg msp generate -all`
103 lines
3.5 KiB
Go
103 lines
3.5 KiB
Go
package spec
|
|
|
|
type RolloutSpec struct {
|
|
// Stages specifies the order and environments through which releases
|
|
// progress.
|
|
Stages []RolloutStageSpec `yaml:"stages"`
|
|
// Suspended prevents releases and rollouts from being created, rolled back,
|
|
// etc using this rollout pipeline pipeline: https://cloud.google.com/deploy/docs/suspend-pipeline
|
|
//
|
|
// Set to true to prevent all deployments from being created through Cloud
|
|
// Deploy. Note that this does NOT prevent manual deploys from happening
|
|
// directly in Cloud Run.
|
|
Suspended *bool `yaml:"suspended,omitempty"`
|
|
// ServiceAccount is the email address of the service account to provision IAM access to create
|
|
// releases for. Can be used to give access to the Service Account used in your CI pipeline,
|
|
// instead of using the default releaser SA that MSP provisions.
|
|
ServiceAccount *string `yaml:"serviceAccount,omitempty"`
|
|
// InitialImageTag is the image tag to use by default. This is mostly used to
|
|
// provision the first revision of a Cloud Run service/job for an environment,
|
|
// after which Cloud Deploy manages the image used for Cloud Run revisions.
|
|
//
|
|
// This only needs to be set if the default image tag 'insiders' does not
|
|
// correspond to an image tag that is available for this service's images.
|
|
InitialImageTag *string `yaml:"initialImageTag,omitempty"`
|
|
}
|
|
|
|
func (r *RolloutSpec) GetStageByEnvironment(id string) *RolloutStageSpec {
|
|
if r == nil {
|
|
return nil
|
|
}
|
|
for _, stage := range r.Stages {
|
|
if stage.EnvironmentID == id {
|
|
return &stage
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (r *RolloutSpec) GetInitialImageTag() string {
|
|
if r.InitialImageTag != nil {
|
|
return *r.InitialImageTag
|
|
}
|
|
return "insiders"
|
|
}
|
|
|
|
type RolloutStageSpec struct {
|
|
// EnvironmentID is the ID of the environment to use in this stage.
|
|
// The specified environment MUST have 'deploy: { type: "rollout" }' configured.
|
|
EnvironmentID string `yaml:"environment"`
|
|
}
|
|
|
|
// RolloutPipelineConfiguration is rendered from BuildPipelineConfiguration for use in
|
|
// stacks.
|
|
type RolloutPipelineConfiguration struct {
|
|
isFinalStage bool
|
|
// Stages is evaluated from OriginalSpec.Stages to include attributes
|
|
// required to actually configure the stages.
|
|
Stages []rolloutPipelineTargetConfiguration
|
|
|
|
OriginalSpec RolloutSpec
|
|
}
|
|
|
|
// IsFinalStage indicates if the env used for this RolloutPipelineConfiguration
|
|
// is the final stage in the rollout pipeline. If nil, this returns false.
|
|
func (s *RolloutPipelineConfiguration) IsFinalStage() bool {
|
|
if s == nil {
|
|
return false
|
|
}
|
|
return s.isFinalStage
|
|
}
|
|
|
|
// rolloutPipelineTargetConfiguration is an internal type that extends
|
|
// RolloutStageSpec with other top-level environment spec.
|
|
type rolloutPipelineTargetConfiguration struct {
|
|
RolloutStageSpec
|
|
// ProjectID is the project the target environmet lives in.
|
|
ProjectID string
|
|
}
|
|
|
|
// BuildRolloutPipelineConfiguration evaluates a configuration for use in
|
|
// configuring a Cloud Deploy pipeline in the final environment of a rollout
|
|
// spec's stages.
|
|
func (s Spec) BuildRolloutPipelineConfiguration(env EnvironmentSpec) *RolloutPipelineConfiguration {
|
|
if s.Rollout == nil {
|
|
return nil
|
|
}
|
|
|
|
var targets []rolloutPipelineTargetConfiguration
|
|
for _, stage := range s.Rollout.Stages {
|
|
env := s.GetEnvironment(stage.EnvironmentID)
|
|
targets = append(targets, rolloutPipelineTargetConfiguration{
|
|
ProjectID: env.ProjectID,
|
|
RolloutStageSpec: stage,
|
|
})
|
|
}
|
|
finalStageEnv := s.Rollout.Stages[len(s.Rollout.Stages)-1].EnvironmentID
|
|
return &RolloutPipelineConfiguration{
|
|
isFinalStage: finalStageEnv == env.ID,
|
|
Stages: targets,
|
|
OriginalSpec: *s.Rollout,
|
|
}
|
|
}
|