15e924b5cf
Adds a new resource option `aliases` which can be used to rename a resource. When making a breaking change to the name or type of a resource or component, the old name can be added to the list of `aliases` for a resource to ensure that existing resources will be migrated to the new name instead of being deleted and replaced with the new named resource. There are two key places this change is implemented. The first is the step generator in the engine. When computing whether there is an old version of a registered resource, we now take into account the aliases specified on the registered resource. That is, we first look up the resource by its new URN in the old state, and then by any aliases provided (in order). This can allow the resource to be matched as a (potential) update to an existing resource with a different URN. The second is the core `Resource` constructor in the JavaScript (and soon Python) SDKs. This change ensures that when a parent resource is aliased, that all children implicitly inherit corresponding aliases. It is similar to how many other resource options are "inherited" implicitly from the parent. Four specific scenarios are explicitly tested as part of this PR: 1. Renaming a resource 2. Adopting a resource into a component (as the owner of both component and consumption codebases) 3. Renaming a component instance (as the owner of the consumption codebase without changes to the component) 4. Changing the type of a component (as the owner of the component codebase without changes to the consumption codebase) 4. Combining (1) and (3) to make both changes to a resource at the same time
63 lines
3.1 KiB
Go
63 lines
3.1 KiB
Go
// Copyright 2016-2018, Pulumi Corporation.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package resource
|
|
|
|
import (
|
|
"github.com/pulumi/pulumi/pkg/tokens"
|
|
)
|
|
|
|
// Goal is a desired state for a resource object. Normally it represents a subset of the resource's state expressed by
|
|
// a program, however if Output is true, it represents a more complete, post-deployment view of the state.
|
|
type Goal struct {
|
|
Type tokens.Type // the type of resource.
|
|
Name tokens.QName // the name for the resource's URN.
|
|
Custom bool // true if this resource is custom, managed by a plugin.
|
|
Properties PropertyMap // the resource's property state.
|
|
Parent URN // an optional parent URN for this resource.
|
|
Protect bool // true to protect this resource from deletion.
|
|
Dependencies []URN // dependencies of this resource object.
|
|
Provider string // the provider to use for this resource.
|
|
InitErrors []string // errors encountered as we attempted to initialize the resource.
|
|
PropertyDependencies map[PropertyKey][]URN // the set of dependencies that affect each property.
|
|
DeleteBeforeReplace bool // true if this resource should be deleted prior to replacement.
|
|
IgnoreChanges []string // a list of property names to ignore during changes.
|
|
AdditionalSecretOutputs []PropertyKey // outputs that should always be treated as secrets.
|
|
Aliases []URN // additional URNs that should be aliased to this resource.
|
|
}
|
|
|
|
// NewGoal allocates a new resource goal state.
|
|
func NewGoal(t tokens.Type, name tokens.QName, custom bool, props PropertyMap,
|
|
parent URN, protect bool, dependencies []URN, provider string, initErrors []string,
|
|
propertyDependencies map[PropertyKey][]URN, deleteBeforeReplace bool, ignoreChanges []string,
|
|
additionalSecretOutputs []PropertyKey, aliases []URN) *Goal {
|
|
|
|
return &Goal{
|
|
Type: t,
|
|
Name: name,
|
|
Custom: custom,
|
|
Properties: props,
|
|
Parent: parent,
|
|
Protect: protect,
|
|
Dependencies: dependencies,
|
|
Provider: provider,
|
|
InitErrors: initErrors,
|
|
PropertyDependencies: propertyDependencies,
|
|
DeleteBeforeReplace: deleteBeforeReplace,
|
|
IgnoreChanges: ignoreChanges,
|
|
AdditionalSecretOutputs: additionalSecretOutputs,
|
|
Aliases: aliases,
|
|
}
|
|
}
|