fix(cloudflared): move to stable updated docs (#3237)
* fix(cloudflared): move to stable updated docs * Apply suggestions from code review * revert commons version back to 10.4.4 * update cloudflared * restore files * Update charts/stable/cloudflared/docs/installation_notes.md * Update charts/stable/cloudflared/Chart.yaml Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
This commit is contained in:
Xstar97
co-authored by
Stavros Kois
Kjeld Schouten-Lebbing
Stavros Kois
Kjeld Schouten-Lebbing
parent
71a6945816
commit
d6423f428e
@@ -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
|
||||
@@ -0,0 +1,134 @@
|
||||
# Changelog
|
||||
|
||||
|
||||
## [cloudflared-0.0.17](https://github.com/truecharts/apps/compare/cloudflareddns-1.0.2...cloudflared-0.0.17) (2022-07-19)
|
||||
|
||||
### Chore
|
||||
|
||||
- Update Readme and Description on SCALE
|
||||
|
||||
|
||||
|
||||
## [cloudflared-0.0.16](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.15...cloudflared-0.0.16) (2022-07-17)
|
||||
|
||||
### Chore
|
||||
|
||||
- extend linter and apply lint ([#3200](https://github.com/truecharts/apps/issues/3200))
|
||||
|
||||
### Feat
|
||||
|
||||
- Add installation_notes for cloudflared ([#3196](https://github.com/truecharts/apps/issues/3196))
|
||||
|
||||
|
||||
|
||||
## [cloudflared-0.0.15](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.14...cloudflared-0.0.15) (2022-07-14)
|
||||
|
||||
### Fix
|
||||
|
||||
- regenerate catalog and update template
|
||||
|
||||
|
||||
|
||||
## [cloudflared-0.0.14](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.12...cloudflared-0.0.14) (2022-07-14)
|
||||
|
||||
### Fix
|
||||
|
||||
- bump to ensure .helmignore is present on all Charts
|
||||
|
||||
|
||||
|
||||
## [cloudflared-0.0.12](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.10...cloudflared-0.0.12) (2022-07-12)
|
||||
|
||||
### Chore
|
||||
|
||||
- update icons ([#3156](https://github.com/truecharts/apps/issues/3156))
|
||||
- bump to cleanup old docs and use correct icon urls
|
||||
|
||||
|
||||
|
||||
## [cloudflared-0.0.10](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.9...cloudflared-0.0.10) (2022-07-12)
|
||||
|
||||
### Chore
|
||||
|
||||
- bump to regenerate documentation
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.9"></a>
|
||||
### [cloudflared-0.0.9](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.8...cloudflared-0.0.9) (2022-07-12)
|
||||
|
||||
#### Chore
|
||||
|
||||
* update helm general non-major helm releases ([#3147](https://github.com/truecharts/apps/issues/3147))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.8"></a>
|
||||
### [cloudflared-0.0.8](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.7...cloudflared-0.0.8) (2022-07-11)
|
||||
|
||||
#### Chore
|
||||
|
||||
* move icons into the apps folder ([#3139](https://github.com/truecharts/apps/issues/3139))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.7"></a>
|
||||
### [cloudflared-0.0.7](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.6...cloudflared-0.0.7) (2022-07-11)
|
||||
|
||||
#### Chore
|
||||
|
||||
* update image refs ([#3135](https://github.com/truecharts/apps/issues/3135))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.6"></a>
|
||||
### [cloudflared-0.0.6](https://github.com/truecharts/apps/compare/cloudflared-0.0.5...cloudflared-0.0.6) (2022-07-09)
|
||||
|
||||
#### Chore
|
||||
|
||||
* update helm general non-major helm releases ([#3113](https://github.com/truecharts/apps/issues/3113))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.5"></a>
|
||||
### [cloudflared-0.0.5](https://github.com/truecharts/apps/compare/cloudflared-0.0.4...cloudflared-0.0.5) (2022-07-09)
|
||||
|
||||
#### Chore
|
||||
|
||||
* combine some ports ([#3096](https://github.com/truecharts/apps/issues/3096))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.4"></a>
|
||||
### [cloudflared-0.0.4](https://github.com/truecharts/apps/compare/cloudflared-0.0.3...cloudflared-0.0.4) (2022-07-07)
|
||||
|
||||
#### Chore
|
||||
|
||||
* update docker general non-major ([#3089](https://github.com/truecharts/apps/issues/3089))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.3"></a>
|
||||
### [cloudflared-0.0.3](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.4...cloudflared-0.0.3) (2022-07-06)
|
||||
|
||||
#### Chore
|
||||
|
||||
* update docker general non-major ([#3078](https://github.com/truecharts/apps/issues/3078))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.2"></a>
|
||||
### [cloudflared-0.0.2](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.3...cloudflared-0.0.2) (2022-07-04)
|
||||
|
||||
#### Chore
|
||||
|
||||
* update helm general non-major helm releases ([#3066](https://github.com/truecharts/apps/issues/3066))
|
||||
|
||||
|
||||
|
||||
<a name="cloudflared-0.0.1"></a>
|
||||
### [cloudflared-0.0.1](https://github.com/truecharts/apps/compare/cloudflareddns-0.0.1...cloudflared-0.0.1) (2022-07-02)
|
||||
|
||||
#### Feat
|
||||
|
||||
* add cloudflared ([#3029](https://github.com/truecharts/apps/issues/3029))
|
||||
@@ -0,0 +1,29 @@
|
||||
apiVersion: v2
|
||||
kubeVersion: ">=1.16.0-0"
|
||||
name: cloudflared
|
||||
version: 1.0.0
|
||||
appVersion: "2022.7.1"
|
||||
description: Client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge.
|
||||
type: application
|
||||
deprecated: false
|
||||
home: https://github.com/truecharts/apps/tree/master/charts/stable/cloudflared
|
||||
icon: https://truecharts.org/img/chart-icons/cloudflared.png
|
||||
keywords:
|
||||
- cloudflared
|
||||
- networking
|
||||
sources:
|
||||
- https://hub.docker.com/r/cloudflare/cloudflared
|
||||
dependencies:
|
||||
- name: common
|
||||
repository: https://library-charts.truecharts.org
|
||||
version: 10.4.4
|
||||
# condition:
|
||||
maintainers:
|
||||
- email: info@truecharts.org
|
||||
name: TrueCharts
|
||||
url: https://truecharts.org
|
||||
annotations:
|
||||
truecharts.org/catagories: |
|
||||
- network
|
||||
truecharts.org/SCALE-support: "true"
|
||||
truecharts.org/grade: U
|
||||
@@ -0,0 +1,107 @@
|
||||
# cloudflared
|
||||
|
||||
  
|
||||
|
||||
Client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge.
|
||||
|
||||
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: [cloudflared](https://truecharts.org/charts/stable/cloudflared)
|
||||
|
||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
|
||||
|
||||
## Source Code
|
||||
|
||||
* <https://hub.docker.com/r/cloudflare/cloudflared>
|
||||
|
||||
## Requirements
|
||||
|
||||
Kubernetes: `>=1.16.0-0`
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Repository | Name | Version |
|
||||
|------------|------|---------|
|
||||
| https://library-charts.truecharts.org | common | 10.4.4 |
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
### TrueNAS SCALE
|
||||
|
||||
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
|
||||
|
||||
### Helm
|
||||
|
||||
To install the chart with the release name `cloudflared`
|
||||
|
||||
```console
|
||||
helm repo add TrueCharts https://helm.truecharts.org
|
||||
helm repo update
|
||||
helm install cloudflared TrueCharts/cloudflared
|
||||
```
|
||||
|
||||
## Uninstall
|
||||
|
||||
### TrueNAS SCALE
|
||||
|
||||
**Upgrading, Rolling Back and Uninstalling the Chart**
|
||||
|
||||
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
|
||||
|
||||
### Helm
|
||||
|
||||
To uninstall the `cloudflared` deployment
|
||||
|
||||
```console
|
||||
helm uninstall cloudflared
|
||||
```
|
||||
|
||||
## 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 Commandline
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||
|
||||
```console
|
||||
helm install cloudflared \
|
||||
--set env.TZ="America/New York" \
|
||||
TrueCharts/cloudflared
|
||||
```
|
||||
|
||||
#### 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 cloudflared TrueCharts/cloudflared -f values.yaml
|
||||
```
|
||||
|
||||
#### Connecting to other apps
|
||||
|
||||
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/manual/Quick-Start%20Guides/06-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,3 @@
|
||||
# With the bellow we test both container starts and that tpl is working inside extraArgs list
|
||||
extraArgs: ["tunnel", "--no-autoupdate", "{{ .Values.testTpl }}"]
|
||||
testTpl: "--hello-world"
|
||||
@@ -0,0 +1,14 @@
|
||||
# Installation Notes
|
||||
|
||||
- Go to [cloudflare team dash](https://dash.teams.cloudflare.com)
|
||||
and create a tunnel or migrate a current tunnel(this action is not reversible)
|
||||
|
||||
- Copy the token from tunnel's overview **Install and run a connector** section.
|
||||
|
||||
This is what your token may look like.
|
||||
|
||||
```text
|
||||
eyJhIjoiNDJhYmYwMTQzNGMyMeUzNDMzMTE1Y2M0YmFhZGY0YTciLCJ0IjoiNzBiNza5zTItMWViMS00MjdjaWFiZjEtZWMwdzIwNmQwZmI3IiwicyI6IlltRmxPV1ExTldZdE16a3lOUzAwsW1KbUxUZzJPVGN0Wm1VelptVmpaak00T1dZeiJ5
|
||||
- Set `token` with **your** tunnel's token. the tunnel ID will NOT work.
|
||||
- Now you can manage the tunnel via cloudflare dash by setting a private network or create ingress rules for your services and domain, you can use this as a reverse proxy directly or use it in conjunction with traefik if you are behind a CGNAT, do not have a static IP, nor can not portforward 443(SSL).
|
||||
- Please note you MAY need to modify cloudflared Zero Trust various settings in order for this work out-of-the-box which is beyond the scope of this guide.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
@@ -0,0 +1,233 @@
|
||||
# Include{groups}
|
||||
portals: {}
|
||||
questions:
|
||||
# Include{global}
|
||||
- variable: controller
|
||||
group: "Controller"
|
||||
label: ""
|
||||
schema:
|
||||
additional_attrs: true
|
||||
type: dict
|
||||
attrs:
|
||||
- variable: advanced
|
||||
label: "Show Advanced Controller Settings"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
show_subquestions_if: true
|
||||
subquestions:
|
||||
- variable: type
|
||||
description: "Please specify type of workload to deploy"
|
||||
label: "(Advanced) Controller Type"
|
||||
schema:
|
||||
type: string
|
||||
default: "deployment"
|
||||
required: true
|
||||
enum:
|
||||
- value: "deployment"
|
||||
description: "Deployment"
|
||||
- value: "statefulset"
|
||||
description: "Statefulset"
|
||||
- value: "daemonset"
|
||||
description: "Daemonset"
|
||||
- variable: replicas
|
||||
description: "Number of desired pod replicas"
|
||||
label: "Desired Replicas"
|
||||
schema:
|
||||
type: int
|
||||
default: 1
|
||||
required: true
|
||||
- variable: strategy
|
||||
description: "Please specify type of workload to deploy"
|
||||
label: "(Advanced) Update Strategy"
|
||||
schema:
|
||||
type: string
|
||||
default: "Recreate"
|
||||
required: true
|
||||
enum:
|
||||
- value: "Recreate"
|
||||
description: "Recreate: Kill existing pods before creating new ones"
|
||||
- value: "RollingUpdate"
|
||||
description: "RollingUpdate: Create new pods and then kill old ones"
|
||||
- value: "OnDelete"
|
||||
description: "(Legacy) OnDelete: ignore .spec.template changes"
|
||||
# Include{controllerExpert}
|
||||
- variable: env
|
||||
group: "Container Configuration"
|
||||
label: "Image Environment"
|
||||
schema:
|
||||
additional_attrs: true
|
||||
type: dict
|
||||
attrs:
|
||||
- variable: token
|
||||
label: "Tunnel Token"
|
||||
description: "Token for tunnel (Tunnel managed by Cloudflare not locally)"
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
default: ""
|
||||
# Include{containerConfig}
|
||||
|
||||
- variable: service
|
||||
group: "Networking and Services"
|
||||
label: "Configure Service(s)"
|
||||
schema:
|
||||
additional_attrs: true
|
||||
type: dict
|
||||
attrs:
|
||||
- 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: 6969
|
||||
required: true
|
||||
- variable: advanced
|
||||
label: "Show Advanced settings"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
show_subquestions_if: true
|
||||
subquestions:
|
||||
- variable: protocol
|
||||
label: "Port Type"
|
||||
schema:
|
||||
type: string
|
||||
default: "HTTP"
|
||||
enum:
|
||||
- value: HTTP
|
||||
description: "HTTP"
|
||||
- value: "HTTPS"
|
||||
description: "HTTPS"
|
||||
- value: TCP
|
||||
description: "TCP"
|
||||
- value: "UDP"
|
||||
description: "UDP"
|
||||
- variable: nodePort
|
||||
label: "Node Port (Optional)"
|
||||
description: "This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer"
|
||||
schema:
|
||||
type: int
|
||||
min: 9000
|
||||
max: 65535
|
||||
- variable: targetPort
|
||||
label: "Target Port"
|
||||
description: "The internal(!) port on the container the Application runs on"
|
||||
schema:
|
||||
type: int
|
||||
default: 6969
|
||||
|
||||
- variable: serviceexpert
|
||||
group: "Networking and Services"
|
||||
label: "Show Expert Config"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
show_subquestions_if: true
|
||||
subquestions:
|
||||
- variable: hostNetwork
|
||||
group: "Networking and Services"
|
||||
label: "Host-Networking (Complicated)"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
# Include{serviceExpert}
|
||||
# Include{serviceList}
|
||||
- variable: persistence
|
||||
label: "Integrated Persistent Storage"
|
||||
description: "Integrated Persistent Storage"
|
||||
group: "Storage and Persistence"
|
||||
schema:
|
||||
additional_attrs: true
|
||||
type: dict
|
||||
attrs:
|
||||
- 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{ingressList}
|
||||
# Include{security}
|
||||
- variable: advancedSecurity
|
||||
label: "Show Advanced Security Settings"
|
||||
group: "Security and Permissions"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
show_subquestions_if: true
|
||||
subquestions:
|
||||
- variable: securityContext
|
||||
label: "Security Context"
|
||||
schema:
|
||||
additional_attrs: true
|
||||
type: dict
|
||||
attrs:
|
||||
- variable: privileged
|
||||
label: "Privileged mode"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
- variable: readOnlyRootFilesystem
|
||||
label: "ReadOnly Root Filesystem"
|
||||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
- variable: allowPrivilegeEscalation
|
||||
label: "Allow Privilege Escalation"
|
||||
schema:
|
||||
type: boolean
|
||||
default: false
|
||||
- variable: runAsNonRoot
|
||||
label: "runAsNonRoot"
|
||||
schema:
|
||||
type: boolean
|
||||
default: true
|
||||
# Include{securityContextAdvanced}
|
||||
- variable: podSecurityContext
|
||||
group: "Security and Permissions"
|
||||
label: "Pod Security Context"
|
||||
schema:
|
||||
additional_attrs: true
|
||||
type: dict
|
||||
attrs:
|
||||
- variable: runAsUser
|
||||
label: "runAsUser"
|
||||
description: "The UserID of the user running the application"
|
||||
schema:
|
||||
type: int
|
||||
default: 568
|
||||
- variable: runAsGroup
|
||||
label: "runAsGroup"
|
||||
description: "The groupID this App of the user running the application"
|
||||
schema:
|
||||
type: int
|
||||
default: 568
|
||||
- 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}
|
||||
@@ -0,0 +1 @@
|
||||
{{ include "tc.common.loader.all" . }}
|
||||
@@ -0,0 +1,32 @@
|
||||
image:
|
||||
repository: tccr.io/truecharts/cloudflared
|
||||
pullPolicy: IfNotPresent
|
||||
tag: v2022.7.1@sha256:eb30a8a7a410e7b6be3fa07112a8295360c153518438cd5a94c8d42f5ccbe233
|
||||
|
||||
extraArgs: ["tunnel", "--no-autoupdate", "run", "--token", "{{ .Values.env.token }}"]
|
||||
|
||||
env:
|
||||
token: ""
|
||||
|
||||
securityContext:
|
||||
runAsNonRoot: false
|
||||
|
||||
podSecurityContext:
|
||||
runAsUser: 0
|
||||
runAsGroup: 0
|
||||
|
||||
service:
|
||||
main:
|
||||
ports:
|
||||
main:
|
||||
protocol: HTTP
|
||||
targetPort: 6969
|
||||
port: 6969
|
||||
|
||||
probes:
|
||||
liveness:
|
||||
enabled: false
|
||||
readiness:
|
||||
enabled: false
|
||||
startup:
|
||||
enabled: false
|
||||
Reference in New Issue
Block a user