https://github.com/farcaller/nixhelm

This is a collection of helm charts in a nix-digestable format.
https://github.com/farcaller/nixhelm

chart charts helm kubernetes nix

Last synced: 3 months ago
JSON representation

This is a collection of helm charts in a nix-digestable format.

• Host: GitHub
• URL: https://github.com/farcaller/nixhelm
• Owner: farcaller
• License: apache-2.0
• Created: 2022-12-15T11:30:25.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-19T00:58:31.000Z (3 months ago)
• Last Synced: 2024-03-19T01:55:31.572Z (3 months ago)
• Topics: chart, charts, helm, kubernetes, nix
• Language: Nix
• Homepage:
• Size: 714 KB
• Stars: 60
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• my-awesome-stars - farcaller/nixhelm - This is a collection of helm charts in a nix-digestable format. (Nix)

README

        
# nixhelm

This is a collection of helm charts in a nix-digestable format.

## Supported chart repoitories

Nixhelm supports only the traditional helm chart repos (served over http[s]).

The support for OCI charts is [pending](https://github.com/farcaller/nixhelm/issues/1).

If your chart is hosted in a git repo, remember that you can fetch it as a flake

input and pass to `buildHelmChart` [directly](https://github.com/farcaller/nixhelm/issues/10).

## Outputs

The flake has the following outputs:

`chartsMetadata.${repo}.${chart}` contains the metadata about a specific chart.

`chartsDerivations.${system}.${repo}.${chart}` contains the derivations producing

the charts.

`charts { pkgs = ... }.${repo}.${chart}` a shortcut for the above that doesn't

depend on the nixpkgs input and allows to specify any nixpkgs.

The charts are updated nightly.

## Usage

```sh

nix build .#chartsDerivations.x86_64-linux."argoproj"."argo-cd"

```

Will download the Argo CD helm chart to `result/`.

To build a chart, you should use the kube generators from

[github:farcaller/nix-kube-generators](https://github.com/farcaller/nix-kube-generators),

and just pass your chart to the `buildCharts` function. So for example to render

the Argo CD chart:

```nix

      argo = (kubelib.buildHelmChart {

        name = "argo";

        chart = (nixhelm.charts { inherit pkgs; }).argoproj.argo-cd;

        namespace = "argo";

      });

```

If you want to use this setup within Argo CD, check out [cake](https://github.com/farcaller/cake).

## Using the cache

This repository and all the charts within are publicly cached at `cachix` as

[nixhelm](https://app.cachix.org/cache/nixhelm). Here's how you can quickly

enable it in your nix installation:

### Without flakes

```sh

nix-env -iA cachix -f https://cachix.org/api/v1/install

```

### With flakes

```sh

nix profile install nixpkgs#cachix

```

### Then enable the cache

```sh

cachix use nixhelm

```

Alternatively, manually add this to `/etc/nix/nix.conf`:

```nix

substituters = https://cache.nixos.org https://nixhelm.cachix.org

trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= nixhelm.cachix.org-1:esqauAsR4opRF0UsGrA6H3gD21OrzMnBBYvJXeddjtY=

```

## Adding new charts

Clone the repository and run the following command from within it:

```sh

nix run .#helmupdater -- init $REPO $REPO_NAME/$CHART_NAME --commit

```

Where `REPO` is the url to the chart, `REPO_NAME` is the short name for the

repository and the `CHART_NAME` is the name of the chart in the repository.

For example, if you want to add [bitnami's

nginx](https://github.com/bitnami/charts/tree/main/bitnami/nginx), run the

following command:

```sh

nix run .#helmupdater -- init "https://charts.bitnami.com/bitnami" bitnami/nginx --commit

```

The command will create the properly formatted commit that you can then submit

as a pull request to the repo.

## License

Apache-2.0