Skip to content

Commit

Permalink
Merge pull request #4 from johanneskastl/20230309_blocky_leftovers
Browse files Browse the repository at this point in the history
cleanup README for blocky
  • Loading branch information
Johannes Kastl authored Mar 9, 2023
2 parents 773bdf1 + 26e6791 commit ce604fd
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 30 deletions.
4 changes: 2 additions & 2 deletions charts/blocky/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: v2
appVersion: v0.20
description: DNS proxy as ad-blocker for local network
name: blocky
version: 11.0.1
version: 11.0.2
kubeVersion: ">=1.19.0-0"
keywords:
- blocky
Expand All @@ -27,4 +27,4 @@ dependencies:
annotations:
artifacthub.io/changes: |-
- kind: changed
description: Update appVersion to v0.20
description: adapt README
66 changes: 40 additions & 26 deletions charts/blocky/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# blocky

![Version: 10.5.2](https://img.shields.io/badge/Version-10.5.2-informational?style=flat-square) ![AppVersion: v0.18](https://img.shields.io/badge/AppVersion-v0.18-informational?style=flat-square)
![Version: 11.0.0](https://img.shields.io/badge/Version-10.5.2-informational?style=flat-square) ![AppVersion: v0.20](https://img.shields.io/badge/AppVersion-v0.18-informational?style=flat-square)

DNS proxy as ad-blocker for local network

Expand All @@ -19,22 +19,22 @@ Kubernetes: `>=1.19.0-0`
| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | redis | 16.13.1 |
| https://library-charts.k8s-at-home.com | common | 4.5.2 |
| https://johanneskastl.github.io/helm-charts/ | common | 5.0.0 |

## TL;DR

```console
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo add johanneskastl-helm-charts https://johanneskastl.github.io/helm-charts/
helm repo update
helm install blocky k8s-at-home/blocky
helm install blocky johanneskastl-helm-charts/blocky
```

## Installing the Chart

To install the chart with the release name `blocky`

```console
helm install blocky k8s-at-home/blocky
helm install blocky johanneskastl-helm-charts/blocky
```

## Uninstalling the Chart
Expand All @@ -50,34 +50,29 @@ The command removes all the Kubernetes components associated with the chart **in
## Configuration

Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
Other values may be used from the [values.yaml](https://github.com/johanneskastl/helm-charts/tree/main/charts/common/values.yaml) from the [common library](https://github.com/johanneskastl/helm-charts/tree/main/charts/common).

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

```console
helm install blocky \
--set env.TZ="America/New York" \
k8s-at-home/blocky
johanneskastl-helm-charts/blocky
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

```console
helm install blocky k8s-at-home/blocky -f values.yaml
helm install blocky johanneskastl-helm-charts/blocky -f values.yaml
```

## Custom configuration

### [10.3.0]

### Added

- Add dependency for redis database as the application now supports it. [Redis - Blocky](https://0xerr0r.github.io/blocky/configuration/#redis)
- The redis dependency increases the minimum latest version of k8s to version 1.19+
N/A

## Values

**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
**Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/johanneskastl/helm-charts/tree/main/charts/common)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
Expand Down Expand Up @@ -105,30 +100,49 @@ helm install blocky k8s-at-home/blocky -f values.yaml

## Changelog

### Version 10.5.2
### Version 11.0.2

#### Added

N/A

#### Changed

* Upgraded `common` chart dependency to version 4.5.2
* README.md: remove leftover references to k8s-at-home in URLs
* README.md: cleanup

#### Fixed

N/A

### Older versions
### Version 11.0.1

A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/blocky?modal=changelog)
#### Added

## Support
N/A

#### Changed

* update appVersion to 0.20

#### Fixed

N/A

- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
- Join our [Discord](https://discord.gg/sTMX7Vh) community
### Version 11.0.0

#### Added

N/A

#### Changed

* Forked the chart from k8s-at-home (at version 10.5.2)

#### Fixed

N/A

## Support

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
Open an [issue](https://github.com/johanneskastl/helm-charts/issues/).
4 changes: 2 additions & 2 deletions charts/blocky/values.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#
# IMPORTANT NOTE
#
# This chart inherits from our common library chart. You can check the default values/options here:
# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
# This chart inherits from the common library chart. You can check the default values/options here:
# https://github.com/johanneskastl/helm-charts/tree/main/charts/common/values.yaml
#

image:
Expand Down

0 comments on commit ce604fd

Please sign in to comment.