mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-31 05:49:04 +00:00

History

Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs 530ba71802 [all] Regenerate docs Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>		2021-06-01 12:47:34 +02:00
..
templates	[gollum] New Chart (#889 )	2021-05-12 09:05:37 +02:00
Chart.yaml	[gollum] New Chart (#889 )	2021-05-12 09:05:37 +02:00
README_CHANGELOG.md.gotmpl	[gollum] New Chart (#889 )	2021-05-12 09:05:37 +02:00
README_CONFIG.md.gotmpl	[gollum] New Chart (#889 )	2021-05-12 09:05:37 +02:00
README.md	[all] Regenerate docs	2021-06-01 12:47:34 +02:00
README.md.gotmpl	[all] Regenerate docs	2021-06-01 12:47:34 +02:00
values.yaml	[gollum] New Chart (#889 )	2021-05-12 09:05:37 +02:00

README.md

gollum

Gollum is a simple wiki system built on top of Git

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	2.5.0

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install gollum k8s-at-home/gollum

Installing the Chart

To install the chart with the release name gollum

helm install gollum k8s-at-home/gollum

Uninstalling the Chart

To uninstall the gollum deployment

helm uninstall gollum

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 gollum \
  --set env.TZ="America/New York" \
    k8s-at-home/gollum

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

helm install gollum k8s-at-home/gollum -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
controllerType	string	`"statefulset"`
gollum.additionalArgs	string	`"--h1-title"`	Additional arguments for starting gollum
gollum.config	string	`"# Push and pull on commit\nGollum::Hook.register(:post_commit, :hook_id) do	committer, sha1
gollum.gitBranch	string	`"master"`	Branch to pull
gollum.gitUrl	string	`"https://github.com/k8s-at-home/charts.git"`	Repository URL to pull (accepts access tokens) Ex: https://user:access-token@git.example.com/user/repo.git
gollum.syncCommand	string	`"git pull && git push"`	Command run during the sync cron
image.pullPolicy	string	`"IfNotPresent"`
image.repository	string	`"gollumorg/gollum"`	gollum upstream image
image.tag	string	`"latest"`
ingress.enabled	bool	`false`
persistence.wiki.accessMode	string	`"ReadWriteOnce"`
persistence.wiki.enabled	bool	`false`
persistence.wiki.mountPath	string	`"/wiki"`
persistence.wiki.size	string	`"2Gi"`
service.port.name	string	`"http"`
service.port.port	int	`80`
service.port.targetPort	int	`4567`
service.type	string	`"ClusterIP"`
strategy.type	string	`"RollingUpdate"`

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.