2018-05-22 21:43:36 +02:00
|
|
|
// 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.
|
2017-02-10 17:55:26 +01:00
|
|
|
|
|
|
|
syntax = "proto3";
|
|
|
|
|
2017-12-01 22:50:32 +01:00
|
|
|
import "plugin.proto";
|
2017-02-10 17:55:26 +01:00
|
|
|
import "google/protobuf/empty.proto";
|
|
|
|
import "google/protobuf/struct.proto";
|
|
|
|
|
2017-09-22 04:18:21 +02:00
|
|
|
package pulumirpc;
|
2017-02-10 17:55:26 +01:00
|
|
|
|
|
|
|
// ResourceProvider is a service that understands how to create, read, update, or delete resources for types defined
|
2017-06-24 20:55:16 +02:00
|
|
|
// within a single package. It is driven by the overall planning engine in response to resource diffs.
|
2017-02-10 17:55:26 +01:00
|
|
|
service ResourceProvider {
|
2020-02-28 01:10:47 +01:00
|
|
|
// GetSchema fetches the schema for this resource provider.
|
|
|
|
rpc GetSchema(GetSchemaRequest) returns (GetSchemaResponse) {}
|
|
|
|
|
2019-03-05 19:49:24 +01:00
|
|
|
// CheckConfig validates the configuration for this resource provider.
|
|
|
|
rpc CheckConfig(CheckRequest) returns (CheckResponse) {}
|
|
|
|
// DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider.
|
|
|
|
rpc DiffConfig(DiffRequest) returns (DiffResponse) {}
|
2017-08-31 23:31:33 +02:00
|
|
|
// Configure configures the resource provider with "globals" that control its behavior.
|
2019-04-12 20:21:38 +02:00
|
|
|
rpc Configure(ConfigureRequest) returns (ConfigureResponse) {}
|
2019-03-05 19:49:24 +01:00
|
|
|
|
2017-09-27 21:34:44 +02:00
|
|
|
// Invoke dynamically executes a built-in function in the provider.
|
|
|
|
rpc Invoke(InvokeRequest) returns (InvokeResponse) {}
|
2019-03-05 19:49:24 +01:00
|
|
|
|
2019-10-22 08:02:32 +02:00
|
|
|
// StreamInvoke dynamically executes a built-in function in the provider, which returns a stream
|
|
|
|
// of responses.
|
|
|
|
rpc StreamInvoke(InvokeRequest) returns (stream InvokeResponse) {}
|
|
|
|
|
2017-12-03 01:34:16 +01:00
|
|
|
// Check validates that the given property bag is valid for a resource of the given type and returns the inputs
|
2017-12-08 22:28:54 +01:00
|
|
|
// that should be passed to successive calls to Diff, Create, or Update for this resource. As a rule, the provider
|
|
|
|
// inputs returned by a call to Check should preserve the original representation of the properties as present in
|
|
|
|
// the program inputs. Though this rule is not required for correctness, violations thereof can negatively impact
|
|
|
|
// the end-user experience, as the provider inputs are using for detecting and rendering diffs.
|
2017-08-01 03:26:15 +02:00
|
|
|
rpc Check(CheckRequest) returns (CheckResponse) {}
|
|
|
|
// Diff checks what impacts a hypothetical update will have on the resource's properties.
|
|
|
|
rpc Diff(DiffRequest) returns (DiffResponse) {}
|
2017-02-10 17:55:26 +01:00
|
|
|
// Create allocates a new instance of the provided resource and returns its unique ID afterwards. (The input ID
|
2020-01-13 19:45:07 +01:00
|
|
|
// must be blank.) If this call fails, the resource must not have been created (i.e., it is "transactional").
|
2017-02-10 17:55:26 +01:00
|
|
|
rpc Create(CreateRequest) returns (CreateResponse) {}
|
2018-04-05 16:00:16 +02:00
|
|
|
// Read the current live state associated with a resource. Enough state must be include in the inputs to uniquely
|
|
|
|
// identify the resource; this is typically just the resource ID, but may also include some properties.
|
|
|
|
rpc Read(ReadRequest) returns (ReadResponse) {}
|
2017-03-02 18:52:08 +01:00
|
|
|
// Update updates an existing resource with new values.
|
2017-07-18 03:44:45 +02:00
|
|
|
rpc Update(UpdateRequest) returns (UpdateResponse) {}
|
2017-02-10 17:55:26 +01:00
|
|
|
// Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.
|
|
|
|
rpc Delete(DeleteRequest) returns (google.protobuf.Empty) {}
|
2019-03-05 19:49:24 +01:00
|
|
|
|
2018-07-12 03:07:50 +02:00
|
|
|
// Cancel signals the provider to abort all outstanding resource operations.
|
|
|
|
rpc Cancel(google.protobuf.Empty) returns (google.protobuf.Empty) {}
|
2017-12-01 22:50:32 +01:00
|
|
|
// GetPluginInfo returns generic information about this plugin, like its version.
|
|
|
|
rpc GetPluginInfo(google.protobuf.Empty) returns (PluginInfo) {}
|
2017-02-10 17:55:26 +01:00
|
|
|
}
|
|
|
|
|
2020-02-28 01:10:47 +01:00
|
|
|
message GetSchemaRequest {
|
|
|
|
int32 version = 1; // the schema version.
|
|
|
|
}
|
|
|
|
|
|
|
|
message GetSchemaResponse {
|
|
|
|
string schema = 1; // the JSON-encoded schema.
|
|
|
|
}
|
|
|
|
|
2017-08-31 23:31:33 +02:00
|
|
|
message ConfigureRequest {
|
|
|
|
map<string, string> variables = 1; // a map of configuration keys to values.
|
2019-03-05 19:49:24 +01:00
|
|
|
google.protobuf.Struct args = 2; // the input properties for the provider. Only filled in for newer providers.
|
2019-04-12 20:21:38 +02:00
|
|
|
bool acceptSecrets = 3; // when true operations should retrun secrets as strongly typed.
|
|
|
|
}
|
|
|
|
|
|
|
|
message ConfigureResponse {
|
|
|
|
bool acceptSecrets = 1; // when true, the engine should pass secrets as strongly typed values to the provider.
|
2017-08-31 23:31:33 +02:00
|
|
|
}
|
|
|
|
|
2018-04-04 19:08:17 +02:00
|
|
|
// ConfigureErrorMissingKeys is sent as a Detail on an error returned from `ResourceProvider.Configure`.
|
|
|
|
message ConfigureErrorMissingKeys {
|
|
|
|
message MissingKey {
|
|
|
|
string name = 1; // the Pulumi name (not the provider name!) of the missing config key.
|
|
|
|
string description = 2; // a description of the missing config key, as reported by the provider.
|
|
|
|
}
|
|
|
|
|
|
|
|
repeated MissingKey missingKeys = 1; // a list of required configuration keys that were not supplied.
|
|
|
|
}
|
|
|
|
|
2017-09-27 21:34:44 +02:00
|
|
|
message InvokeRequest {
|
|
|
|
string tok = 1; // the function token to invoke.
|
|
|
|
google.protobuf.Struct args = 2; // the arguments for the function invocation.
|
Implement first-class providers. (#1695)
### First-Class Providers
These changes implement support for first-class providers. First-class
providers are provider plugins that are exposed as resources via the
Pulumi programming model so that they may be explicitly and multiply
instantiated. Each instance of a provider resource may be configured
differently, and configuration parameters may be source from the
outputs of other resources.
### Provider Plugin Changes
In order to accommodate the need to verify and diff provider
configuration and configure providers without complete configuration
information, these changes adjust the high-level provider plugin
interface. Two new methods for validating a provider's configuration
and diffing changes to the same have been added (`CheckConfig` and
`DiffConfig`, respectively), and the type of the configuration bag
accepted by `Configure` has been changed to a `PropertyMap`.
These changes have not yet been reflected in the provider plugin gRPC
interface. We will do this in a set of follow-up changes. Until then,
these methods are implemented by adapters:
- `CheckConfig` validates that all configuration parameters are string
or unknown properties. This is necessary because existing plugins
only accept string-typed configuration values.
- `DiffConfig` either returns "never replace" if all configuration
values are known or "must replace" if any configuration value is
unknown. The justification for this behavior is given
[here](https://github.com/pulumi/pulumi/pull/1695/files#diff-a6cd5c7f337665f5bb22e92ca5f07537R106)
- `Configure` converts the config bag to a legacy config map and
configures the provider plugin if all config values are known. If any
config value is unknown, the underlying plugin is not configured and
the provider may only perform `Check`, `Read`, and `Invoke`, all of
which return empty results. We justify this behavior becuase it is
only possible during a preview and provides the best experience we
can manage with the existing gRPC interface.
### Resource Model Changes
Providers are now exposed as resources that participate in a stack's
dependency graph. Like other resources, they are explicitly created,
may have multiple instances, and may have dependencies on other
resources. Providers are referred to using provider references, which
are a combination of the provider's URN and its ID. This design
addresses the need during a preview to refer to providers that have not
yet been physically created and therefore have no ID.
All custom resources that are not themselves providers must specify a
single provider via a provider reference. The named provider will be
used to manage that resource's CRUD operations. If a resource's
provider reference changes, the resource must be replaced. Though its
URN is not present in the resource's dependency list, the provider
should be treated as a dependency of the resource when topologically
sorting the dependency graph.
Finally, `Invoke` operations must now specify a provider to use for the
invocation via a provider reference.
### Engine Changes
First-class providers support requires a few changes to the engine:
- The engine must have some way to map from provider references to
provider plugins. It must be possible to add providers from a stack's
checkpoint to this map and to register new/updated providers during
the execution of a plan in response to CRUD operations on provider
resources.
- In order to support updating existing stacks using existing Pulumi
programs that may not explicitly instantiate providers, the engine
must be able to manage the "default" providers for each package
referenced by a checkpoint or Pulumi program. The configuration for
a "default" provider is taken from the stack's configuration data.
The former need is addressed by adding a provider registry type that is
responsible for managing all of the plugins required by a plan. In
addition to loading plugins froma checkpoint and providing the ability
to map from a provider reference to a provider plugin, this type serves
as the provider plugin for providers themselves (i.e. it is the
"provider provider").
The latter need is solved via two relatively self-contained changes to
plan setup and the eval source.
During plan setup, the old checkpoint is scanned for custom resources
that do not have a provider reference in order to compute the set of
packages that require a default provider. Once this set has been
computed, the required default provider definitions are conjured and
prepended to the checkpoint's resource list. Each resource that
requires a default provider is then updated to refer to the default
provider for its package.
While an eval source is running, each custom resource registration,
resource read, and invoke that does not name a provider is trapped
before being returned by the source iterator. If no default provider
for the appropriate package has been registered, the eval source
synthesizes an appropriate registration, waits for it to complete, and
records the registered provider's reference. This reference is injected
into the original request, which is then processed as usual. If a
default provider was already registered, the recorded reference is
used and no new registration occurs.
### SDK Changes
These changes only expose first-class providers from the Node.JS SDK.
- A new abstract class, `ProviderResource`, can be subclassed and used
to instantiate first-class providers.
- A new field in `ResourceOptions`, `provider`, can be used to supply
a particular provider instance to manage a `CustomResource`'s CRUD
operations.
- A new type, `InvokeOptions`, can be used to specify options that
control the behavior of a call to `pulumi.runtime.invoke`. This type
includes a `provider` field that is analogous to
`ResourceOptions.provider`.
2018-08-07 02:50:29 +02:00
|
|
|
string provider = 3; // an optional reference to the provider to use for this invoke.
|
2019-04-16 19:06:43 +02:00
|
|
|
string version = 4; // the version of the provider to use when servicing this request.
|
2017-09-27 21:34:44 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
message InvokeResponse {
|
|
|
|
google.protobuf.Struct return = 1; // the returned values, if invoke was successful.
|
|
|
|
repeated CheckFailure failures = 2; // the failures if any arguments didn't pass verification.
|
|
|
|
}
|
|
|
|
|
2017-03-03 03:15:38 +01:00
|
|
|
message CheckRequest {
|
2017-12-03 01:34:16 +01:00
|
|
|
string urn = 1; // the Pulumi URN for this resource.
|
|
|
|
google.protobuf.Struct olds = 2; // the old Pulumi inputs for this resource, if any.
|
|
|
|
google.protobuf.Struct news = 3; // the new Pulumi inputs for this resource.
|
2017-03-03 03:15:38 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
message CheckResponse {
|
2017-12-03 01:34:16 +01:00
|
|
|
google.protobuf.Struct inputs = 1; // the provider inputs for this resource.
|
|
|
|
repeated CheckFailure failures = 2; // any validation failures that occurred.
|
2017-03-03 03:15:38 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
message CheckFailure {
|
|
|
|
string property = 1; // the property that failed validation.
|
|
|
|
string reason = 2; // the reason that the property failed validation.
|
|
|
|
}
|
|
|
|
|
2017-08-01 03:26:15 +02:00
|
|
|
message DiffRequest {
|
2019-07-31 18:39:07 +02:00
|
|
|
string id = 1; // the ID of the resource to diff.
|
|
|
|
string urn = 2; // the Pulumi URN for this resource.
|
|
|
|
google.protobuf.Struct olds = 3; // the old values of provider inputs to diff.
|
|
|
|
google.protobuf.Struct news = 4; // the new values of provider inputs to diff.
|
|
|
|
repeated string ignoreChanges = 5; // a set of property paths that should be treated as unchanged.
|
Redo object monikers
This change overhauls the way we do object monikers. The old mechanism,
generating monikers using graph paths, was far too brittle and prone to
collisions. The new approach mixes some amount of "automatic scoping"
plus some "explicit naming." Although there is some explicitness, this
is arguably a good thing, as the monikers will be relatable back to the
source more readily by developers inspecting the graph and resource state.
Each moniker has four parts:
<Namespace>::<AllocModule>::<Type>::<Name>
wherein each element is the following:
<Namespace> The namespace being deployed into
<AllocModule> The module in which the object was allocated
<Type> The type of the resource
<Name> The assigned name of the resource
The <Namespace> is essentially the deployment target -- so "prod",
"stage", etc -- although it is more general purpose to allow for future
namespacing within a target (e.g., "prod/customer1", etc); for now
this is rudimentary, however, see marapongo/mu#94.
The <AllocModule> is the token for the code that contained the 'new'
that led to this object being created. In the future, we may wish to
extend this to also track the module under evaluation. (This is a nice
aspect of monikers; they can become arbitrarily complex, so long as
they are precise, and not prone to false positives/negatives.)
The <Name> warrants more discussion. The resource provider is consulted
via a new gRPC method, Name, that fetches the name. How the provider
does this is entirely up to it. For some resource types, the resource
may have properties that developers must set (e.g., `new Bucket("foo")`);
for other providers, perhaps the resource intrinsically has a property
that explicitly and uniquely qualifies the object (e.g., AWS SecurityGroups,
via `new SecurityGroup({groupName: "my-sg"}`); and finally, it's conceivable
that a provider might auto-generate the name (e.g., such as an AWS Lambda
whose name could simply be a hash of the source code contents).
This should overall produce better results with respect to moniker
collisions, ability to match resources, and the usability of the system.
2017-02-24 23:50:02 +01:00
|
|
|
}
|
|
|
|
|
2019-07-01 21:34:19 +02:00
|
|
|
message PropertyDiff {
|
|
|
|
Kind kind = 1; // The kind of diff asdsociated with this property.
|
|
|
|
bool inputDiff = 2; // The difference is between old and new inputs, not old and new state.
|
|
|
|
|
|
|
|
enum Kind {
|
|
|
|
ADD = 0; // this property was added
|
|
|
|
ADD_REPLACE = 1; // this property was added, and this change requires a replace
|
|
|
|
DELETE = 2; // this property was removed
|
|
|
|
DELETE_REPLACE = 3; // this property was removed, and this change requires a replace
|
|
|
|
UPDATE = 4; // this property's value was changed
|
|
|
|
UPDATE_REPLACE = 5; // this property's value was changed, and this change requires a replace
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-08-01 03:26:15 +02:00
|
|
|
message DiffResponse {
|
|
|
|
repeated string replaces = 1; // if this update requires a replacement, the set of properties triggering it.
|
Add a notion of stable properties
This change adds the capability for a resource provider to indicate
that, where an action carried out in response to a diff, a certain set
of properties would be "stable"; that is to say, they are guaranteed
not to change. As a result, properties may be resolved to their final
values during previewing, avoiding erroneous cascading impacts.
This avoids the ever-annoying situation I keep running into when demoing:
when adding or removing an ingress rule to a security group, we ripple
the impact through the instance, and claim it must be replaced, because
that instance depends on the security group via its name. Well, the name
is a great example of a stable property, in that it will never change, and
so this is truly unfortunate and always adds uncertainty into the demos.
Particularly since the actual update doesn't need to perform replacements.
This resolves pulumi/pulumi#330.
2017-10-04 14:22:21 +02:00
|
|
|
repeated string stables = 2; // an optional list of properties that will not ever change.
|
2017-12-10 17:37:22 +01:00
|
|
|
bool deleteBeforeReplace = 3; // if true, this resource must be deleted before replacing it.
|
2019-03-05 19:49:24 +01:00
|
|
|
DiffChanges changes = 4; // if true, this diff represents an actual difference and thus requires an update.
|
|
|
|
repeated string diffs = 5; // a list of the properties that changed.
|
2018-04-05 16:00:16 +02:00
|
|
|
|
2019-07-01 21:34:19 +02:00
|
|
|
// detailedDiff is an optional field that contains map from each changed property to the type of the change.
|
|
|
|
//
|
|
|
|
// The keys of this map are property paths. These paths are essentially Javascript property access expressions
|
|
|
|
// in which all elements are literals, and obey the following EBNF-ish grammar:
|
|
|
|
//
|
|
|
|
// propertyName := [a-zA-Z_$] { [a-zA-Z0-9_$] }
|
|
|
|
// quotedPropertyName := '"' ( '\' '"' | [^"] ) { ( '\' '"' | [^"] ) } '"'
|
|
|
|
// arrayIndex := { [0-9] }
|
|
|
|
//
|
|
|
|
// propertyIndex := '[' ( quotedPropertyName | arrayIndex ) ']'
|
|
|
|
// rootProperty := ( propertyName | propertyIndex )
|
|
|
|
// propertyAccessor := ( ( '.' propertyName ) | propertyIndex )
|
|
|
|
// path := rootProperty { propertyAccessor }
|
|
|
|
//
|
|
|
|
// Examples of valid keys:
|
|
|
|
// - root
|
|
|
|
// - root.nested
|
|
|
|
// - root["nested"]
|
|
|
|
// - root.double.nest
|
|
|
|
// - root["double"].nest
|
|
|
|
// - root["double"]["nest"]
|
|
|
|
// - root.array[0]
|
|
|
|
// - root.array[100]
|
|
|
|
// - root.array[0].nested
|
|
|
|
// - root.array[0][1].nested
|
|
|
|
// - root.nested.array[0].double[1]
|
|
|
|
// - root["key with \"escaped\" quotes"]
|
|
|
|
// - root["key with a ."]
|
|
|
|
// - ["root key with \"escaped\" quotes"].nested
|
|
|
|
// - ["root key with a ."][100]
|
|
|
|
map<string, PropertyDiff> detailedDiff = 6; // a detailed diff appropriate for display.
|
|
|
|
bool hasDetailedDiff = 7; // true if this response contains a detailed diff.
|
|
|
|
|
2018-04-05 16:00:16 +02:00
|
|
|
enum DiffChanges {
|
|
|
|
DIFF_UNKNOWN = 0; // unknown whether there are changes or not (legacy behavior).
|
|
|
|
DIFF_NONE = 1; // the diff was performed, and no changes were detected that require an update.
|
|
|
|
DIFF_SOME = 2; // the diff was performed, and changes were detected that require an update or replacement.
|
|
|
|
}
|
Redo object monikers
This change overhauls the way we do object monikers. The old mechanism,
generating monikers using graph paths, was far too brittle and prone to
collisions. The new approach mixes some amount of "automatic scoping"
plus some "explicit naming." Although there is some explicitness, this
is arguably a good thing, as the monikers will be relatable back to the
source more readily by developers inspecting the graph and resource state.
Each moniker has four parts:
<Namespace>::<AllocModule>::<Type>::<Name>
wherein each element is the following:
<Namespace> The namespace being deployed into
<AllocModule> The module in which the object was allocated
<Type> The type of the resource
<Name> The assigned name of the resource
The <Namespace> is essentially the deployment target -- so "prod",
"stage", etc -- although it is more general purpose to allow for future
namespacing within a target (e.g., "prod/customer1", etc); for now
this is rudimentary, however, see marapongo/mu#94.
The <AllocModule> is the token for the code that contained the 'new'
that led to this object being created. In the future, we may wish to
extend this to also track the module under evaluation. (This is a nice
aspect of monikers; they can become arbitrarily complex, so long as
they are precise, and not prone to false positives/negatives.)
The <Name> warrants more discussion. The resource provider is consulted
via a new gRPC method, Name, that fetches the name. How the provider
does this is entirely up to it. For some resource types, the resource
may have properties that developers must set (e.g., `new Bucket("foo")`);
for other providers, perhaps the resource intrinsically has a property
that explicitly and uniquely qualifies the object (e.g., AWS SecurityGroups,
via `new SecurityGroup({groupName: "my-sg"}`); and finally, it's conceivable
that a provider might auto-generate the name (e.g., such as an AWS Lambda
whose name could simply be a hash of the source code contents).
This should overall produce better results with respect to moniker
collisions, ability to match resources, and the usability of the system.
2017-02-24 23:50:02 +01:00
|
|
|
}
|
|
|
|
|
2017-02-10 17:55:26 +01:00
|
|
|
message CreateRequest {
|
2017-08-31 22:10:55 +02:00
|
|
|
string urn = 1; // the Pulumi URN for this resource.
|
2017-12-03 01:34:16 +01:00
|
|
|
google.protobuf.Struct properties = 2; // the provider inputs to set during creation.
|
Addition of Custom Timeouts (#2885)
* Plumbing the custom timeouts from the engine to the providers
* Plumbing the CustomTimeouts through to the engine and adding test to show this
* Change the provider proto to include individual timeouts
* Plumbing the CustomTimeouts from the engine through to the Provider RPC interface
* Change how the CustomTimeouts are sent across RPC
These errors were spotted in testing. We can now see that the timeout
information is arriving in the RegisterResourceRequest
```
req=&pulumirpc.RegisterResourceRequest{
Type: "aws:s3/bucket:Bucket",
Name: "my-bucket",
Parent: "urn:pulumi:dev::aws-vpc::pulumi:pulumi:Stack::aws-vpc-dev",
Custom: true,
Object: &structpb.Struct{},
Protect: false,
Dependencies: nil,
Provider: "",
PropertyDependencies: {},
DeleteBeforeReplace: false,
Version: "",
IgnoreChanges: nil,
AcceptSecrets: true,
AdditionalSecretOutputs: nil,
Aliases: nil,
CustomTimeouts: &pulumirpc.RegisterResourceRequest_CustomTimeouts{
Create: 300,
Update: 400,
Delete: 500,
XXX_NoUnkeyedLiteral: struct {}{},
XXX_unrecognized: nil,
XXX_sizecache: 0,
},
XXX_NoUnkeyedLiteral: struct {}{},
XXX_unrecognized: nil,
XXX_sizecache: 0,
}
```
* Changing the design to use strings
* CHANGELOG entry to include the CustomTimeouts work
* Changing custom timeouts to be passed around the engine as converted value
We don't want to pass around strings - the user can provide it but we want
to make the engine aware of the timeout in seconds as a float64
2019-07-15 23:26:28 +02:00
|
|
|
double timeout = 3; // the create request timeout represented in seconds.
|
2017-02-10 17:55:26 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
message CreateResponse {
|
2018-07-07 00:17:32 +02:00
|
|
|
// NOTE: The partial-update-error equivalent of this message is `ErrorResourceInitFailed`.
|
|
|
|
|
2017-10-12 00:27:34 +02:00
|
|
|
string id = 1; // the ID of the created resource.
|
2017-07-18 03:44:45 +02:00
|
|
|
google.protobuf.Struct properties = 2; // any properties that were computed during creation.
|
2017-02-10 17:55:26 +01:00
|
|
|
}
|
|
|
|
|
2018-04-05 16:00:16 +02:00
|
|
|
message ReadRequest {
|
|
|
|
string id = 1; // the ID of the resource to read.
|
|
|
|
string urn = 2; // the Pulumi URN for this resource.
|
|
|
|
google.protobuf.Struct properties = 3; // the current state (sufficiently complete to identify the resource).
|
2019-03-11 21:50:00 +01:00
|
|
|
google.protobuf.Struct inputs = 4; // the current inputs, if any (only populated during refresh).
|
2018-04-05 16:00:16 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
message ReadResponse {
|
2018-04-10 21:58:50 +02:00
|
|
|
string id = 1; // the ID of the resource read back (or empty if missing).
|
|
|
|
google.protobuf.Struct properties = 2; // the state of the resource read from the live environment.
|
2019-03-05 19:49:24 +01:00
|
|
|
google.protobuf.Struct inputs = 3; // the inputs for this resource that would be returned from Check.
|
2018-04-05 16:00:16 +02:00
|
|
|
}
|
|
|
|
|
Initial support for output properties (1 of 3)
This change includes approximately 1/3rd of the change necessary
to support output properties, as per pulumi/lumi#90.
In short, the runtime now has a new hidden type, Latent<T>, which
represents a "speculative" value, whose eventual type will be T,
that we can use during evaluation in various ways. Namely,
operations against Latent<T>s generally produce new Latent<U>s.
During planning, any Latent<T>s that end up in resource properties
are transformed into "unknown" property values. An unknown property
value is legal only during planning-time activities, such as Check,
Name, and InspectChange. As a result, those RPC interfaces have
been updated to include lookaside maps indicating which properties
have unknown values. My intent is to add some helper functions to
make dealing with this circumstance more correct-by-construction.
For now, using an unresolved Latent<T> in a conditional will lead
to an error. See pulumi/lumi#67. Speculating beyond these -- by
supporting iterative planning and application -- is something we
want to support eventually, but it makes sense to do that as an
additive change beyond this initial support. That is a missing 1/3.
Finally, the other missing 1/3rd which will happen much sooner
than the rest is restructuing plan application so that it will
correctly observe resolution of Latent<T> values. Right now, the
evaluation happens in one single pass, prior to the application, and
so Latent<T>s never actually get witnessed in a resolved state.
2017-05-24 02:32:59 +02:00
|
|
|
message UpdateRequest {
|
2018-07-07 00:17:32 +02:00
|
|
|
// NOTE: The partial-update-error equivalent of this message is `ErrorResourceInitFailed`.
|
|
|
|
|
2019-07-31 18:39:07 +02:00
|
|
|
string id = 1; // the ID of the resource to update.
|
|
|
|
string urn = 2; // the Pulumi URN for this resource.
|
|
|
|
google.protobuf.Struct olds = 3; // the old values of provider inputs for the resource to update.
|
|
|
|
google.protobuf.Struct news = 4; // the new values of provider inputs for the resource to update.
|
|
|
|
double timeout = 5; // the update request timeout represented in seconds.
|
|
|
|
repeated string ignoreChanges = 6; // a set of property paths that should be treated as unchanged.
|
Initial support for output properties (1 of 3)
This change includes approximately 1/3rd of the change necessary
to support output properties, as per pulumi/lumi#90.
In short, the runtime now has a new hidden type, Latent<T>, which
represents a "speculative" value, whose eventual type will be T,
that we can use during evaluation in various ways. Namely,
operations against Latent<T>s generally produce new Latent<U>s.
During planning, any Latent<T>s that end up in resource properties
are transformed into "unknown" property values. An unknown property
value is legal only during planning-time activities, such as Check,
Name, and InspectChange. As a result, those RPC interfaces have
been updated to include lookaside maps indicating which properties
have unknown values. My intent is to add some helper functions to
make dealing with this circumstance more correct-by-construction.
For now, using an unresolved Latent<T> in a conditional will lead
to an error. See pulumi/lumi#67. Speculating beyond these -- by
supporting iterative planning and application -- is something we
want to support eventually, but it makes sense to do that as an
additive change beyond this initial support. That is a missing 1/3.
Finally, the other missing 1/3rd which will happen much sooner
than the rest is restructuing plan application so that it will
correctly observe resolution of Latent<T> values. Right now, the
evaluation happens in one single pass, prior to the application, and
so Latent<T>s never actually get witnessed in a resolved state.
2017-05-24 02:32:59 +02:00
|
|
|
}
|
|
|
|
|
2017-07-18 03:44:45 +02:00
|
|
|
message UpdateResponse {
|
|
|
|
google.protobuf.Struct properties = 1; // any properties that were computed during updating.
|
|
|
|
}
|
|
|
|
|
2017-02-10 17:55:26 +01:00
|
|
|
message DeleteRequest {
|
2017-07-19 16:57:22 +02:00
|
|
|
string id = 1; // the ID of the resource to delete.
|
2017-08-31 22:10:55 +02:00
|
|
|
string urn = 2; // the Pulumi URN for this resource.
|
2017-07-19 16:57:22 +02:00
|
|
|
google.protobuf.Struct properties = 3; // the current properties on the resource.
|
Addition of Custom Timeouts (#2885)
* Plumbing the custom timeouts from the engine to the providers
* Plumbing the CustomTimeouts through to the engine and adding test to show this
* Change the provider proto to include individual timeouts
* Plumbing the CustomTimeouts from the engine through to the Provider RPC interface
* Change how the CustomTimeouts are sent across RPC
These errors were spotted in testing. We can now see that the timeout
information is arriving in the RegisterResourceRequest
```
req=&pulumirpc.RegisterResourceRequest{
Type: "aws:s3/bucket:Bucket",
Name: "my-bucket",
Parent: "urn:pulumi:dev::aws-vpc::pulumi:pulumi:Stack::aws-vpc-dev",
Custom: true,
Object: &structpb.Struct{},
Protect: false,
Dependencies: nil,
Provider: "",
PropertyDependencies: {},
DeleteBeforeReplace: false,
Version: "",
IgnoreChanges: nil,
AcceptSecrets: true,
AdditionalSecretOutputs: nil,
Aliases: nil,
CustomTimeouts: &pulumirpc.RegisterResourceRequest_CustomTimeouts{
Create: 300,
Update: 400,
Delete: 500,
XXX_NoUnkeyedLiteral: struct {}{},
XXX_unrecognized: nil,
XXX_sizecache: 0,
},
XXX_NoUnkeyedLiteral: struct {}{},
XXX_unrecognized: nil,
XXX_sizecache: 0,
}
```
* Changing the design to use strings
* CHANGELOG entry to include the CustomTimeouts work
* Changing custom timeouts to be passed around the engine as converted value
We don't want to pass around strings - the user can provide it but we want
to make the engine aware of the timeout in seconds as a float64
2019-07-15 23:26:28 +02:00
|
|
|
double timeout = 4; // the delete request timeout represented in seconds.
|
2017-02-10 17:55:26 +01:00
|
|
|
}
|
2018-06-28 01:08:21 +02:00
|
|
|
|
|
|
|
// ErrorResourceInitFailed is sent as a Detail `ResourceProvider.{Create, Update}` fail because a
|
|
|
|
// resource was created successfully, but failed to initialize.
|
|
|
|
message ErrorResourceInitFailed {
|
|
|
|
string id = 1; // the ID of the created resource.
|
|
|
|
google.protobuf.Struct properties = 2; // any properties that were computed during updating.
|
|
|
|
repeated string reasons = 3; // error messages associated with initialization failure.
|
2019-03-05 19:49:24 +01:00
|
|
|
google.protobuf.Struct inputs = 4; // the current inputs to this resource (only applicable for Read)
|
2018-06-28 01:08:21 +02:00
|
|
|
}
|