5614ea7c6d
* use container image direct from the source It's possible that when this chart was first built, container images (or multi-arch images) were not available - but they are now. See https://github.com/0xERR0R/blocky/pkgs/container/blocky for images that include amd64, arm64, arm/v6, and arm/v7. * bump Chart.yml version * README updates * add a CHANGELOG note Co-authored-by: Harald Koch <chk@anemone.chk.cfrq.net> |
||
---|---|---|
.. | ||
templates | ||
.helmignore | ||
Chart.yaml | ||
README_CHANGELOG.md.gotmpl | ||
README_CONFIG.md.gotmpl | ||
README.md | ||
README.md.gotmpl | ||
values.yaml |
blocky
DNS proxy as ad-blocker for local network
This chart is not maintained by the upstream project and any issues with the chart should be raised here
Source Code
Requirements
Kubernetes: >=1.16.0-0
Dependencies
Repository | Name | Version |
---|---|---|
https://library-charts.k8s-at-home.com | common | 4.2.0 |
TL;DR
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install blocky k8s-at-home/blocky
Installing the Chart
To install the chart with the release name blocky
helm install blocky k8s-at-home/blocky
Uninstalling the Chart
To uninstall the blocky
deployment
helm uninstall blocky
The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.
Configuration
Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.
Specify each parameter using the --set key=value[,key=value]
argument to helm install
.
helm install blocky \
--set env.TZ="America/New York" \
k8s-at-home/blocky
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
helm install blocky k8s-at-home/blocky -f values.yaml
Custom configuration
N/A
Values
Important: When deploying an application Helm chart you can add more values from our common library chart here
Key | Type | Default | Description |
---|---|---|---|
config | string | see URL to default config | Full list of options https://github.com/0xERR0R/blocky/blob/v0.17/docs/config.yml |
controller.replicas | int | 1 |
(int) Number of pods to load balance between |
controller.strategy | string | "RollingUpdate" |
Set the controller upgrade strategy |
env | object | See below | environment variables. See image docs for more details. |
env.TZ | string | "UTC" |
Set the container timezone |
image.pullPolicy | string | "IfNotPresent" |
image pull policy |
image.repository | string | "ghcr.io/0xerr0r/blocky" |
image repository |
image.tag | string | "v0.17" |
image tag |
metrics.enabled | bool | See values.yaml | Enable and configure a Prometheus serviceMonitor for the chart under this key. |
metrics.prometheusRule | object | See values.yaml | Enable and configure Prometheus Rules for the chart under this key. |
metrics.prometheusRule.rules | list | See prometheusrules.yaml | Configure additionial rules for the chart under this key. |
metrics.serviceMonitor.interval | string | "30s" |
Interval at which Prometheus should scrape metrics |
metrics.serviceMonitor.jobLabel | string | "" |
The Kubernetes Endpoints label to use as the Prometheus job name |
metrics.serviceMonitor.labels | object | {} |
Additional labels for the Kubernetes ServiceMonitor object |
metrics.serviceMonitor.podTargetLabels | list | [] |
PodTargetLabels transfers labels on the Kubernetes `Pod`` onto the created metrics. |
metrics.serviceMonitor.scrapeTimeout | string | "10s" |
Timeout after which the scrape is ended |
metrics.serviceMonitor.targetLabels | list | [] |
TargetLabels transfers labels from the Kubernetes `Service`` onto the created metrics. |
persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
service | object | See values.yaml | Configures service settings for the chart. |
Changelog
All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click here.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[10.0.1]
Changed
- Updated Blocky image to
ghcr.io/0xerr0r/blocky
, which is built (using GitHub Actions) by the application developer for each release.
[10.0.0]
Added
- Parameters in
values.yaml
for specifying thejobLabel
,targetLabels
, andpodTargetLabels
fields on the Prometheus ServiceMonitor object.
Changed
- BREAKING: Updated Blocky image and AppVersion to v0.17. This version of Blocky has a few backwards-incompatible
config.yml
differences compared to v0.15. Update yourconfig
chart values to check theupstream
,queryLog
,certFile
, andkeyFile
settings (if applicable).
9.0.0
Changed
- BREAKING: Refactored Prometheus metrics section to add rules. Enabling metrics automatically enables the serviceMonitor.
8.0.0
Changed
- Upgraded the common library dependency to version 4.0.0. This introduced (potentially) breaking changes to
initContainers
andadditionalContainers
. Be sure to check out the library chart for the up-to-date values.
7.0.0
Changed
- BREAKING: Upgraded the common library dependency to version 3.2.0. This introduces several breaking changes (
service
,ingress
andpersistence
keys have been refactored). Be sure to check out the library chart for the up-to-date values. - Changed image tag to
v0.14
.
6.0.0
Added
- N/A
Changed
- BREAKING Migrate Blocky to the common library, a lot of configuration has changed.
Removed
- N/A
Support
Autogenerated from chart metadata using helm-docs v1.5.0