Search icon
Arrow left icon
All Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletters
Free Learning
Arrow right icon
Learn Helm

You're reading from  Learn Helm

Product type Book
Published in Jun 2020
Publisher Packt
ISBN-13 9781839214295
Pages 344 pages
Edition 1st Edition
Languages
Authors (2):
Andrew Block Andrew Block
Profile icon Andrew Block
Austin Dewey Austin Dewey
Profile icon Austin Dewey
View More author details

Table of Contents (15) Chapters

Preface 1. Section 1: Introduction and Setup
2. Chapter 1: Understanding Kubernetes and Helm 3. Chapter 2: Preparing a Kubernetes and Helm Environment 4. Chapter 3: Installing your First Helm Chart 5. Section 2: Helm Chart Development
6. Chapter 4: Understanding Helm Charts 7. Chapter 5: Building Your First Helm Chart 8. Chapter 6: Testing Helm Charts 9. Section 3: Adanced Deployment Patterns
10. Chapter 7: Automating Helm Processes Using CI/CD and GitOps 11. Chapter 8: Using Helm with the Operator Framework 12. Chapter 9: Helm Security Considerations 13. ASSESSMENTS 14. Other Books You May Enjoy

Documenting a Helm chart

As with any other software that users interact with, a Helm chart should be properly documented so that users know how to interact with it. The Helm chart structure supports a README.md file for documenting usage, a LICENSE file for covering usage and distribution rights, and a templates/NOTES.txt file for generating usage instructions during chart installation.

The README.md File

README is a file commonly used in software development to describe the installation, usage, and other details of a product. A Helm chart's README file often contains the following details:

  • Prerequisites: A common example of a prerequisite is creating a secret or a set of secrets to the Kubernetes cluster before a chart is installed. for the purpose of mounting to a Kubernetes deployment. Users can be made aware of this requirement by referencing the README file.
  • Values: Charts often consist of many different values, each of which should be described in a table...
lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at €14.99/month. Cancel anytime}