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
2022-07-21 12:52:50 +02:00
committed by GitHub
co-authored by Stavros Kois Kjeld Schouten-Lebbing
parent 71a6945816
commit d6423f428e
11 changed files with 153 additions and 155 deletions
@@ -1,16 +0,0 @@
# 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
- Now you can manage the tunnel via cloudflare dash by setting a private network or create ingress rules for your services and domain.
@@ -1,30 +1,30 @@
# Patterns to ignore when building packages. # Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and # This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line. # negation (prefixed with !). Only one pattern per line.
.DS_Store .DS_Store
# Common VCS dirs # Common VCS dirs
.git/ .git/
.gitignore .gitignore
.bzr/ .bzr/
.bzrignore .bzrignore
.hg/ .hg/
.hgignore .hgignore
.svn/ .svn/
# Common backup files # Common backup files
*.swp *.swp
*.bak *.bak
*.tmp *.tmp
*~ *~
# Various IDEs # Various IDEs
.project .project
.idea/ .idea/
*.tmproj *.tmproj
.vscode/ .vscode/
# OWNERS file for Kubernetes # OWNERS file for Kubernetes
OWNERS OWNERS
# helm-docs templates # helm-docs templates
*.gotmpl *.gotmpl
# docs folder # docs folder
/docs /docs
# icon # icon
icon.png icon.png
@@ -1,7 +1,7 @@
apiVersion: v2 apiVersion: v2
kubeVersion: ">=1.16.0-0" kubeVersion: ">=1.16.0-0"
name: cloudflared name: cloudflared
version: 0.0.17 version: 1.0.0
appVersion: "2022.7.1" appVersion: "2022.7.1"
description: Client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge. description: Client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge.
type: application type: application
@@ -24,6 +24,6 @@ maintainers:
url: https://truecharts.org url: https://truecharts.org
annotations: annotations:
truecharts.org/catagories: | truecharts.org/catagories: |
- incubator - network
truecharts.org/SCALE-support: "true" truecharts.org/SCALE-support: "true"
truecharts.org/grade: U truecharts.org/grade: U
@@ -1,107 +1,107 @@
# cloudflared # cloudflared
![Version: 0.0.17](https://img.shields.io/badge/Version-0.0.17-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2022.7.1](https://img.shields.io/badge/AppVersion-2022.7.1-informational?style=flat-square) ![Version: 0.0.17](https://img.shields.io/badge/Version-0.0.17-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2022.7.1](https://img.shields.io/badge/AppVersion-2022.7.1-informational?style=flat-square)
Client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge. 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. 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. 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) 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)** **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 ## Source Code
* <https://hub.docker.com/r/cloudflare/cloudflared> * <https://hub.docker.com/r/cloudflare/cloudflared>
## Requirements ## Requirements
Kubernetes: `>=1.16.0-0` Kubernetes: `>=1.16.0-0`
## Dependencies ## Dependencies
| Repository | Name | Version | | Repository | Name | Version |
|------------|------|---------| |------------|------|---------|
| https://library-charts.truecharts.org | common | 10.4.4 | | https://library-charts.truecharts.org | common | 10.4.4 |
## Installing the Chart ## Installing the Chart
### TrueNAS SCALE ### 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/). To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
### Helm ### Helm
To install the chart with the release name `cloudflared` To install the chart with the release name `cloudflared`
```console ```console
helm repo add TrueCharts https://helm.truecharts.org helm repo add TrueCharts https://helm.truecharts.org
helm repo update helm repo update
helm install cloudflared TrueCharts/cloudflared helm install cloudflared TrueCharts/cloudflared
``` ```
## Uninstall ## Uninstall
### TrueNAS SCALE ### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart** **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/). 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 ### Helm
To uninstall the `cloudflared` deployment To uninstall the `cloudflared` deployment
```console ```console
helm uninstall cloudflared helm uninstall cloudflared
``` ```
## Configuration ## Configuration
### Helm ### Helm
#### Available Settings #### Available Settings
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. 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). 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 #### Configure using the Commandline
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
```console ```console
helm install cloudflared \ helm install cloudflared \
--set env.TZ="America/New York" \ --set env.TZ="America/New York" \
TrueCharts/cloudflared TrueCharts/cloudflared
``` ```
#### Configure using a yaml file #### Configure using a yaml file
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console ```console
helm install cloudflared TrueCharts/cloudflared -f values.yaml helm install cloudflared TrueCharts/cloudflared -f values.yaml
``` ```
#### Connecting to other apps #### 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. 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 ## Support
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Important-MUST-READ). - 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) - See the [Website](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr) - Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose) - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
--- ---
## Sponsor TrueCharts ## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff. 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! 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 All Rights Reserved - The TrueCharts Project
@@ -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.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB