chartflow is a thin layer on top of a Git repository to make it behave as a Helm-Charts
repository would. With the the following advantages:
- Promoting Git repository as source-of-authority over Helm-Charts;
- Low-friction workflow,
index.yamland Chart tarballs are generated dynamically; - Allowing clients to reach branches and commit-ids, with Semantic Versioning;
The basic workflow is represented as:
The usage of chartflow is regular Helm-Chart repository. Therefore, you can employ Helm in
command-line to interact with this repository. For instance:
helm repo add cs http://127.0.0.1:8080
helm repo update
helm search ...The container images are stored on quay.io/kubesmith/chartflow. To run it, execute:
podman run --publish=8080:8080 --tmpfs=/var/lib/chartflow quay.io/kubesmith/chartflow:latest
docker run --publish=8080:8080 --tmpfs=/var/lib/chartflow quay.io/kubesmith/chartflow:latestConfiguration parameters are exposed as environment variables as well, therefore using the prefix
CHART_STREAMS you can combine with the option name. For instance, clone-depth would then
become CHART_STREAMS_CLONE_DEPTH as environment variables, and on command line would then become
--clone-depth.
The configuration options available are:
| Parameter | Default | Description |
|---|---|---|
| repo-url | https://github.com/helm/charts.git | Git repository URL |
| relative-dir | stable | Relative directory in Git repository |
| clone-depth | 1 | Amount of commits from Git repository |
| listen-addr | 127.0.0.1:8080 | Address the application will be listening on |
| working-dir | /var/lib/chartflow | Git repository working directory |
| log-level | info | Log verbosity level |
Parameter repo-url takes the protocol in consideration, therefore you can use a local Git
repository with --repo-url=file://path/to/local/repo, for instance.
In order to best performance results, consider always using parameter working-dir as a
tmpfs. With docker/podman, a tmpfs volume can be informed directly on
running a container.
As a real world example, serve the last 200 commits of charts repository, with:
docker run \
--publish="8080:8080" \
--tmpfs=/var/lib/chartflow \
quay.io/kubesmith/chartflow:latest \
--clone-depth=200Now, add chartflow as a chart repository:
helm repo add cs http://127.0.0.1:8080And then, you're able to search for grafana in the repository. Notice the cs/grafana where
cs is the local name of chartflow based repository:
$ helm search repo cs/grafana
NAME CHART VERSION APP VERSION DESCRIPTION
cs/grafana 5.0.6 6.6.2 The leading tool for querying and visualizing t..
You can also search for --devel (development) versions:
$ helm search repo cs/grafana --versions --devel
NAME CHART VERSION APP VERSION DESCRIPTION
[...]
cs/grafana 2.1.0-revert-10682-master-f0cd0f9f 5.4.3 The leading tool for querying and visualizing t...
cs/grafana 2.0.2-revert-10682-master-fa4468c8 5.4.3 The leading tool for querying and visualizing t...
cs/grafana 1.14.1-update-owners-d09fd18b 5.2.3 The leading tool for querying and visualizing t...
cs/grafana 1.14.0-update-owners-2496eaf3 5.2.2 The leading tool for querying and visualizing t...
Therefore, automatically chartflow is displaying branches as development version of your
Helm-Charts, you can reach them as, for instance:
helm install grafana cs/grafana:2.0.2-revert-10682-master-fa4468c8Git repository tree is traversed commit-by-commit starting from latest. On traversing the
commits chartflow will identify from which branch each change is coming from, and with this
information publish stable and development versions of Helm-Charts, adding
semantic versioning representation understood by Helm.
Chart versions are ultimately defined by regular Chart.yaml, however it's enriched when change is
located in a branch other than master. In master the exact version present in Chart.yaml is
published, while in other branches is enriched with the branch name and short commit identifier.
For instance, lets see how grafana version 0.0.1 would be represented from a Git repository
having master a change branches, where change is ahead of master, but grafana version is
still the same in Chart.yaml.
| Git Reference Name | Version |
|---|---|
master (or HEAD) |
0.0.1 |
change (latest commit) |
0.0.1-change |
change (previous commits) |
0.0.1-change-12345678 |
In order to behave as a Helm-Charts repository, chartflow exposes the following endpoints.
Dynamically render index.yaml payload, representing actual Git repository data as Helm-Charts
repository index. Helm clients are frequently downloading this payload in order to check which charts
and versions are available in the repository.
Also generated dynamically, this endpoint exposes the "tarball" presenting the chart name (:name)
and version (:version).
All development dependencies are located at [Dockerfile.dev][./Dockerfile.dev]. To use it, run:
# build development image
make devcontainer-image
# start shell
make devcontainer-run
# execute an arbitrary command
make devcontainer-run DEVCONTAINER_ARGS='make test'For Visual Studio Code users, install Remote Containers extension,
and re-open the project in the container. Please consider [.devcontainer.json][.devcontainer.json]
for details.
Building the application requires libgit2 installed, please consider Dockerfile.dev
for details. In order to build the project run:
makeAnd in order to run automated tests, execute:
make testAdditionally, consider .editorconfig file for code standards, and
.travis.yml for the continuous integration steps.