From bae962d107626d6724ef82da117143b7ac408441 Mon Sep 17 00:00:00 2001 From: truecharts-bot Date: Mon, 5 Sep 2022 08:48:53 +0000 Subject: [PATCH] chore: Auto-update chart README [skip ci] --- charts/incubator/orbital-sync/CHANGELOG.md | 11 +++ charts/incubator/orbital-sync/Chart.yaml | 4 +- charts/incubator/orbital-sync/README.md | 109 ++++++++++++++++++++- 3 files changed, 121 insertions(+), 3 deletions(-) create mode 100644 charts/incubator/orbital-sync/CHANGELOG.md diff --git a/charts/incubator/orbital-sync/CHANGELOG.md b/charts/incubator/orbital-sync/CHANGELOG.md new file mode 100644 index 00000000000..6d6acecc719 --- /dev/null +++ b/charts/incubator/orbital-sync/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + + + +## [orbital-sync-0.0.1]orbital-sync-0.0.1 (2022-09-05) + +### Feat + +- Add Orbital Sync chart ([#3702](https://github.com/truecharts/charts/issues/3702)) + + \ No newline at end of file diff --git a/charts/incubator/orbital-sync/Chart.yaml b/charts/incubator/orbital-sync/Chart.yaml index 4accaba6631..25302b28a86 100644 --- a/charts/incubator/orbital-sync/Chart.yaml +++ b/charts/incubator/orbital-sync/Chart.yaml @@ -1,12 +1,12 @@ apiVersion: v2 -appVersion: "v1.1.0" +appVersion: "1.1.0" dependencies: - name: common repository: https://library-charts.truecharts.org version: 10.5.6 deprecated: false description: Orbital Sync synchronizes multiple Pi-hole instances for high availability. -home: https://truecharts.org/docs/charts/stable/orbital-sync +home: https://truecharts.org/docs/charts/incubator/orbital-sync icon: https://truecharts.org/img/hotlink-ok/chart-icons/orbital-sync.png keywords: - Orbital Sync diff --git a/charts/incubator/orbital-sync/README.md b/charts/incubator/orbital-sync/README.md index bc137a76ad0..84cd99a7c45 100644 --- a/charts/incubator/orbital-sync/README.md +++ b/charts/incubator/orbital-sync/README.md @@ -1 +1,108 @@ -Bla bla for CI +# orbital-sync + +![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square) + +Orbital Sync synchronizes multiple Pi-hole instances for high availability. + +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: [orbital-sync](https://truecharts.org/docs/charts/incubator/orbital-sync) + +**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 + +* +* + +## 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 `orbital-sync` + +```console +helm repo add TrueCharts https://charts.truecharts.org +helm repo update +helm install orbital-sync TrueCharts/orbital-sync +``` + +## 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 `orbital-sync` deployment + +```console +helm uninstall orbital-sync +``` + +## 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 orbital-sync \ + --set env.TZ="America/New York" \ + TrueCharts/orbital-sync +``` + +#### 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 orbital-sync TrueCharts/orbital-sync -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