Skip to content

Commit 07548dc

Browse files
committed
update README to include details about the chart
1 parent 9bd558b commit 07548dc

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# v0.3.3
2+
3+
Released 2020-12-20
4+
5+
- multi-arch docker builds
6+
- move from travis-ci to github actions
7+
- created a corresponding chart repo to install with helm
8+
19
# v0.3.0
210

311
Released 2020-05-21

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
![Image](https://img.shields.io/docker/pulls/travisghansen/kubernetes-pfsense-controller.svg)
2+
![Image](https://img.shields.io/github/workflow/status/travisghansen/kubernetes-pfsense-controller/CI?style=flat-square)
3+
14
# Intro
25
[kubernetes-pfsense-controller (kpc)](https://github.com/travisghansen/kubernetes-pfsense-controller) works hard to keep
36
[pfSense](https://www.pfsense.org/) and [Kubernetes](https://kubernetes.io/) in sync and harmony. The primary focus is
@@ -14,6 +17,31 @@ Disclaimer: this is new software bound to have bugs. Please make a backup befor
1417
configuration. Having said that, all known code paths appear to be solid and working without issue. If you find a bug,
1518
please report it!
1619

20+
Updated disclaimer: this software is no longer very new, but is still bound to have bugs. Continue to make backups as
21+
appropriate :) Having said that, it's been used for multiple years now on several systems as has yet to do anything
22+
evil.
23+
24+
# Installation
25+
26+
Various files are available in the `deploy` directory of the project, alter to your needs and `kubectl apply`.
27+
28+
Alternatively, a helm repository is provided for convenience:
29+
30+
```
31+
helm repo add kubernetes-pfsense-controller https://travisghansen.github.io/kubernetes-pfsense-controller-chart/
32+
helm repo update
33+
34+
# create your own values.yaml file and edit as appropriate
35+
# https://github.com/travisghansen/kubernetes-pfsense-controller-chart/blob/master/stable/kubernetes-pfsense-controller/values.yaml
36+
helm upgrade \
37+
--install \
38+
--create-namespace \
39+
--namespace kpc \
40+
--values values.yaml \
41+
kpc-primary \
42+
kubernetes-pfsense-controller/kubernetes-pfsense-controller
43+
```
44+
1745
# Plugins
1846
The controller is comprised of several plugins that are enabled/disabled/configured via a Kubernetes ConfigMap. Details
1947
about each plugin follows below.

0 commit comments

Comments
 (0)