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
76 lines
4.1 KiB
Go
76 lines
4.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"
|
|
"github.com/pulumi/pulumi/pkg/util/contract"
|
|
)
|
|
|
|
// State is a structure containing state associated with a resource. This resource may have been serialized and
|
|
// deserialized, or snapshotted from a live graph of resource objects. The value's state is not, however, associated
|
|
// with any runtime objects in memory that may be actively involved in ongoing computations.
|
|
// nolint: lll
|
|
type State struct {
|
|
Type tokens.Type // the resource's type.
|
|
URN URN // the resource's object urn, a human-friendly, unique name for the resource.
|
|
Custom bool // true if the resource is custom, managed by a plugin.
|
|
Delete bool // true if this resource is pending deletion due to a replacement.
|
|
ID ID // the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).
|
|
Inputs PropertyMap // the resource's input properties (as specified by the program).
|
|
Outputs PropertyMap // the resource's complete output state (as returned by the resource provider).
|
|
Parent URN // an optional parent URN that this resource belongs to.
|
|
Protect bool // true to "protect" this resource (protected resources cannot be deleted).
|
|
External bool // true if this resource is "external" to Pulumi and we don't control the lifecycle
|
|
Dependencies []URN // the resource's dependencies
|
|
InitErrors []string // the set of errors encountered in the process of initializing resource.
|
|
Provider string // the provider to use for this resource.
|
|
PropertyDependencies map[PropertyKey][]URN // the set of dependencies that affect each property.
|
|
PendingReplacement bool // true if this resource was deleted and is awaiting replacement.
|
|
AdditionalSecretOutputs []PropertyKey // an additional set of outputs that should be treated as secrets.
|
|
Aliases []URN // TODO
|
|
}
|
|
|
|
// NewState creates a new resource value from existing resource state information.
|
|
func NewState(t tokens.Type, urn URN, custom bool, del bool, id ID,
|
|
inputs PropertyMap, outputs PropertyMap, parent URN, protect bool,
|
|
external bool, dependencies []URN, initErrors []string, provider string,
|
|
propertyDependencies map[PropertyKey][]URN, pendingReplacement bool,
|
|
additionalSecretOutputs []PropertyKey, aliases []URN) *State {
|
|
|
|
contract.Assertf(t != "", "type was empty")
|
|
contract.Assertf(custom || id == "", "is custom or had empty ID")
|
|
contract.Assertf(inputs != nil, "inputs was non-nil")
|
|
return &State{
|
|
Type: t,
|
|
URN: urn,
|
|
Custom: custom,
|
|
Delete: del,
|
|
ID: id,
|
|
Inputs: inputs,
|
|
Outputs: outputs,
|
|
Parent: parent,
|
|
Protect: protect,
|
|
External: external,
|
|
Dependencies: dependencies,
|
|
InitErrors: initErrors,
|
|
Provider: provider,
|
|
PropertyDependencies: propertyDependencies,
|
|
PendingReplacement: pendingReplacement,
|
|
AdditionalSecretOutputs: additionalSecretOutputs,
|
|
Aliases: aliases,
|
|
}
|
|
}
|