rename .tools to tools

2021-05-30 13:14:37 +02:00
parent 8b76a14c73
commit 7e63572201
17 changed files with 12 additions and 12 deletions
@@ -0,0 +1,26 @@
+# 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
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
+# OWNERS file for Kubernetes
+OWNERS
+# helm-docs templates
+*.gotmpl
@@ -0,0 +1,25 @@
+apiVersion: v2
+kubeVersion: ">=1.16.0-0"
+name: ${CHARTNAME}
+version: 1.0.0
+upstream_version: 1.1.0
+appVersion: 1.0.0
+description: ${CHARTNAME} App for TrueNAS SCALE
+type: application
+deprecated: false
+home: https://github.com/truecharts/apps/tree/master/charts/${CHARTNAME}
+icon: https://raw.githubusercontent.com/truecharts/apps/master/stable/${CHARTNAME}/icon.png?raw=true
+keywords:
+  - ${CHARTNAME}
+sources:
+  - https://github.com/truecharts/apps/tree/master/charts/${CHARTNAME}
+dependencies:
+  - name: common
+    repository: https://charts.truecharts.com/
+    version: 1.3.0
+    # condition:
+maintainers:
+  - name: TrueCharts
+    email: info@truecharts.org
+    url: truecharts.org
+# annotations:
@@ -0,0 +1,117 @@
+# ${CHARTNAME}
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
+
+${CHARTNAME} helm package
+
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
+
+## Source Code
+
+* <https://github.com/${CHARTNAME}/${CHARTNAME}-docker>
+* <https://github.com/k8s-at-home/charts/tree/master/charts/${CHARTNAME}>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://truecharts.org/ | common | 3.0.1 |
+
+## TL;DR
+
+```console
+helm repo add k8s-at-home https://k8s-at-home.com/charts/
+helm repo update
+helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
+```
+
+## Installing the Chart
+
+To install the chart with the release name `${CHARTNAME}`
+
+```console
+helm install ${CHARTNAME} k8s-at-home/${CHARTNAME}
+```
+
+## Uninstalling the Chart
+
+To uninstall the `${CHARTNAME}` deployment
+
+```console
+helm uninstall ${CHARTNAME}
+```
+
+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](../common/values.yaml) from the [common library](../common).
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install ${CHARTNAME} \
+  --set env.TZ="America/New York" \
+    k8s-at-home/${CHARTNAME}
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -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](https://github.com/k8s-at-home/charts/tree/master/charts/common/)
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| env | object | `{}` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` |  |
+| image.tag | string | `"1.0.0"` |  |
+| ingress.enabled | bool | `false` |  |
+| service.port.port | int | `1880` |  |
+| strategy.type | string | `"Recreate"` |  |
+
+## 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](https://github.com/k8s-at-home/charts/tree/master/charts/common/README.md#Changelog).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### [1.0.0]
+
+#### Added
+
+- N/A
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[1.0.0]: #1.0.0
+
+## Support
+
+- See the [Wiki](https://github.com/k8s-at-home/charts/wiki)
+- Open a [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/charts/discussions)
+- Join our [Discord](https://discord.gg/sTMX7Vh) community
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
@@ -0,0 +1,32 @@
+#
+# IMPORTANT NOTE
+#
+# This chart inherits from our common library chart. You can check the default values/options here:
+# https://github.com/k8s-at-home/charts/tree/master/charts/common/values.yaml
+#
+
+image:
+  repository: ${CHARTNAME}/${CHARTNAME}
+  pullPolicy: IfNotPresent
+  tag: 1.0.0
+
+strategy:
+  type: Recreate
+
+# See more environment variables in the ${CHARTNAME} documentation
+# https://${CHARTNAME}.org/docs
+env: {}
+  # TZ:
+
+service:
+  port:
+    port: 1880
+
+ingress:
+  enabled: false
+
+# persistence:
+#   data:
+#     enabled: false
+#     emptyDir: false
+#     mountPath: /data