feat(apt-cacher-ng): move to stable and add docs (#3707)

* feat(apt-cacher-ng): move to stable and add docs

* chore(orbital-sync): update image ref
This commit is contained in:
Stavros Kois
2022-09-06 00:52:24 +03:00
committed by GitHub
parent f5e7d2824e
commit d833fa650a
12 changed files with 52 additions and 39 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
+194
View File
@@ -0,0 +1,194 @@
# Changelog
## [apt-cacher-ng-0.0.22](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.21...apt-cacher-ng-0.0.22) (2022-08-30)
### Chore
- update helm general non-major ([#3639](https://github.com/truecharts/charts/issues/3639))
## [apt-cacher-ng-0.0.21](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.20...apt-cacher-ng-0.0.21) (2022-08-30)
### Chore
- update helm chart common to v10.5.5 ([#3626](https://github.com/truecharts/charts/issues/3626))
## [apt-cacher-ng-0.0.20](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.19...apt-cacher-ng-0.0.20) (2022-08-29)
### Chore
- update helm general non-major ([#3619](https://github.com/truecharts/charts/issues/3619))
## [apt-cacher-ng-0.0.19](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.17...apt-cacher-ng-0.0.19) (2022-08-26)
### Fix
- some cleanup ([#3586](https://github.com/truecharts/charts/issues/3586))
## [apt-cacher-ng-0.0.17](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.16...apt-cacher-ng-0.0.17) (2022-08-23)
### Chore
- update helm general non-major helm releases ([#3545](https://github.com/truecharts/charts/issues/3545))
## [apt-cacher-ng-0.0.16](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.15...apt-cacher-ng-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))
## [apt-cacher-ng-0.0.15](https://github.com/truecharts/charts/compare/apt-cacher-ng-0.0.14...apt-cacher-ng-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))
## [apt-cacher-ng-0.0.14](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.13...apt-cacher-ng-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))
## [apt-cacher-ng-0.0.13](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.12...apt-cacher-ng-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
## [apt-cacher-ng-0.0.12](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.11...apt-cacher-ng-0.0.12) (2022-07-23)
### 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]
- Bump all charts to generate config and container references due to huge increase of repository
- update helm general non-major helm releases ([#3280](https://github.com/truecharts/apps/issues/3280))
### Feat
- move dev apps to incubator and remove bad content from dev
## [apt-cacher-ng-0.0.12](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.11...apt-cacher-ng-0.0.12) (2022-07-23)
### Chore
- Auto-update chart README [skip ci]
- 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
- update helm general non-major helm releases ([#3280](https://github.com/truecharts/apps/issues/3280))
### Feat
- move dev apps to incubator and remove bad content from dev
## [apt-cacher-ng-0.0.12](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.11...apt-cacher-ng-0.0.12) (2022-07-23)
### 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
- update helm general non-major helm releases ([#3280](https://github.com/truecharts/apps/issues/3280))
### Feat
- move dev apps to incubator and remove bad content from dev
<a name="apt-cacher-ng-0.0.5"></a>
### [apt-cacher-ng-0.0.5](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.4...apt-cacher-ng-0.0.5) (2022-05-05)
#### Chore
* update helm general non-major helm releases ([#2612](https://github.com/truecharts/apps/issues/2612))
<a name="apt-cacher-ng-0.0.4"></a>
### [apt-cacher-ng-0.0.4](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.3...apt-cacher-ng-0.0.4) (2022-04-26)
#### Chore
* update helm general non-major helm releases ([#2573](https://github.com/truecharts/apps/issues/2573))
<a name="apt-cacher-ng-0.0.3"></a>
### [apt-cacher-ng-0.0.3](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.2...apt-cacher-ng-0.0.3) (2022-04-20)
#### Chore
* add missing quote on description ([#2515](https://github.com/truecharts/apps/issues/2515))
* update helm general non-major helm releases ([#2524](https://github.com/truecharts/apps/issues/2524))
<a name="apt-cacher-ng-0.0.2"></a>
### [apt-cacher-ng-0.0.2](https://github.com/truecharts/apps/compare/apt-cacher-ng-0.0.1...apt-cacher-ng-0.0.2) (2022-04-12)
#### Chore
* Auto-update chart README [skip ci]
* update helm general non-major helm releases ([#2480](https://github.com/truecharts/apps/issues/2480))
<a name="apt-cacher-ng-0.0.1"></a>
### apt-cacher-ng-0.0.1 (2022-04-08)
#### Feat
* Unraid Port - A ([#2438](https://github.com/truecharts/apps/issues/2438))
+33
View File
@@ -0,0 +1,33 @@
apiVersion: v2
appVersion: "latest"
dependencies:
- name: common
repository: https://library-charts.truecharts.org
version: 10.5.6
deprecated: false
description: Apt-Cacher NG is a caching proxy, specialized for package files from Linux distributors, primarily for Debian (and Debian based) distributions but not limited to those.
home: https://truecharts.org/docs/charts/incubator/apt-cacher-ng
icon: https://truecharts.org/img/hotlink-ok/chart-icons/apt-cacher-ng.png
keywords:
- apt-cacher-ng
- Network-Proxy
- Network-Other
- Tools-Utilities
kubeVersion: ">=1.16.0-0"
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: apt-cacher-ng
sources:
- https://github.com/truecharts/charts/tree/master/charts/incubator/apt-cacher-ng
- https://www.unix-ag.uni-kl.de/~bloch/acng/
- https://hub.docker.com/r/sameersbn/apt-cacher-ng/
type: application
version: 1.0.0
annotations:
truecharts.org/SCALE-support: "true"
truecharts.org/catagories: |
- Network-Proxy
- Network-Other
- Tools-Utilities
+109
View File
@@ -0,0 +1,109 @@
# apt-cacher-ng
![Version: 0.0.22](https://img.shields.io/badge/Version-0.0.22-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)
Apt-Cacher NG is a caching proxy, specialized for package files from Linux distributors, primarily for Debian (and Debian based) distributions but not limited to those.
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: [apt-cacher-ng](https://truecharts.org/docs/charts/incubator/apt-cacher-ng)
**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/apt-cacher-ng>
* <https://www.unix-ag.uni-kl.de/~bloch/acng/>
* <https://hub.docker.com/r/sameersbn/apt-cacher-ng/>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.truecharts.org | common | 10.5.6 |
## 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 `apt-cacher-ng`
```console
helm repo add TrueCharts https://charts.truecharts.org
helm repo update
helm install apt-cacher-ng TrueCharts/apt-cacher-ng
```
## 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 `apt-cacher-ng` deployment
```console
helm uninstall apt-cacher-ng
```
## Configuration
### Helm
#### Available Settings
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/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 apt-cacher-ng \
--set env.TZ="America/New York" \
TrueCharts/apt-cacher-ng
```
#### 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 apt-cacher-ng TrueCharts/apt-cacher-ng -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,11 @@
# How-To
To start using Apt-Cacher NG on your Debian (Based) host, create the
configuration file `/etc/apt/apt.conf.d/01proxy` with the following content:
```conf
Acquire::HTTP::Proxy "http://SERVER.IP:3142";
Acquire::HTTPS::Proxy "false";
```
> Don't forget to replace `SERVER.IP` with your actual server IP.
Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

+115
View File
@@ -0,0 +1,115 @@
# Include{groups}
portals: {}
questions:
# Include{global}
# Include{controller}
# Include{controllerDeployment}
# Include{replicas}
# Include{replica1}
# Include{strategy}
# Include{recreate}
# Include{controllerExpert}
# Include{controllerExpertExtraArgs}
# 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: 3142
required: true
# Include{advancedPortTCP}
- variable: targetPort
label: Target Port
description: The internal(!) port on the container the Application runs on
schema:
type: int
default: 3142
# Include{serviceExpertRoot}
default: false
# Include{serviceExpert}
# Include{serviceList}
# Include{persistenceRoot}
- variable: apt-cacher-ng
label: apt-cacher-ng Storage
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" . }}
+28
View File
@@ -0,0 +1,28 @@
image:
pullPolicy: IfNotPresent
repository: tccr.io/truecharts/apt-cacher-ng
tag: v3.7.4@sha256:230be67941a442e6a47f4928cf8d7882d645d1c21752155c42e104e10520ace4
podSecurityContext:
runAsGroup: 0
runAsUser: 0
securityContext:
readOnlyRootFilesystem: false
runAsNonRoot: false
service:
main:
ports:
main:
port: 3142
protocol: TCP
targetPort: 3142
persistence:
apt-cacher-ng:
enabled: true
mountPath: /var/cache/apt-cacher-ng
portal:
enabled: true