tech.guitarrapc.cóm

Technical updates

Pulumi のリソースを入れ子にする

この記事は、Pulumi dotnet Advent Calendar 2019 の5日目です。

qiita.com

リソースの親子関係を持たせることで、preview表示、グラフ表示したときに入れ子状態が格段と見やすく把握しやすくなります。 ではどうやって親子関係を持たせればいいのでしょうか。

目次

TL;DR

ResourceOptions ではなく CustomResourceOptions を使いましょう。

Summary

入れ子にできるとコンポーネントの中にリソースがまとまるので、Web UI 的にも Preview 的にもわかりやすくなる。 入れ子にしたいがどうやるのか。

f:id:guitarrapc_tech:20191202031641p:plain
入れ子にしたときのPreview表示

Problem

  • 無指定だと Stack が親になって入れ子にならない。
  • new ResourceOptions { Parent = this } で Parent = this を指定しても入れ子にはならない。

Components の入れ子

new ResourceOptions { Parent = this } で Parent = this を指定しても XxxxxResourceImParentResource の入れ子にはならない。

class ImParentResource : Pulumi.ComponentResource
{
    public ImParentResource(string name, ResourceOptions opts) : base("pkg:ImParentResource", name, opts)
    {
        new XxxxxResource($"{type}:xxxx", $"{name}-Xxxxx", new ResourceOptions { Parent = this })
        {
        }
    }
}

CustomResourceOptions { Parent = this } を使うことで入れ子にすることができる。

class ImParentResource : Pulumi.ComponentResource
{
    public ImParentResource(string name, ResourceOptions opts) : base("pkg:ImParentResource", name, opts)
    {
        new XxxxxResource($"{type}:xxxx", $"{name}-Xxxxx", new CustomResourceOptions { Parent = this })
        {
        }
    }
}

リソースの入れ子

リソースを作成するときに、CustomResourceOptions で親ComponentResource を指すことで入れ子ができる。 指定しない場合は、Stack = Root が親になってしまうので、コンポーネントの子にしたい場合は、常に new CustomResourceOptions { Parent = this } を指定する必要がありそう。

CustomResourceOptions ない場合、リソースを持っているコンポーネントリソースが親にならない。

var vpc = new Vpc($"{name}-vpc", new VpcArgs
{
    CidrBlock = "10.0.0.0/16",
    EnableDnsHostnames = true,
    EnableDnsSupport = true,
    Tags = new Dictionary<string, object>(parameter.Tags)
    {
        { $"Name", $"MyVpc"}
    },
});

new CustomResourceOptions { Parent = this } を指定することで、親子にできる。

var vpc = new Vpc($"{name}-vpc", new VpcArgs
{
    CidrBlock = "10.0.0.0/16",
    EnableDnsHostnames = true,
    EnableDnsSupport = true,
    Tags = new Dictionary<string, object>(parameter.Tags)
    {
        { $"Name", $"MyVpc"}
    },
}, new CustomResourceOptions { Parent = this });