026234bdbb
* add back getting started page * decollapse getting started guide * update style * remove quickstart files scss file * lint * assets * update links * update links * update links * update links * update link
352 lines
9.2 KiB
Markdown
352 lines
9.2 KiB
Markdown
---
|
|
title: "Announcing Kustomize Support"
|
|
date: 2020-07-07
|
|
draft: false
|
|
meta_desc: "Pulumi adds Kustomize support to their Kubernetes provider"
|
|
meta_image: kustomize_twcard.png
|
|
authors:
|
|
- levi-blackstone
|
|
|
|
tags:
|
|
- kubernetes
|
|
---
|
|
|
|
Kubernetes is complex, and there are many ways to manage Kubernetes resources. Pulumi supports many of these options, including native code SDKs, YAML, Helm, and now, Kustomize. There's no need to rewrite your existing configurations to get started with Pulumi. You can efficiently adopt existing resources to deploy your modern application and save time and effort.
|
|
<!--more-->
|
|
|
|
Over the past year, we've heard from many users that they'd like to manage Kustomize resources directly with Pulumi.
|
|
The [v2.4.0 release] of our Kubernetes provider adds support for Kustomize to all of our SDKs (Go, TypeScript, .NET, Python).
|
|
One of our primary goals at Pulumi is to meet users where they are. Our support for [Kustomize], [Helm], and [YAML] means that
|
|
you don't have to "boil the ocean" to get started with Pulumi. The following examples show you how to get started with
|
|
Pulumi and Kustomize today!
|
|
|
|
## Working with local files
|
|
|
|
Let's see how to deploy a Kustomization from a local directory.
|
|
|
|
{{< chooser language "typescript,python,csharp,go" >}}
|
|
|
|
{{% choosable language typescript %}}
|
|
|
|
```typescript
|
|
import * as k8s from "@pulumi/kubernetes";
|
|
|
|
new k8s.kustomize.Directory("helloWorldLocal", {
|
|
directory: "./helloWorld",
|
|
});
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
|
|
```python
|
|
import pulumi_kubernetes as k8s
|
|
|
|
k8s.kustomize.Directory("helloWorldLocal",
|
|
directory="helloWorld")
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language csharp %}}
|
|
|
|
```csharp
|
|
using System;
|
|
using System.Threading.Tasks;
|
|
using Pulumi;
|
|
using Pulumi.Kubernetes.Kustomize;
|
|
|
|
class KustomizeStack : Stack
|
|
{
|
|
public KustomizeStack()
|
|
{
|
|
var files = new Directory("helloWorldLocal", new DirectoryArgs
|
|
{
|
|
Directory = "./helloWorld"
|
|
});
|
|
}
|
|
|
|
}
|
|
|
|
class Program
|
|
{
|
|
static Task<int> Main(string[] args) => Deployment.RunAsync<KustomizeStack>();
|
|
}
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
|
|
```go
|
|
import (
|
|
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/kustomize"
|
|
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
|
|
)
|
|
|
|
func main() {
|
|
pulumi.Run(func(ctx *pulumi.Context) error {
|
|
_, err := kustomize.NewDirectory(ctx, "helloWorldLocal",
|
|
kustomize.DirectoryArgs{
|
|
Directory: pulumi.String("./helloWorld"),
|
|
},
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{< /chooser >}}
|
|
|
|
|
|
|
|
## Working with git repos
|
|
|
|
We can also use Kustomizations directly from a git repository, local or remote,
|
|
by specifying the path to the directory.
|
|
|
|
{{< chooser language "typescript,python,csharp,go" >}}
|
|
|
|
{{% choosable language typescript %}}
|
|
|
|
```typescript
|
|
import * as k8s from "@pulumi/kubernetes";
|
|
|
|
new k8s.kustomize.Directory("helloWorldRemote", {
|
|
directory: "https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld",
|
|
});
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
|
|
```python
|
|
import pulumi_kubernetes as k8s
|
|
|
|
k8s.kustomize.Directory("helloWorldRemote",
|
|
directory="https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld")
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language csharp %}}
|
|
|
|
```csharp
|
|
using System;
|
|
using System.Threading.Tasks;
|
|
using Pulumi;
|
|
using Pulumi.Kubernetes.Kustomize;
|
|
|
|
class KustomizeStack : Stack
|
|
{
|
|
public KustomizeStack()
|
|
{
|
|
var files = new Directory("helloWorldRemote", new DirectoryArgs
|
|
{
|
|
Directory = "https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld"
|
|
});
|
|
}
|
|
|
|
}
|
|
|
|
class Program
|
|
{
|
|
static Task<int> Main(string[] args) => Deployment.RunAsync<KustomizeStack>();
|
|
}
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
|
|
```go
|
|
import (
|
|
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/kustomize"
|
|
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
|
|
)
|
|
|
|
func main() {
|
|
pulumi.Run(func(ctx *pulumi.Context) error {
|
|
_, err := kustomize.NewDirectory(ctx, "helloWorldRemote",
|
|
kustomize.DirectoryArgs{
|
|
Directory: pulumi.String("https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld"),
|
|
},
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{< /chooser >}}
|
|
|
|
## A better way to Kustomize
|
|
|
|
One of my favorite parts of Pulumi's Kubernetes SDK is the ability to apply transformations to resource definitions.
|
|
This feature allows you to make changes to existing definitions before they are applied to a cluster. This saves
|
|
the headache of forking an upstream repo just to make a few tweaks, and then trying to keep those changes in sync!
|
|
Transformations are available for the Helm, Kustomize, and YAML SDKs.
|
|
|
|
{{% notes type="info" %}}
|
|
Kustomize overlays can be used for a similar purpose, but require changing files in the directory.
|
|
Transformations happen in memory, and are not persisted to disk. Keep both options in mind when you want to modify
|
|
an existing configuration.
|
|
{{% /notes %}}
|
|
|
|
{{< chooser language "typescript,python,csharp,go" >}}
|
|
|
|
{{% choosable language typescript %}}
|
|
|
|
```typescript
|
|
import * as k8s from "@pulumi/kubernetes";
|
|
|
|
new k8s.kustomize.Directory("helloWorldRemote", {
|
|
directory: "https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld",
|
|
transformations: [
|
|
(obj: any) => {
|
|
if (obj.kind === "Service") {
|
|
obj.spec.type = "ClusterIP"
|
|
}
|
|
}
|
|
]
|
|
});
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
|
|
```python
|
|
import pulumi_kubernetes as k8s
|
|
|
|
def change_service_type(obj):
|
|
if obj.kind == "Service":
|
|
obj.spec.type = "ClusterIP"
|
|
|
|
k8s.kustomize.Directory("helloWorldRemote",
|
|
directory="https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld",
|
|
transformations=[change_service_type])
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language csharp %}}
|
|
|
|
```csharp
|
|
using System;
|
|
using System.Threading.Tasks;
|
|
using Pulumi;
|
|
using Pulumi.Kubernetes.Kustomize;
|
|
|
|
class KustomizeStack : Stack
|
|
{
|
|
public KustomizeStack()
|
|
{
|
|
// Make every service private to the cluster, i.e., turn all services into ClusterIP instead of
|
|
// LoadBalancer.
|
|
ImmutableDictionary<string, object> LoadBalancerToClusterIP(ImmutableDictionary<string, object> obj, CustomResourceOptions opts)
|
|
{
|
|
if ((string)obj["kind"] == "Service")
|
|
{
|
|
var spec = (ImmutableDictionary<string, object>) obj["spec"];
|
|
if (spec != null && (string) spec["type"] == "LoadBalancer")
|
|
{
|
|
return obj.SetItem("spec", spec.SetItem("type", "ClusterIP"));
|
|
}
|
|
}
|
|
|
|
return obj;
|
|
}
|
|
|
|
var files = new Directory("helloWorldRemote", new DirectoryArgs
|
|
{
|
|
Directory = "https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld",
|
|
Transformations =
|
|
{
|
|
LoadBalancerToClusterIP,
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
class Program
|
|
{
|
|
static Task<int> Main(string[] args) => Deployment.RunAsync<KustomizeStack>();
|
|
}
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
|
|
```go
|
|
import (
|
|
"github.com/pulumi/pulumi-kubernetes/sdk/v2/go/kubernetes/kustomize"
|
|
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
|
|
)
|
|
|
|
func main() {
|
|
pulumi.Run(func(ctx *pulumi.Context) error {
|
|
_, err := kustomize.NewDirectory(ctx, "helloWorldRemote",
|
|
kustomize.DirectoryArgs{
|
|
Directory: pulumi.String("https://github.com/kubernetes-sigs/kustomize/tree/v3.3.1/examples/helloWorld"),
|
|
Transformations: []yaml.Transformation{
|
|
func(state map[string]interface{}, opts ...pulumi.ResourceOption) {
|
|
if state["kind"] == "Service" {
|
|
spec := state["spec"].(map[string]interface{})
|
|
spec["type"] = "ClusterIP"
|
|
}
|
|
},
|
|
},
|
|
},
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
```
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{< /chooser >}}
|
|
|
|
## Learn More
|
|
|
|
If you'd like to learn about Pulumi and how to manage your
|
|
infrastructure and Kubernetes through code, [get started today](/docs/get-started/). Pulumi is open
|
|
source and free to use.
|
|
|
|
For further examples on how to use Pulumi to create Kubernetes
|
|
clusters, or deploy workloads to a cluster, check out the rest of the
|
|
[Kubernetes tutorials](/registry/packages/kubernetes/how-to-guides/).
|
|
|
|
As always, you can check out our code on
|
|
[GitHub](https://github.com/pulumi), follow us on
|
|
[Twitter](https://twitter.com/pulumicorp), subscribe to our [YouTube
|
|
channel](https://www.youtube.com/channel/UC2Dhyn4Ev52YSbcpfnfP0Mw), or
|
|
join our [Community Slack](https://slack.pulumi.com/) channel if you have
|
|
any questions, need support, or just want to say hello.
|
|
|
|
<!-- markdownlint-disable url -->
|
|
[v2.4.0 release]: https://github.com/pulumi/pulumi-kubernetes/releases/tag/v2.4.0
|
|
[Kustomize]: /registry/packages/kubernetes/api-docs/kustomize/directory/
|
|
[Helm]: /registry/packages/kubernetes/api-docs/helm/v3/chart/
|
|
[YAML]: /registry/packages/kubernetes/api-docs/yaml/configgroup/
|
|
<!-- markdownlint-enable url -->
|