- リソースのプロパティ名変更に対応するには、一度該当 URN を Stateから削除して、インポートしなおす。
- 残念ながら、リソースの必須プロパティ名の変更で生じる reate-replacement に対処できる Custom Resource Options は存在しない。
see: Allow aliasing when a property which requires replacement changes name · Issue #9115 · pulumi/pulumi pulumi/pulumi#9115
Pulumi はリソース URN 自体の移動に対しては CustomResourceoption で Alias を指定することで移動が可能です。 リソースプロパティの無視は Ignore で可能です。
しかし、リソースのプロパティ名の変更が起こった時に、旧プロパティ名から新プロパティ名に変更を追随するためのマーカーを渡す方法がありません。 オプショナルなプロパティであればプロパティ名を変えればいいのですが、必須プロパティの場合 create-replacement が生じてしまいます。
一度 State から該当 URN を削除してから、Import しなおしてください。
State のプロパティ名が違っているので、一度 URN を削除してから同じ URN にインポートしなおすことでプロパティ名の変更に追随できます。
手順を説明します。
これは TIPS です。必須ではありませんが、やることをお勧めします。
この後、Pulumi から URN を削除すると今の Pulumi での状態が見れなくなります。
できれば ブラウザで Pulumi Console の街頭 URN を開いて、プロパティの状態をタブで開いておきましょう。 タブで開いていおくことで、「構築時のコード」と「インポート時に必要なプロパティ」の暗黙の指定が明確に把握できます。 インポート時にコードとリソースの差分が出ても、このタブを見ればどんな違いがあるか推測するのに役立ちます。
Pulumi Console のリソース一覧 (グラフからでも一覧でもよし) を開き、該当の URN を見つけてください。
あるいは pulumi cli であれば pulumi stack --show-urns
から探してもいいでしょう。
pulumi stack --show-urns | grep "リソース名"
URN: urn:pulumi:xxx:Stack名::Provider名:なんとかかんとか
といったフォーマットの URN が見つかったらメモします。
URN を State から削除することによって、クラウドプロバイダー上にリソースを残したまま Pulumi の対応を消すことができます。 pulumi cli をつかって、該当の URN 消します。
pulumi state delete <先ほど見つけたURN>
確認されるので y で削除を実行します。
Terraform同様に、Pulumi もクラウド環境の状態をコードに取り込むことができます。
Terraform は cli で terraform import クラウドリソースID
で取り込みましたが、Pulumi はコード上の CustomResourceOptions.ImportId
で指定します。
例えば、Azure の Managed Environment であれば次のようになります。
_ = new ManagedEnvironment("FooBar", new ManagedEnvironmentArgs
{
EnvironmentName = "foo", // ここが AzureNative nuget パッケージの更新で Name から EnvironmentName に変わった
AppLogsConfiguration = new AppLogsConfigurationArgs
{
Destination = "log-analytics",
LogAnalyticsConfiguration = new LogAnalyticsConfigurationArgs
{
CustomerId = "ログアナリティクスID"
// SharedKey = "シェアドキー" <- Import 時に SharedKey は入らないのでコメントアウト必須
},
ZoneRedundant = false, // 暗黙のプロパティ で false だが、Import 時は 明示的に指定しないと Diff が出て Import が失敗する
ResourceGroupName = "Foo-Group",
Location = "japan-east",
Tags = .... // あればちゃんと指定する
}
}, new CustomResourceoptions
{
Parent = this, // インポート時のリソースの Parent 指定になるので、コンポーネントと親子関係持たせるなら必須
ImportId = "/subscriptions/xxxxxxx/resourceGorups/Foo-Group/providers/Microsoft.App/managedEnvironment/foo" // Azure Resource Id
});
Import 時の注意は、現在のリソースとの Diff が生じてはいけないということです。
このため、暗黙のプロパティで与えられる値も明示的に指定が必要です。(例では ZoneRedundant = false
は暗黙で与えられるが明示的に指定が必要)
インポート時のリソースは、 CustomResourceoptions.ImportId
で指定しましょう。Azure の場合はリソースID です。
あとは差分がないか pulumi cli で確認しましょう。
pulumi up
差分があれば 100% 失敗するので、差分がないように気を付けてください。 ただし差分は Diff ではプロパティ名までしか確認できず値がわかりません。 「該当ステートの状態をブラウザで確認しておく」のステップで開いておいたタブでプロパティ値とコードを見比べるといいでしょう。
インポートが成功すればokです。
コードから CustomResourceoptions.ImportId
セクションを消して pulumi を実行してみて差分が出なければ完了です。