--- title: "Helm Chart" description: "pull GitHub repositories and Docker images to scan for symbol content\ \ from Helm charts" source: "https://github.com/log-10x/modules/tree/main/pipelines/compile/modules/pull/helm/module.yaml" icon: "simple/helm" --- Scan Helm [chart](https://helm.sh/docs/topics/charts/){target="\_blank"}, [template](https://helm.sh/docs/helm/helm_template/){target="\_blank"}, and [values](https://helm.sh/docs/chart_template_guide/values_files/){target="\_blank"} files for Docker container [image](https://doc.log10x.com/compile/pull/docker/ "Pull Docker image files to scan for symbol content") and [GitHub](https://doc.log10x.com/compile/pull/github/ "Pull folders from GitHub repositories to scan for symbol content") repositories to pull and [scan](https://doc.log10x.com/compile/scan/ "Capture symbol values from source code/binary files and link to an output symbol library") for symbols. !!! tenx-helm "Helm CLI" The scanner uses the Helm CLI to connect and [show charts](https://helm.sh/docs/helm/helm_show_chart/), so ensure the CLI is installed on your local machine or use the compiler [Docker image](https://doc.log10x.com/install/docker/). ## :material-wrench-outline: Config Files To configure the Helm chart module, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files. Below is the default configuration from: [helm/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/compile/pull/helm/config.yaml "helm/config.yaml"){target="\_blank"} ().

Edit Online

```yaml # 🔟❎ 'compile' k8s Helm scanner configuration # Configures the k8s Helm chart symbol scanner which pulls referenced GitHub source repositories and # Docker container images to scan for symbol values. # To learn more see https://doc.log10x.com/compile/pull/helm # For a reference list of common infrastructure charts, see: # modules/pipelines/compile/modules/pull/helm/library.yaml # Set the 10x pipeline to 'compile' tenx: compile # =============================== Helm Options =============================== helm: # Charts can be specified as Helm chart names OR as local chart files. # 'chartNames' specifies a list of remote chart names to scan for values and template files. chartNames: [ # open-telemetry/opentelemetry-demo, # ingress-nginx/ingress-nginx, ] # 'chartFiles' specifies a list of local chart template and values.yaml files on disk. # File paths may be relative to the 'includePaths' list. If canonical, enclosing folders must added to 'includePaths'. chartFiles: [ # charts/opentelemetry-demo/values.yaml ] pull: # 'dockerImages' specifies whether to pull docker container images referenced by input charts # To learn more see https://doc.log10x.com/compile/pull/docker dockerImages: true github: # 'repos' specifies whether to pull GitHub repos referenced by 'org.opencontainers.image.source' annotations # To learn more see https://github.com/opencontainers/image-spec/blob/v1.0.1/annotations.md#pre-defined-annotation-keys repos: true # 'token' specifies the GitHub access token for pulling from referenced repos # To learn more see: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens token: $=TenXEnv.get("GH_TOKEN") # (❗ EnvVar REQUIRED) ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") the Helm chart: |Name|Description|Category| |---|---|---| |[helmChartNames](#helmchartnames "list of charts to pull")|List of charts to pull|General| |[helmChartFiles](#helmchartfiles "list of charts templates and value files to scan")|List of charts templates and value files to scan|General| |[helmPullGithubRepos](#helmpullgithubrepos "pull GitHub repos")|Pull GitHub repos|General| |[helmPullGithubToken](#helmpullgithubtoken "GitHub API token for pulling repositories")|GitHub API token for pulling repositories|General| |[helmPullDockerImages](#helmpulldockerimages "pull docker container images")|Pull docker container images|General| |[helmCommand](#helmcommand "path to Helm command")|Path to Helm command|Process| |[helmGitHubRepoPaths](#helmgithubrepopaths "YAML DOM paths for extracting GitHub repos")|YAML DOM paths for extracting GitHub repos|Process| |[helmDockerImagePaths](#helmdockerimagepaths "YAML DOM paths for extracting Docker repo references")|YAML DOM paths for extracting Docker repo references|Process| ### General #### :material-menu-right-outline:**`helmChartNames`** List of charts to pull. |Type|Default|Category| |---|---|---| |List|\[\]|General| Specifies a list of chart names (e.g., open-telemetry/opentelemetry-demo) to pass to [helmCommand](https://doc.log10x.com/compile/pull/helm/#helmcommand "path to Helm command"). The scanner will invoke the [template](https://helm.sh/docs/helm/helm_template/){target="\_blank"} and [show chart](https://helm.sh/docs/helm/helm_show_chart/){target="\_blank"} commands to pull its values.yaml and chart.yaml files to scan for Docker container images and GitHub repo files. #### :material-menu-right-outline:**`helmChartFiles`** List of charts templates and value files to scan. |Type|Default|Category| |---|---|---| |List|\[\]|General| Specifies a list of chart value and templates files to scan. These file paths may be relative to the include paths list. If file paths are canonical, their enclosing folders must be included in the includePaths argument. #### :material-menu-right-outline:**`helmPullGithubRepos`** Pull GitHub repos. |Type|Default|Category| |---|---|---| |Boolean|false|General| Specifies whether to pull [GitHub repos](https://doc.log10x.com/compile/pull/github/ "Pull folders from GitHub repositories to scan for symbol content") referenced by an input Helm template files. #### :material-menu-right-outline:**`helmPullGithubToken`** GitHub API token for pulling repositories. |Type|Default|Category| |---|---|---| |String|""|General| Defines an access token for pulling [Github repos](https://doc.log10x.com/compile/pull/github/ "Pull folders from GitHub repositories to scan for symbol content") referenced by Helm charts. #### :material-menu-right-outline:**`helmPullDockerImages`** Pull docker container images. |Type|Default|Category| |---|---|---| |Boolean|true|General| Specifies whether to pull [Docker images](https://doc.log10x.com/compile/pull/docker/ "Pull Docker image files to scan for symbol content") referenced by an input Helm values and template files. ### Process #### :material-menu-right-outline:**`helmCommand`** Path to Helm command. |Type|Default|Category| |---|---|---| |String|\*NIX: /usr/local/bin/helm, Win: C:/Program Files/helm/helm.exe|Process| Defines the path to the [Helm](https://helm.sh/){target="\_blank"} program used for querying chart templates and values. This value must be set if [helmChartNames](https://doc.log10x.com/compile/pull/helm/#helmchartnames "list of charts to pull") is set. #### :material-menu-right-outline:**`helmGitHubRepoPaths`** YAML DOM paths for extracting GitHub repos. |Type|Default|Category| |---|---|---| |String|\[metadata.repository, spec.source.git, chart.repository\]|Process| specifies paths within a YAML file to treat as holders for GitHub repo names. For example, for the following section from an input chart.yaml file: ```yaml sources: - https://github.com/open-telemetry/opentelemetry-demo # capture this GitHub repo reference ``` #### :material-menu-right-outline:**`helmDockerImagePaths`** YAML DOM paths for extracting Docker repo references. |Type|Default|Category| |---|---|---| |String|\[spec.template.spec.containers.image, values.image, spec.containers.image, sources\]|Process| specifies paths within a helm YAML file to treat as holders for Docker image names. For example, for the following section from an input values.yaml file: ```yaml spec: serviceAccountName: opentelemetry-demo containers: - name: accountingservice image: 'docker.io/grafana/grafana:11.1.0' # capture this docker image reference ```
:material-github: This module is defined in [helm/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/compile/modules/pull/helm/module.yaml "helm/module.yaml"){target="\_blank"}.