Skip to content

Commit 0ef2ac8

Browse files
committed
chore: tidy up readme
1 parent 9ba5c3b commit 0ef2ac8

File tree

2 files changed

+32
-35
lines changed

2 files changed

+32
-35
lines changed

CONTRIBUTING.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Contribution Guidelines
22

3-
All feedback and contributions are welcome.
3+
If you have a resource, plugin, or anything related to Kustomize, feel free to contribute.
44

5-
If you have a resource, plugin, or anything related to Kustomize,
6-
feel free to open a [PR](https://github.com/aabouzaid/awesome-kustomize/compare) for it.
5+
Contributions are welcome, add links through [pull requests](https://github.com/aabouzaid/awesome-kustomize/pulls) or create an issue to start a discussion.

README.md

+30-32
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
<!-- omit in toc -->
2-
# Awesome Kustomize
3-
[![Awesome](https://raw.githubusercontent.com/sindresorhus/awesome/main/media/badge.svg)](https://github.com/sindresorhus/awesome)
4-
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/aabouzaid/awesome-kustomize/compare)
5-
6-
A curated and collaborative list of awesome [Kustomize](https://kustomize.io/) resources.
7-
Feel free to contribute to this repo, [PRs are more than welcome](https://github.com/aabouzaid/awesome-kustomize/pulls)!
2+
# Awesome Kustomize [![Awesome](https://raw.githubusercontent.com/sindresorhus/awesome/main/media/badge.svg)](https://github.com/sindresorhus/awesome) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/aabouzaid/awesome-kustomize/compare)
83

94
<p align="center">
5+
<a href="https://kustomize.io">
106
<img src="img/kustomize.svg" width="80%">
7+
</a>
118
</p>
129

10+
> A curated and collaborative list of awesome Kustomize resources.
11+
12+
[Kustomize](https://kustomize.io) introduces a template-free way to customize Kubernetes manifests. It's extensible and uses a purely declarative approach to configuration customization, which will help you efficiently manage your Infrastructure as a code (IaC).
13+
14+
Contributions are welcome, add links through [pull requests](https://github.com/aabouzaid/awesome-kustomize/pulls) or create an issue to start a discussion.
15+
1316
<!-- omit in toc -->
1417
## Contents
1518

16-
- [Introduction](#introduction)
19+
- [Overview](#overview)
1720
- [Plugins](#plugins)
1821
- [Generators](#generators)
1922
- [Transformers](#transformers)
@@ -22,18 +25,13 @@ Feel free to contribute to this repo, [PRs are more than welcome](https://github
2225
- [Novice](#novice)
2326
- [Intermediate](#intermediate)
2427
- [Advanced](#advanced)
25-
- [Tips \& Tricks](#tips--tricks)
28+
- [Tips \& Tricks](#tips--tricks)
2629
- [Misc](#misc)
2730
- [Related lists](#related-lists)
2831

29-
## Introduction
30-
31-
Kustomize introduces a template-free way to customize Kubernetes manifests. It uses a purely declarative approach
32-
to configuration customization, which will help you efficiently manage your Infrastructure as a code (IaC).
32+
## Overview
3333

34-
Kustomize works as a standalone binary; also, it's built into `kubectl` (since v1.14). It can be used with
35-
off-the-shelf applications like **Helm charts**. Also, it has a deep integration with different **GitOps** tools
36-
like ArgoCD, Flux, and many others.
34+
Kustomize works as a standalone binary; also, it's built into `kubectl` (since v1.14). It can be used with off-the-shelf applications like **Helm charts**. Also, it has a deep integration with different **GitOps** tools like ArgoCD, Flux, and many others.
3735

3836
## Plugins
3937

@@ -69,38 +67,38 @@ Kustomize has 3 types of plugins `generator`, `transformer`, and `validator`.
6967

7068
## Guides
7169

72-
📰 Article, 📺 Video, 🧪 Lab
70+
Kustomize guides based on their level or type like 📰 Article, 📺 Video, 🧪 Lab.
7371

7472
### Novice
7573

76-
- 📰 [Declarative Management of Kubernetes Objects Using Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) - Kubernetes Docs
77-
- 📰 [Configure Kubernetes with Kustomize](https://cloud.google.com/anthos-config-management/docs/concepts/kustomize) - Google Cloud
78-
- 📺 [Organizing the YAML mess with Kustomize](https://www.youtube.com/watch?v=1fCAwFGX38U&t=77s) - Florian Assmus
79-
- 📺 [Kustomize: Deploy Your App with Template Free YAML](https://www.youtube.com/watch?v=ahMIBxufNR0) - Ryan Cox, Lyft
74+
- 📰 [Declarative Management of Kubernetes Objects Using Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) - The official Kubernetes documentation task for Kustomize.
75+
- 📰 [Configure Kubernetes with Kustomize](https://cloud.google.com/anthos-config-management/docs/concepts/kustomize) - A guide helps to get started with Kustomize, understand its intended use cases, and find resources for using it with other Google Cloud tools.
76+
- 📺 [Organizing the YAML mess with Kustomize](https://www.youtube.com/watch?v=1fCAwFGX38U) - A talk shows how Kustomize could help to manage Kubernetes YAML files with a growing number of services and environments.
77+
- 📺 [Kustomize: Deploy Your App with Template Free YAML](https://www.youtube.com/watch?v=ahMIBxufNR0) - A talk introduces Kustomize, a declarative application management system, that allows deployments to be described as template free YAML.
8078

8179
### Intermediate
8280

83-
- 🧪 [ArgoCD GitOps Tutorial - Working with Kustomize](https://developers.redhat.com/learning/learn:openshift:develop-gitops/resource/resources:working-kustomize) - Red Hat Developer
84-
- 📰 [3 ways to customize off-the-shelf Helm charts with Kustomize](https://tech.aabouzaid.com/2020/09/3-ways-to-customize-off-the-shelf-helm-charts-with-kustomize-kubernetes.html) - Ahmed AbouZaid
81+
- 🧪 [ArgoCD GitOps Tutorial - Working with Kustomize](https://developers.redhat.com/learning/learn:openshift:develop-gitops/resource/resources:working-kustomize) - A hands-on lab covers using Kustomize in GitOps and it goes through the Kustomize syntax and deploying a Kustomized application.
82+
- 📰 [3 ways to customize off-the-shelf Helm charts with Kustomize](https://tech.aabouzaid.com/2020/09/3-ways-to-customize-off-the-shelf-helm-charts-with-kustomize-kubernetes.html) - A guide covers 3 different ways to use Kustomize and Helm together.
8583

8684
### Advanced
8785

88-
- 📰 [Advanced Kustomize features](https://www.innoq.com/en/blog/advanced-kustomize-features/) - INNOQ
89-
- 📰 [Set OpenAPI patch strategy for Kubernetes Custom Resources](https://tech.aabouzaid.com/2022/11/set-openapi-patch-strategy-for-kubernetes-custom-resources-kustomize.html) - Ahmed AbouZaid
90-
- 📺 [Customizing Kustomize with Client-Side Custom Resources](https://www.youtube.com/watch?v=YlFUv4F5PYc) - Katrina Verey, Apple & Jeff Regan, Google
91-
- 📺 [Own your YAML: extending Kustomize via Plugins](https://www.youtube.com/watch?v=Xoh_OpLoVtI) - Matt McEuen
92-
86+
- 📰 [Advanced Kustomize features](https://www.innoq.com/en/blog/advanced-kustomize-features/) - A guide covers more than 5 advanced Kustomize capabilities.
87+
- 📰 [Set OpenAPI patch strategy for Kubernetes Custom Resources](https://tech.aabouzaid.com/2022/11/set-openapi-patch-strategy-for-kubernetes-custom-resources-kustomize.html) - A guide shows how to provide schema to control the patch strategy of the CRDs.
88+
- 📺 [Customizing Kustomize with Client-Side Custom Resources](https://www.youtube.com/watch?v=YlFUv4F5PYc) - A talk covers extending Kustomize via plugins to address common yet idiosyncratic application needs.
89+
- 📺 [Own your YAML: extending Kustomize via Plugins](https://www.youtube.com/watch?v=Xoh_OpLoVtI) - A talk shows how to create custom resources using Kustomize external plugins.
90+
- 📰 [Kustomize Enhancement with KRM Functions](https://www.innoq.com/en/blog/kustomize-enhancement-with-krm-functions/) - A detailed guide covers KRM concept and how to use it in Kustomize plugins.
9391

94-
## Tips & Tricks
92+
### Tips & Tricks
9593

96-
- 📰 [Delete a manifest from a Kustomize base](https://tech.aabouzaid.com/2021/05/delete-a-manifest-from-kustomize-base.html)
97-
- 📰 [Apply Kustomize builtin transformers on a single resource](https://tech.aabouzaid.com/2022/04/apply-kustomize-builtin-transformers-on-a-single-resource.html)
98-
- 📰 [Pass extra data to the Containerized KRM function](https://tech.aabouzaid.com/2022/12/pass-extra-data-to-the-containerized-krm-function.html)
94+
- 📰 [Delete a manifest from a Kustomize base](https://tech.aabouzaid.com/2021/05/delete-a-manifest-from-kustomize-base.html) - A handy way to delete named manifest using Kustomize patch.
95+
- 📰 [Apply Kustomize builtin transformers on a single resource](https://tech.aabouzaid.com/2022/04/apply-kustomize-builtin-transformers-on-a-single-resource.html) - A way to use internal transformers on specific resources.
96+
- 📰 [Pass extra data to the Containerized KRM function](https://tech.aabouzaid.com/2022/12/pass-extra-data-to-the-containerized-krm-function.html) - Different cases of share data with Containerized KRM function.
9997

10098

10199
## Misc
102100

103-
- [Kustomize plugin for asdf version manager](https://github.com/Banno/asdf-kustomize)
101+
- [asdf-kustomize](https://github.com/Banno/asdf-kustomize) - Kustomize plugin for asdf version manager.
104102

105103

106104
## Related lists

0 commit comments

Comments
 (0)