DOCSEARCHbyAlgolia
Submit Docs

Helm Documentation

website·Indexed 31 days ago

https://helm4docs.r6by.com/

Documentation for Helm, the package manager for Kubernetes. Includes guides for version 3.19.0 and 2.17.0, covering chart repository management, OCI support, SDK examples, plugin development, and migration from v2 to v3. Features detailed command references for 'helm status', 'helm search', and 'helm show', as well as information on chart hooks, provenance, and Kubernetes version skew.

Tokens
76.6K
Snippets
440
Records
630
Agent score
50%

What's inside Helm

  1. Overview of available Helm hooks

    Helm hooks are special annotations added to Kubernetes manifests that tell Helm to execute the resource at specific points in a release's lifecycle. If the resource is a Job or Pod, Helm waits for it to complete successfully before proceeding; otherwise, it is considered 'Ready' as soon as it is loaded into Kubernetes.

  2. Overview of Helm for Kubernetes

    Helm is a package manager for Kubernetes that allows users to define, install, and upgrade complex Kubernetes applications using 'Charts'. It provides a way to manage application complexity through repeatable installations, simplifies updates with in-place upgrades and custom hooks, and allows for easy versioning and sharing of applications via public or private servers. It also supports rolling back to older versions of a release using the helm rollback command.
    helm rollback [RELEASE] [REVISION]

  3. Overview of Helm Go SDK core packages

    The Helm Go SDK allows developers to integrate Helm chart management and Kubernetes deployment functionality into custom software. The core functionality is distributed across several key packages:

    • pkg/action: The primary client for performing Helm actions. This is the same logic used by the Helm CLI and is the recommended starting point for basic Helm commands.
    • pkg/chart and pkg/chartutil: Provide methods and helpers for loading and manipulating Helm charts.
    • pkg/cli: Handles standard Helm environment variables, output formatting, and values file processing.
    • pkg/release: Defines the Release object and its associated statuses.

  4. Overview of Helm for Kubernetes

    Helm is a CLI tool used to create, install, and manage applications (packaged as "charts") inside Kubernetes clusters. It allows teams to find prepackaged software, host their own packages, query installed packages, and perform updates, deletions, or rollbacks of application releases.

  5. Understand the removal of Tiller in Helm 3

    Helm 3 completely removes Tiller, the server-side component used in Helm 2. Helm now interacts directly with the Kubernetes API server, rendering charts client-side and storing release records in Kubernetes. This simplifies the security model, as Helm now relies on the user's kubeconfig file and standard Kubernetes RBAC for permissions and authorization.

  6. Manage resource access using PostgreSQL Row Level Security (RLS)

    The Helm SQL backend driver uses PostgreSQL Row Level Security (RLS) to handle permissions. By default, roles without explicit privileges will see an empty list when running helm list and cannot modify resources. RLS allows multiple users to access the same table while restricting them to specific rows based on defined policies.

  7. Update local chart information using helm repo update

    The helm repo update command fetches the latest information about available charts from configured chart repositories and caches them locally. This local cache is used by other commands such as helm search. You can update all configured repositories or specify a subset of repositories by name.
    # Update all configured repositories
helm repo update

# Update specific repositories
helm repo update <repo_name1> <repo_name2>

  9. Understand Helm Chart structure and packaging

    A Helm Chart is a package containing information required to install a set of Kubernetes resources. Every chart must include a Chart.yaml file. A chart typically consists of a Chart.yaml file, templates, default values (values.yaml), and dependencies. Charts are developed in a specific directory structure and can be packaged into a 'chart archive', which is a tarred and gzipped (and optionally signed) file.

  10. Access template execution metadata

    The Template object provides information about the specific template file currently being executed by the engine.
    # The namespaced file path to the current template
# e.g., mychart/templates/mytemplate.yaml
path: {{ .Template.Name }}

# The namespaced path to the templates directory
# e.g., mychart/templates
basePath: {{ .Template.BasePath }}

  11. Navigate Helm documentation by content type

    Helm documentation is organized into four primary categories to help users find information based on their needs:

    • Tutorials: Step-by-step instructions for beginners to create their first Helm chart.
    • Topic Guides: High-level discussions of key concepts and background information.
    • Community Guides: Information regarding the Helm development process and how to contribute to the project.
    • How-to Guides: Advanced 'recipes' that provide steps to solve specific problems and use-cases, assuming the user has a baseline knowledge of Helm.

  12. Understand Kubernetes user and service account types

    Kubernetes distinguishes between two types of users:

    1. Normal Users: Managed by external services (e.g., Keystone, Google Accounts, or private keys). They are not represented by objects within the Kubernetes API and cannot be added via API calls.
    2. Service Accounts: Managed by the Kubernetes API and bound to specific namespaces. They are used by in-cluster processes and are tied to credentials stored as Secrets mounted into pods.