Giter Club home page Giter Club logo

pkl-k8s-config's Introduction

Pkl/K8s Examples

What’s In This Repo?

The yaml directory contains YAML manifests for the official guestbook Kubernetes example.

The pkl/basic example demonstrates how to

  • convert YAML manifests to Pkl

  • evaluate Pkl manifests back to YAML

  • catch manifest errors during evaluation

  • apply Pkl manifests to Kubernetes.

The pkl/advanced example demonstrates how to manage Pkl manifests for multiple applications, deployment environments, and Kubernetes clusters.

To run the examples, install the Pkl CLI.

Why Pkl/K8s?

Kubernetes requires a lot of YAML configuration. To make a single configuration change, users often need to touch multiple YAML files, which is time-consuming and error-prone. Configuration errors aren’t discovered until the configuration is applied.

Pkl/K8s, a set of Pkl templates derived from Kubernetes' OpenAPI spec, is here to save the day. Writing Kubernetes manifests in Pkl offers the following benefits:

  • Strong local validation that goes beyond Kubernetes' OpenAPI spec.

  • Easy sharing of configuration across applications, environments, and clusters with the AppEnvCluster Pkl template. See the advanced example for details.

  • Great IDE experience with validation, code completion, and direct access to Kubernetes documentation. Requires the Pkl IntelliJ Plugin for JetBrains IDEs (IDEA, GoLand, PyCharm, etc).

The io.k8s.convert Pkl module automatically converts Kubernetes manifests from YAML to Pkl. See the basic example for details.

Still unconvinced? See Comparison for the Pkl team’s perspective on how Pkl compares to other configuration formats and languages,

Where To Get Help?

pkl-k8s-config's People

Contributors

holzensp avatar bioball avatar stackoverflow avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.