Course contentsShow
← Cloud and Infrastructure
Lesson 1544 of 2,98931. Helm Package ManagerFree lesson

NOTES.txt and User Instructions

Create helpful post-install messages in NOTES.txt to guide users on accessing and using the deployed application.

NOTES.txt and User Instructions

What You'll Learn

You'll learn how to create helpful post-install messages in Helm charts using NOTES.txt to guide users on accessing and using the deployed application.

The Problem with Silent Deployments

When you deploy a Helm chart, the installation succeeds, but then what? Users are left wondering: How do I access this application? What's the service URL? What credentials should I use? Without guidance, even successful deployments feel incomplete.

What is NOTES.txt?

NOTES.txt is a special template file in your chart that displays custom instructions immediately after installation or upgrade. Think of it as a post-installation receipt that tells users exactly what they need to know to start using their application.

The file lives at templates/NOTES.txt in your chart structure and supports the same Go templating features as other templates—you can include conditional logic, access values, and dynamically generate URLs.

Why NOTES.txt Matters

Imagine deploying a database chart. Your NOTES.txt can automatically:

  • Display the connection string using the actual service name
  • Show commands to retrieve auto-generated passwords
  • Provide port-forwarding instructions for local access
  • Explain next steps for configuration

This turns a raw deployment into a user-friendly experience, dramatically reducing support questions and onboarding time.

Common Patterns

Good NOTES.txt files typically include:

  • Access instructions: How to reach the application (LoadBalancer IP, NodePort, port-forward commands)
  • Credential retrieval: Commands to get secrets or passwords
  • Verification steps: How to test the deployment worked
  • Next actions: Links to documentation or configuration guides

The output appears after helm install or helm upgrade, making it impossible to miss.

Key Takeaway: NOTES.txt transforms your Helm chart from a deployment tool into a complete user experience by providing contextual, dynamic post-install guidance that helps users immediately access and use their applications.