From d6423f428e7f01c4b3a2c7b6e3db4c9971684a58 Mon Sep 17 00:00:00 2001 From: Xstar97 Date: Thu, 21 Jul 2022 06:52:50 -0400 Subject: [PATCH] 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 --- .../cloudflared/docs/installation_notes.md | 16 -- .../cloudflared/.helmignore | 60 ++--- .../cloudflared/CHANGELOG.md | 0 .../cloudflared/Chart.yaml | 4 +- .../cloudflared/README.md | 214 +++++++++--------- .../cloudflared/ci/test-values.yaml | 0 .../cloudflared/docs/installation_notes.md | 14 ++ .../cloudflared/icon.png | Bin .../cloudflared/questions.yaml | 0 .../cloudflared/templates/common.yaml | 0 .../cloudflared/values.yaml | 0 11 files changed, 153 insertions(+), 155 deletions(-) delete mode 100644 charts/incubator/cloudflared/docs/installation_notes.md rename charts/{incubator => stable}/cloudflared/.helmignore (93%) rename charts/{incubator => stable}/cloudflared/CHANGELOG.md (100%) rename charts/{incubator => stable}/cloudflared/Chart.yaml (96%) rename charts/{incubator => stable}/cloudflared/README.md (97%) rename charts/{incubator => stable}/cloudflared/ci/test-values.yaml (100%) create mode 100644 charts/stable/cloudflared/docs/installation_notes.md rename charts/{incubator => stable}/cloudflared/icon.png (100%) rename charts/{incubator => stable}/cloudflared/questions.yaml (100%) rename charts/{incubator => stable}/cloudflared/templates/common.yaml (100%) rename charts/{incubator => stable}/cloudflared/values.yaml (100%) diff --git a/charts/incubator/cloudflared/docs/installation_notes.md b/charts/incubator/cloudflared/docs/installation_notes.md deleted file mode 100644 index 708d7506bb1..00000000000 --- a/charts/incubator/cloudflared/docs/installation_notes.md +++ /dev/null @@ -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. diff --git a/charts/incubator/cloudflared/.helmignore b/charts/stable/cloudflared/.helmignore similarity index 93% rename from charts/incubator/cloudflared/.helmignore rename to charts/stable/cloudflared/.helmignore index 77ca5567b26..01a3b79bc77 100644 --- a/charts/incubator/cloudflared/.helmignore +++ b/charts/stable/cloudflared/.helmignore @@ -1,30 +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 +# 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 diff --git a/charts/incubator/cloudflared/CHANGELOG.md b/charts/stable/cloudflared/CHANGELOG.md similarity index 100% rename from charts/incubator/cloudflared/CHANGELOG.md rename to charts/stable/cloudflared/CHANGELOG.md diff --git a/charts/incubator/cloudflared/Chart.yaml b/charts/stable/cloudflared/Chart.yaml similarity index 96% rename from charts/incubator/cloudflared/Chart.yaml rename to charts/stable/cloudflared/Chart.yaml index ae4749003dc..d3f72dd1f4e 100644 --- a/charts/incubator/cloudflared/Chart.yaml +++ b/charts/stable/cloudflared/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: cloudflared -version: 0.0.17 +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 @@ -24,6 +24,6 @@ maintainers: url: https://truecharts.org annotations: truecharts.org/catagories: | - - incubator + - network truecharts.org/SCALE-support: "true" truecharts.org/grade: U diff --git a/charts/incubator/cloudflared/README.md b/charts/stable/cloudflared/README.md similarity index 97% rename from charts/incubator/cloudflared/README.md rename to charts/stable/cloudflared/README.md index 31beba44b0b..993752bfd9d 100644 --- a/charts/incubator/cloudflared/README.md +++ b/charts/stable/cloudflared/README.md @@ -1,107 +1,107 @@ -# 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) - -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 - -* - -## 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 +# 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) + +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 + +* + +## 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 diff --git a/charts/incubator/cloudflared/ci/test-values.yaml b/charts/stable/cloudflared/ci/test-values.yaml similarity index 100% rename from charts/incubator/cloudflared/ci/test-values.yaml rename to charts/stable/cloudflared/ci/test-values.yaml diff --git a/charts/stable/cloudflared/docs/installation_notes.md b/charts/stable/cloudflared/docs/installation_notes.md new file mode 100644 index 00000000000..041d5dd0711 --- /dev/null +++ b/charts/stable/cloudflared/docs/installation_notes.md @@ -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. diff --git a/charts/incubator/cloudflared/icon.png b/charts/stable/cloudflared/icon.png similarity index 100% rename from charts/incubator/cloudflared/icon.png rename to charts/stable/cloudflared/icon.png diff --git a/charts/incubator/cloudflared/questions.yaml b/charts/stable/cloudflared/questions.yaml similarity index 100% rename from charts/incubator/cloudflared/questions.yaml rename to charts/stable/cloudflared/questions.yaml diff --git a/charts/incubator/cloudflared/templates/common.yaml b/charts/stable/cloudflared/templates/common.yaml similarity index 100% rename from charts/incubator/cloudflared/templates/common.yaml rename to charts/stable/cloudflared/templates/common.yaml diff --git a/charts/incubator/cloudflared/values.yaml b/charts/stable/cloudflared/values.yaml similarity index 100% rename from charts/incubator/cloudflared/values.yaml rename to charts/stable/cloudflared/values.yaml