fix(simply-shorten): move to stable. (#3774)

* fix(simply-shorten): move to stable.

* Rename README..md to README.md

* tweaks

* lint

Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
This commit is contained in:
Xstar97
2022-09-14 10:43:30 +03:00
committed by GitHub
co-authored by Stavros Kois
parent f6df8f4e98
commit 69d0c0f530
9 changed files with 57 additions and 21 deletions
+30
View File
@@ -0,0 +1,30 @@
# 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
# docs folder
/docs
# icon
icon.png
+230
View File
@@ -0,0 +1,230 @@
# Changelog
## [simply-shorten-0.0.23](https://github.com/truecharts/charts/compare/simply-shorten-0.0.22...simply-shorten-0.0.23) (2022-09-12)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- add missing descriptions and clean up descriptions for various charts ([#3704](https://github.com/truecharts/charts/issues/3704))
- update helm general non-major ([#3711](https://github.com/truecharts/charts/issues/3711))
## [simply-shorten-0.0.23](https://github.com/truecharts/charts/compare/simply-shorten-0.0.22...simply-shorten-0.0.23) (2022-09-12)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- add missing descriptions and clean up descriptions for various charts ([#3704](https://github.com/truecharts/charts/issues/3704))
- update helm general non-major ([#3711](https://github.com/truecharts/charts/issues/3711))
## [simply-shorten-0.0.23](https://github.com/truecharts/charts/compare/simply-shorten-0.0.22...simply-shorten-0.0.23) (2022-09-11)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- add missing descriptions and clean up descriptions for various charts ([#3704](https://github.com/truecharts/charts/issues/3704))
- update helm general non-major ([#3711](https://github.com/truecharts/charts/issues/3711))
## [simply-shorten-0.0.23](https://github.com/truecharts/charts/compare/simply-shorten-0.0.22...simply-shorten-0.0.23) (2022-09-11)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- add missing descriptions and clean up descriptions for various charts ([#3704](https://github.com/truecharts/charts/issues/3704))
- update helm general non-major ([#3711](https://github.com/truecharts/charts/issues/3711))
## [simply-shorten-0.0.23](https://github.com/truecharts/charts/compare/simply-shorten-0.0.22...simply-shorten-0.0.23) (2022-09-11)
### Chore
- Auto-update chart README [skip ci]
- add missing descriptions and clean up descriptions for various charts ([#3704](https://github.com/truecharts/charts/issues/3704))
- update helm general non-major ([#3711](https://github.com/truecharts/charts/issues/3711))
## [simply-shorten-0.0.23](https://github.com/truecharts/charts/compare/simply-shorten-0.0.22...simply-shorten-0.0.23) (2022-09-11)
### Chore
- add missing descriptions and clean up descriptions for various charts ([#3704](https://github.com/truecharts/charts/issues/3704))
- update helm general non-major ([#3711](https://github.com/truecharts/charts/issues/3711))
## [simply-shorten-0.0.22](https://github.com/truecharts/charts/compare/simply-shorten-0.0.20...simply-shorten-0.0.22) (2022-08-30)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major ([#3639](https://github.com/truecharts/charts/issues/3639))
- update helm chart common to v10.5.5 ([#3626](https://github.com/truecharts/charts/issues/3626))
## [simply-shorten-0.0.21](https://github.com/truecharts/charts/compare/simply-shorten-0.0.20...simply-shorten-0.0.21) (2022-08-30)
### Chore
- update helm chart common to v10.5.5 ([#3626](https://github.com/truecharts/charts/issues/3626))
## [simply-shorten-0.0.20](https://github.com/truecharts/charts/compare/simply-shorten-0.0.19...simply-shorten-0.0.20) (2022-08-29)
### Chore
- update helm general non-major ([#3619](https://github.com/truecharts/charts/issues/3619))
## [simply-shorten-0.0.19](https://github.com/truecharts/charts/compare/simply-shorten-0.0.17...simply-shorten-0.0.19) (2022-08-26)
### Fix
- some cleanup ([#3586](https://github.com/truecharts/charts/issues/3586))
## [simply-shorten-0.0.17](https://github.com/truecharts/charts/compare/simply-shorten-0.0.16...simply-shorten-0.0.17) (2022-08-23)
### Chore
- update helm general non-major helm releases ([#3545](https://github.com/truecharts/charts/issues/3545))
## [simply-shorten-0.0.16](https://github.com/truecharts/charts/compare/simply-shorten-0.0.15...simply-shorten-0.0.16) (2022-08-12)
### Chore
- add documentation checkbox/section to all SCALE Apps
- update helm general non-major helm releases ([#3456](https://github.com/truecharts/charts/issues/3456))
### Fix
- move extraArgs from .Values.controller to .Values ([#3447](https://github.com/truecharts/charts/issues/3447))
## [simply-shorten-0.0.15](https://github.com/truecharts/charts/compare/simply-shorten-0.0.14...simply-shorten-0.0.15) (2022-08-08)
### Chore
- update helm general non-major helm releases ([#3376](https://github.com/truecharts/charts/issues/3376))
- replace questions parts with templates ([#3402](https://github.com/truecharts/charts/issues/3402))
## [simply-shorten-0.0.14](https://github.com/truecharts/apps/compare/simply-shorten-0.0.13...simply-shorten-0.0.14) (2022-07-26)
### Chore
- update home links ([#3291](https://github.com/truecharts/apps/issues/3291))
- update helm general non-major helm releases ([#3302](https://github.com/truecharts/apps/issues/3302))
## [simply-shorten-0.0.13](https://github.com/truecharts/apps/compare/simply-shorten-0.0.12...simply-shorten-0.0.13) (2022-07-25)
### Chore
- update docker general non-major ([#3300](https://github.com/truecharts/apps/issues/3300))
### Chore
- add fake digest to new incubator Apps to fetch digests
## [simply-shorten-0.0.12](https://github.com/truecharts/apps/compare/simply-shorten-0.0.11...simply-shorten-0.0.12) (2022-07-23)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- update helm general non-major helm releases ([#3280](https://github.com/truecharts/apps/issues/3280))
## [simply-shorten-0.0.12](https://github.com/truecharts/apps/compare/simply-shorten-0.0.11...simply-shorten-0.0.12) (2022-07-23)
### Chore
- Auto-update chart README [skip ci]
- update helm general non-major helm releases ([#3280](https://github.com/truecharts/apps/issues/3280))
## [simply-shorten-0.0.12](https://github.com/truecharts/apps/compare/simply-shorten-0.0.11...simply-shorten-0.0.12) (2022-07-23)
### Chore
- update helm general non-major helm releases ([#3280](https://github.com/truecharts/apps/issues/3280))
## [simply-shorten-0.0.11]simply-shorten-0.0.11 (2022-07-22)
### Chore
- Auto-update chart README [skip ci]
- Auto-update chart README [skip ci]
- Bump all charts to generate config and container references due to huge increase of repository
- Move Dev to incubator and some cleanup
## [simply-shorten-0.0.10]simply-shorten-0.0.10 (2022-07-22)
### Chore
- Auto-update chart README [skip ci]
- Move Dev to incubator and some cleanup
## [simply-shorten-0.0.10]simply-shorten-0.0.10 (2022-07-22)
### Chore
- Move Dev to incubator and some cleanup
+33
View File
@@ -0,0 +1,33 @@
apiVersion: v2
appVersion: "latest"
dependencies:
- name: common
repository: https://library-charts.truecharts.org
version: 10.5.9
description: A dead simple URL shortener.
home: https://truecharts.org/docs/charts/stable/simply-shorten
icon: https://truecharts.org/img/hotlink-ok/chart-icons/simply-shorten.png
keywords:
- simply-shorten
- Cloud
- Productivity
- Network-Web
kubeVersion: ">=1.16.0-0"
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: simply-shorten
sources:
- https://github.com/truecharts/charts/tree/master/charts/incubator/simply-shorten
- https://gitlab.com/draganczukp/simply-shorten
- https://hub.docker.com/r/draganczukp/simply-shorten
type: application
version: 1.0.0
annotations:
truecharts.org/catagories: |
- Cloud
- Productivity
- Network-Web
truecharts.org/SCALE-support: "true"
truecharts.org/grade: U
+109
View File
@@ -0,0 +1,109 @@
# simply-shorten
![Version: 0.0.23](https://img.shields.io/badge/Version-0.0.23-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
A simple selfhosted URL shortener with no unnecessary features.
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
For more information, please click here: [simply-shorten](https://truecharts.org/docs/charts/incubator/simply-shorten)
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
## Source Code
* <https://github.com/truecharts/charts/tree/master/charts/incubator/simply-shorten>
* <https://gitlab.com/draganczukp/simply-shorten>
* <https://hub.docker.com/r/draganczukp/simply-shorten>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.truecharts.org | common | 10.5.9 |
## Installing the Chart
### TrueNAS SCALE
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Installing-an-App).
### Helm
To install the chart with the release name `simply-shorten`
```console
helm repo add TrueCharts https://charts.truecharts.org
helm repo update
helm install simply-shorten TrueCharts/simply-shorten
```
## Uninstall
### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart**
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Upgrade-rollback-delete-an-App).
### Helm
To uninstall the `simply-shorten` deployment
```console
helm uninstall simply-shorten
```
## Configuration
### Helm
#### Available Settings
Read through the values.yaml file. It has several commented out suggested values.
Other values may be used from the [values.yaml](https://github.com/truecharts/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).
#### Configure using the command line
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console
helm install simply-shorten \
--set env.TZ="America/New York" \
TrueCharts/simply-shorten
```
#### Configure using a yaml file
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install simply-shorten TrueCharts/simply-shorten -f values.yaml
```
#### Connecting to other charts
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/linking-apps) quick-start guide.
## Support
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ).
- See the [Website](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
Please consider making a [donation](https://truecharts.org/docs/about/sponsor) or contributing back to the project any way you can!
---
All Rights Reserved - The TrueCharts Project
@@ -0,0 +1,14 @@
# Installation Notes
- Set `username` to a username that is hard to guess.
- Set `password` to a password that is hard to guess.
- Enable ingress, without doing so `http://IP:PORT` will be used as the short url generator which obviously will be an issue.
- Please follow this [guide](https://truecharts.org/docs/manual/SCALE%20Apps/add-ingress) on adding ingress to a chart.
## Disable authentication
- Due to **NOT** being a recommended option you will have to manually add this env yourself.
- Add an additional env variable `INSECURE_DISABLE_PASSWORD` with the value of `I_KNOW_ITS_BAD` in **Configure Extra Environment Variables**. Any other value will **NOT** work.
Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

+136
View File
@@ -0,0 +1,136 @@
# Include{groups}
portals:
open:
# Include{portalLink}
questions:
# Include{global}
# Include{controller}
# Include{controllerDeployment}
# Include{replicas}
# Include{replica1}
# Include{strategy}
# Include{recreate}
# Include{controllerExpert}
# Include{controllerExpertExtraArgs}
- variable: secretEnv
group: "Container Configuration"
label: "Image Secrets"
schema:
additional_attrs: true
type: dict
attrs:
- variable: username
label: "username"
schema:
type: string
default: ""
- variable: password
label: "password"
schema:
type: string
private: true
default: ""
# Include{containerConfig}
# Include{serviceRoot}
- variable: main
label: "Main Service"
description: "The Primary service on which the healthcheck runs, often the webUI"
schema:
additional_attrs: true
type: dict
attrs:
# Include{serviceSelector}
- variable: main
label: "Main Service Port Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: port
label: "Port"
description: "This port exposes the container port on the service"
schema:
type: int
default: 4567
required: true
# Include{advancedPortHTTP}
- variable: targetPort
label: "Target Port"
description: "The internal(!) port on the container the Application runs on"
schema:
type: int
default: 4567
# Include{serviceExpertRoot}
default: false
# Include{serviceExpert}
# Include{serviceList}
# Include{persistenceRoot}
- variable: config
label: "App Config Storage"
description: "Stores the Application Configuration."
schema:
additional_attrs: true
type: dict
attrs:
# Include{persistenceBasic}
# Include{persistenceAdvanced}
# Include{persistenceList}
# Include{ingressRoot}
- variable: main
label: "Main Ingress"
schema:
additional_attrs: true
type: dict
attrs:
# Include{ingressDefault}
# Include{ingressTLS}
# Include{ingressTraefik}
# Include{ingressExpert}
# Include{ingressList}
# Include{security}
# Include{securityContextAdvancedRoot}
- variable: privileged
label: "Privileged mode"
schema:
type: boolean
default: false
- variable: readOnlyRootFilesystem
label: "ReadOnly Root Filesystem"
schema:
type: boolean
default: false
- variable: allowPrivilegeEscalation
label: "Allow Privilege Escalation"
schema:
type: boolean
default: false
- variable: runAsNonRoot
label: "runAsNonRoot"
schema:
type: boolean
default: false
# Include{securityContextAdvanced}
# Include{podSecurityContextRoot}
- variable: runAsUser
label: "runAsUser"
description: "The UserID of the user running the application"
schema:
type: int
default: 0
- variable: runAsGroup
label: "runAsGroup"
description: The groupID this App of the user running the application"
schema:
type: int
default: 0
- variable: fsGroup
label: "fsGroup"
description: "The group that should own ALL storage."
schema:
type: int
default: 568
# Include{podSecurityContextAdvanced}
# Include{resources}
# Include{advanced}
# Include{addons}
# Include{documentation}
@@ -0,0 +1,2 @@
{{/* Render the templates */}}
{{ include "tc.common.loader.all" . }}
+35
View File
@@ -0,0 +1,35 @@
image:
pullPolicy: IfNotPresent
repository: tccr.io/truecharts/simply-shorten
tag: v1.1@sha256:40e1ae029e52ef3429ec022e2eeac27639fb102fdaea6802f28cd0d628dc74df
podSecurityContext:
runAsGroup: 0
runAsUser: 0
securityContext:
readOnlyRootFilesystem: false
runAsNonRoot: false
secretEnv:
password: user
username: pass
env:
db_url: "/config/db/urls.sqlite"
service:
main:
ports:
main:
port: 4567
protocol: HTTP
targetPort: 4567
persistence:
config:
enabled: true
mountPath: "/config/db"
portal:
enabled: true