The last few years has seen an avalanche of tools to enable easier software development on Kubernetes. While some tools grow and adapt, others get left behind. What’s a better way to open 2021 than with an up-to-date review of the current options?
In this 5-part blog series, I’ll go over the various developer tools for Kubernetes, their function within the development workflow, and important updates for each tool. For this post, I’ll focus on tools used to define our Kubernetes applications – Helm, Kustomize, and Skaffold.
Kubernetes Manifests (YAMLs)
If you are new to Kubernetes, I recommend this introduction, which I found quite in-depth. For our purposes, the most important thing for you to know is that Kubernetes has a Declarative approach for orchestrating applications. You write your application’s desired state in a configuration file(s), known as “manifest,” in a YAML format and send it over to Kubernetes to make it happen.
Helm for Kubernetes
Helm is the reigning king, the de-facto standard for packaging, sharing, and deploying k8s applications. Think of Helm as a package manager – it allows you to group multiple YAML configuration snippets into a logical package known as a “chart” in a consistent and structured way.
As a package author, creating a Helm chart provides you with significant benefits:
- You can make your application configurable at deploy time using custom arguments. To do this, you use templates.
- You can publish your application into a private or public repository in a versioned and trackable way.
- You can make your application dependent on other Helm charts.
- Overall, Helm provides you with strong encapsulation mechanics to ensure your application deploys as intended.
As a package user, installing a Helm chart provides you even more:
- You gain access to an extensive repository of publicly available charts and any private charts made available by your organization.
- You can customize applications based on the settings provided by the package author.
- You have a versioned source of truth from where to deploy packages.
- You don’t have to worry about the intricacies of the Kubernetes specification language.
- Helm supports Atomic operations to minimize risks to your applications and clusters.
- Overall, you get an easy-to-understand and ready-to-use application package.
What’s new with Helm?
In late 2019 we saw the release of Helm v3, with the removal of the cluster-side component (Tiller) and a slew of other features. At the end of 2020, Helm v2 has been deprecated, and most public charts have been migrated to the v3 format. If you are still using Helm v2, make sure to allocate time to upgrade your near-term roadmap (while you are at it, check out this plugin that may help).
Over the last few releases, the Helm team has been busy addressing one of the biggest complaints by Helm users – the difficulty of working with YAML templates. Helm now includes a powerful linting command that should be your new go-to when debugging issues with those pesky YAMLs.
Another neat feature added to Helm is the post-render feature, allowing you to customize Helm charts with tools such as Kustomize. For example, this blog post shows how to use post-render to add Rookout to an existing Helm chart.
Last but not least, 2020 also saw the move to a more decentralized way of managing charts and the launch of two central repositories for sharing them:
- ArtifactHub by CNCF
- ChartCenter by JFrog (check out this webinar by Josh, a member of the Rookout team, to learn more about it)
Kustomize for Kubernetes
Helm’s biggest drawback is that customization of applications is limited to pre-existing configuration options. Not only that, the chart author has to implement those customization options in the somewhat cumbersome manner of templating. Well, that’s where Kustomize comes in.
Kustomize allows you to build a Kubernetes application as a series of layers and patches, empowering limitless customizations. Kustomize uses a YAML-based Kubernetes-aware patch format to add/remove/update any part of the application manifest. Kustomize became an integral part of kubectl on version 1.14, and all you have to do to invoke it is to execute kubectl -k. The docs are a bit sparse but check out the official examples page and this blog post to get some sense of things.
Kustomize is a powerful tool that empowers you to modify Kubernetes applications in any way you want to. Unfortunately, this means the learning curve can be quite steep. Arbitrary customization also means the potential for misconfiguring an app increases. One of Kustomize’s advanced use-cases uses Helm’s post-render feature to patch an existing Helm chart without requiring forking, hopefully making version upgrades seamless.
What’s new with Kustomize?
Many tools within the Kubernetes ecosystem have embedded Kustomize to add its functionality to theirs. The most prominent examples are orchestration and continuous deployment tools such as ArgoCD, Flux, and Kubestack. If you search for Kustomize-like patch functionality, check out your CD tool, and you just may find it there.
If, like me, you are not familiar with the Kubernetes build process, you might not know that the maintainers had frozen the Kustomize version embedded in kubectl at 2.0.3 during the initial integration. Besides making the docs even more confusing, this means the version inside kubectl is missing a slew of enhancements that made their way in over the last two years. The team is making significant progress on reintegration, and hopefully they will resolve it soon. In the meantime, consider using Kustomize as a standalone CLI tool if you need the latest version.
Skaffold for Kubernetes
Skaffold takes a bit of a different approach, following the DevOps best practice of keeping the development environments and workflows consistent across the SDLC. Skaffold builds and deploys Kubernetes applications for dev workflows and continuous integration (CI) and continuous deployment (CD).
For the building, Skaffold can utilize Dockerfiles, Buildpacks, Bazel, and even custom scripts (more on building container images in an upcoming blog post!). For deploying, Skaffold contains its limited templating engine and can invoke kubectl, Helm, or Kustomize.
Skaffold has three main modes of operation:
- skaffold dev – this will run Skaffold in a watch, build, deploy loop. In this mode, you can edit your source files locally, and Skaffold will deploy them to a cluster of your choice. Skaffold supports port forwarding and log tailing to enable a smoother development experience when working in this mode.
- skaffold build – this will run Skaffold to build your artifacts once and push them to a repository of your choice.
- skaffold deploy – this will deploy your built application into a cluster of your choice, potentially utilizing Helm or Kustomize to do so. If you want to build and deploy using a single command, you can use skaffold run.
What’s new with Skaffold?
In 2020, the Skaffold team focused on making the project easier to adapt to various workflows and more interoperable with other tools. Some of the improvements included more flexible integrations with CI/CD and GitOps and better support for Python and Java.
Additionally, Skaffold now has a new operating model in beta – skaffold debug. In this mode, Skaffold attempts to configure the application runtime for remote debugging automatically. While this is a neat feature, using traditional debuggers in a microservices environment is tricky at best, especially when working with remote clusters. If you are having trouble with that, we highly recommend you check out non-breaking debuggers such as Rookout.
Summary: Our Recommendations
When it comes to packaging, deploying, and sharing the notorious Kubernetes application manifests, we have seen significant market consolidation. The CNCF is now the home of the leading tools with Helm, an official CNCF project, and Kustomize integrated into kubectl and many other tools. Like in many other parts of the Kubernetes ecosystem, the tools here have significantly matured, and each has a clear purpose.
- Helm: Use Helm to package, share, and install well-defined Kubernetes applications.
- Kustomize: Use Kustomize to modify existing Kubernetes applications using patches.
- Skaffold: Skaffold is a useful tool (and popular!), but configuring Kubernetes applications is not its primary purpose.
I hope you found this short guide useful – please don’t hesitate to reach out to share your feedback and let me know which other topics you would like me to cover.
Check out the full Tools For Kubernetes Series:
Part 2: Skaffold, Tilt & Garden
Part 3: Lens, VSCode, IntelliJ & Gitpod
Part 5: Development Machines