Learning Helm by Matt Butcher -- Read -- Imperial Library of Trantor

Index

Preface

Who Should Read This Book Why We Wrote This Book Navigating This Book Conventions Used in This Book Using Code Examples O’Reilly Online Learning How to Contact Us Acknowledgments

1. Introducing Helm

The Cloud Native Ecosystem

Containers and Microservices

Microservices Containers Container images and registries

Schedules and Kubernetes

Declarative infrastructure The reconciliation loop From containers to pods, services, deployments, etc.

Helm’s Goals

From Zero to Kubernetes Package Management Security, Reusability, and Configurability

Security Reusability Configurability

Helm’s Architecture

Kubernetes Resources Charts Resources, Installations, and Releases A Brief Note About Helm 2

Conclusion

2. Using Helm

Installing and Configuring the Helm Client

Installing a Prebuilt Binary

A note on Helm version numbers Downloading the binary Using the get script to install

Guidance on Building from Source Working with Kubernetes Clusters Getting Started with Helm

Adding a Chart Repository Searching a Chart Repository Installing a Package

Configuration at Installation Time

Listing Your Installations Upgrading an Installation

Configuration Values and Upgrades

Uninstalling an Installation

How Helm Stores Release Information

Conclusion

3. Beyond the Basics with Helm

Templating and Dry Runs

The --dry-run Flag The helm template Command

Learning About a Release

Release Records Listing Releases Find Details of a Release with helm get

Using helm get notes Using helm get values Using helm get manifest

History and Rollbacks

Keeping History and Rolling Back

A Deep Dive into Installs and Upgrades

The --generate-name and --name-template Flags The --create-namespace Flag Using helm upgrade --install The --wait and --atomic Flags Upgrading with --force and --cleanup-on-fail

Conclusion

4. Building a Chart

The Chart Creation Command The Chart.yaml File Modifying Templates

The Deployment

Using the Values File

Container Images Exposing Services Resource Limits

Packaging the Chart Linting Charts Conclusion

5. Developing Templates

The Template Syntax

Actions Information Helm Passes to Templates Pipelines Template Functions Methods Querying Kubernetes Resources In Charts if/else/with Variables Loops

Named Templates Structuring Your Templates for Maintainability Debugging Templates

Dry Run Getting Installed Manifests Linting Charts

Conclusion

6. Advanced Chart Features

Chart Dependencies

Conditional Flags for Enabling Dependencies Importing Values from Child to Parent Charts

The exports property The child-parent format

Library Charts Schematizing Values Files Hooks Adding Tests to Charts

Helm Test Chart Testing Tool

Security Considerations Custom Resource Definitions Conclusion

7. Chart Repositories

The Repository Index

An Example of a Chart Repository Index Generating an Index Adding to an Existing Index

Setting Up a Chart Repository

A Simple Chart Repository with Python Securing a Chart Repository

Basic auth Client certificates

Real-World Example: Using GitHub Pages

Create a new Git repo Enable GitHub Pages Optional: Use a custom domain Adding chart repository files Using your GitHub Pages site as a chart repository

Using Chart Repositories

Adding a Repository Downloading Charts Listing Repositories Updating Repositories Removing a Repository

Experimental OCI Support

Enabling OCI Support Running a Local Registry Logging In to a Registry Logging Out of a Registry Storing a Chart in the Cache Listing Charts in the Cache Exporting a Chart from the Cache Pushing a Chart to the Registry Pulling a Chart from the Registry Removing a Chart from the Cache

Related Projects

ChartMuseum Harbor Chart Releaser S3 Plugin GCS Plugin Git Plugin

8. Helm Plugins and Starters

Plugins

Installing Third-Party Plugins Custom Subcommands Building a Plugin

The underlying implementation The plugin manifest Manual installation The end result

plugin.yaml Hooks Downloader Plugins Execution Environment Shell Completion

Static autocompletion Dynamic completion

Starters

Converting a Chart to a Starter Making Starters Available to Helm Using Starters

Extending Helm Further

A. Chart API Versions

API Version 2

The Chart.yaml File

Field: apiVersion Field: name Field: version Field: type Field: description Field: appVersion Field: home Field: icon Field: sources Field: keywords Field: maintainers Field: deprecated Field: annotations Field: kubeVersion Field: dependencies

The Chart.lock File

API Version 1 (legacy)

The Chart.yaml File

Differences from v2 Field: tillerVersion (legacy) Field: engine (legacy)

The requirements.yaml File (Legacy) The requirements.lock File (Legacy)

B. Chart Repository API

index.yaml

The index.yaml Format When Is index.yaml Downloaded? When Is the Cached Version of index.yaml Used?

.tgz Files

When Are .tgz Files Downloaded?

.prov Files

When Are .prov Files Downloaded?

Index

← Prev
Back
Next →

← Prev
Back
Next →