From 37837f20cba6aabd90e1b5455dc88771c843b1d2 Mon Sep 17 00:00:00 2001 From: Gabe Cook Date: Mon, 27 Mar 2023 17:39:58 -0500 Subject: [PATCH] :sparkles: (memos): Initial release --- README.md | 1 + charts/memos/.helmignore | 25 +++++++ charts/memos/Chart.lock | 6 ++ charts/memos/Chart.yaml | 26 ++++++++ charts/memos/README.md | 97 ++++++++++++++++++++++++++++ charts/memos/README_CONFIG.md.gotmpl | 9 +++ charts/memos/templates/NOTES.txt | 1 + charts/memos/templates/common.yaml | 1 + charts/memos/values.yaml | 56 ++++++++++++++++ 9 files changed, 222 insertions(+) create mode 100644 charts/memos/.helmignore create mode 100644 charts/memos/Chart.lock create mode 100644 charts/memos/Chart.yaml create mode 100644 charts/memos/README.md create mode 100644 charts/memos/README_CONFIG.md.gotmpl create mode 100644 charts/memos/templates/NOTES.txt create mode 100644 charts/memos/templates/common.yaml create mode 100644 charts/memos/values.yaml diff --git a/README.md b/README.md index d11f082a0..b712ad116 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ helm delete my- | [homer homer icon](charts/homer/) | A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. | | [limo ](charts/limo/) | A file upload server. | | [matrimony matrimony icon](charts/matrimony/) | Self-hosted wedding site configured via YAML | +| [memos memos icon](charts/memos/) | A lightweight, self-hosted memo hub. Open Source and Free forever. | | [miniflux miniflux icon](charts/miniflux/) | Miniflux is a minimalist and opinionated feed reader. | | [mnemonic-ninja mnemonic-ninja icon](charts/mnemonic-ninja/) | Mnemonic Ninja is a website to convert between a number and its corresponding word to aid in memorization. | | [monica monica icon](charts/monica/) | Personal CRM. Remember everything about your friends, family and business relationships. | diff --git a/charts/memos/.helmignore b/charts/memos/.helmignore new file mode 100644 index 000000000..f56cea6b7 --- /dev/null +++ b/charts/memos/.helmignore @@ -0,0 +1,25 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# helm-docs templates +*.gotmpl diff --git a/charts/memos/Chart.lock b/charts/memos/Chart.lock new file mode 100644 index 000000000..c5c26e557 --- /dev/null +++ b/charts/memos/Chart.lock @@ -0,0 +1,6 @@ +dependencies: +- name: common + repository: https://bjw-s.github.io/helm-charts + version: 1.3.2 +digest: sha256:9bb4816882dfc02904f9f347a7995bf7acefd55bd60f925c3a8d80938a2b1ec0 +generated: "2023-02-19T11:54:44.803013189Z" diff --git a/charts/memos/Chart.yaml b/charts/memos/Chart.yaml new file mode 100644 index 000000000..b6c562e0c --- /dev/null +++ b/charts/memos/Chart.yaml @@ -0,0 +1,26 @@ +apiVersion: v2 +name: memos +description: A lightweight, self-hosted memo hub. Open Source and Free forever. +home: https://charts.gabe565.com/charts/memos +icon: https://raw.githubusercontent.com/usememos/memos/2e14561bfce0092851ab612b6d849b9c9815228c/web/public/logo.png +type: application +version: 0.1.0 +# renovate datasource=docker depName=neosmemo/memos +appVersion: 0.11.2 +kubeVersion: ">=1.22.0-0" +keywords: + - memo + - markdown + - note-taking +dependencies: + - name: common + repository: https://bjw-s.github.io/helm-charts + version: 1.3.2 +sources: + - https://github.com/gabe565/charts/tree/main/charts/memos + - https://usememos.com + - https://github.com/usememos/memos +annotations: + artifacthub.io/changes: |- + - kind: added + description: Initial release diff --git a/charts/memos/README.md b/charts/memos/README.md new file mode 100644 index 000000000..e63ab3929 --- /dev/null +++ b/charts/memos/README.md @@ -0,0 +1,97 @@ +# memos + +memos logo + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat) +![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat) +![AppVersion: 0.11.2](https://img.shields.io/badge/AppVersion-0.11.2-informational?style=flat) + +A lightweight, self-hosted memo hub. Open Source and Free forever. + +**Homepage:** + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/gabe565/charts/issues/new)** + +## Source Code + +* +* +* + +## Requirements + +Kubernetes: `>=1.22.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| | common | 1.3.2 | + +## TL;DR + +```console +helm repo add gabe565 https://charts.gabe565.com +helm repo update +helm install memos gabe565/memos +``` + +## Installing the Chart + +To install the chart with the release name `memos` + +```console +helm install memos gabe565/memos +``` + +## Uninstalling the Chart + +To uninstall the `memos` deployment + +```console +helm uninstall memos +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## 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/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) from the [bjw-s common library](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install memos \ + --set env.TZ="America/New York" \ + gabe565/memos +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install memos gabe565/memos -f values.yaml +``` + +## Custom configuration + +N/A + +## Values + +**Important**: When deploying an application Helm chart you can add more values from the bjw-s common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"neosmemo/memos"` | image repository | +| image.tag | string | `"0.11.2"` | image tag | +| ingress.main | object | See [values.yaml](./values.yaml) | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See [values.yaml](./values.yaml) | Configure persistence settings for the chart under this key. | +| podSecurityContext.fsGroup | int | `65534` | Volume binds will be granted to `nobody` group | +| podSecurityContext.runAsGroup | int | `65534` | Run as `nobody` group | +| podSecurityContext.runAsUser | int | `65534` | Run as `nobody` user | +| service | object | See [values.yaml](./values.yaml) | Configures service settings for the chart. | + +--- +Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs) diff --git a/charts/memos/README_CONFIG.md.gotmpl b/charts/memos/README_CONFIG.md.gotmpl new file mode 100644 index 000000000..e93d80bfa --- /dev/null +++ b/charts/memos/README_CONFIG.md.gotmpl @@ -0,0 +1,9 @@ +{{- define "custom.custom.configuration.header" -}} +## Custom configuration +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +N/A +{{- end -}} diff --git a/charts/memos/templates/NOTES.txt b/charts/memos/templates/NOTES.txt new file mode 100644 index 000000000..44ecfaa6c --- /dev/null +++ b/charts/memos/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "bjw-s.common.lib.chart.notes" . -}} diff --git a/charts/memos/templates/common.yaml b/charts/memos/templates/common.yaml new file mode 100644 index 000000000..6eb9b68ff --- /dev/null +++ b/charts/memos/templates/common.yaml @@ -0,0 +1 @@ +{{ include "bjw-s.common.loader.all" . }} diff --git a/charts/memos/values.yaml b/charts/memos/values.yaml new file mode 100644 index 000000000..736cfdd22 --- /dev/null +++ b/charts/memos/values.yaml @@ -0,0 +1,56 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/bjw-s/helm-charts/blob/main/charts/library/common/values.yaml +# + +image: + # -- image repository + repository: neosmemo/memos + # -- image pull policy + pullPolicy: IfNotPresent + # -- image tag + tag: 0.11.2 + +# -- Configures service settings for the chart. +# @default -- See [values.yaml](./values.yaml) +service: + main: + ports: + http: + port: 5230 + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See [values.yaml](./values.yaml) + main: + enabled: false + # hosts: + # - host: chart-example.local + # paths: + # - path: / + # tls: + # - secretName: chart-example.local + # hosts: + # - chart-example.local + # @ignored + +# -- Configure persistence settings for the chart under this key. +# @default -- See [values.yaml](./values.yaml) +persistence: + data: + enabled: false + mountPath: /var/opt/memos + retain: true + # storageClass: "" + # accessMode: ReadWriteOnce + # size: 1Gi + +podSecurityContext: + # -- Run as `nobody` user + runAsUser: 65534 + # -- Run as `nobody` group + runAsGroup: 65534 + # -- Volume binds will be granted to `nobody` group + fsGroup: 65534