From fa4b7d87fe197e137959fca0d46c3ab88dd51847 Mon Sep 17 00:00:00 2001 From: kqmaverick <121722567+kqmaverick@users.noreply.github.com> Date: Sun, 3 Mar 2024 09:13:53 -0800 Subject: [PATCH] feat(peanut) move peanut to stable (#18746) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** Moves peanut to stable and adds installation notes. ⚒️ Fixes # **⚙️ Type of change** - [X] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [X] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [X] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- charts/{incubator => stable}/peanut/.helmignore | 0 charts/{incubator => stable}/peanut/CHANGELOG.md | 0 charts/{incubator => stable}/peanut/Chart.yaml | 8 ++++---- charts/{incubator => stable}/peanut/README.md | 2 +- charts/stable/peanut/docs/installation-notes.md | 14 ++++++++++++++ charts/{incubator => stable}/peanut/icon.png | Bin .../{incubator => stable}/peanut/questions.yaml | 6 +++--- .../peanut/templates/NOTES.txt | 0 .../peanut/templates/common.yaml | 0 charts/{incubator => stable}/peanut/values.yaml | 0 10 files changed, 22 insertions(+), 8 deletions(-) rename charts/{incubator => stable}/peanut/.helmignore (100%) rename charts/{incubator => stable}/peanut/CHANGELOG.md (100%) rename charts/{incubator => stable}/peanut/Chart.yaml (82%) rename charts/{incubator => stable}/peanut/README.md (93%) create mode 100644 charts/stable/peanut/docs/installation-notes.md rename charts/{incubator => stable}/peanut/icon.png (100%) rename charts/{incubator => stable}/peanut/questions.yaml (95%) rename charts/{incubator => stable}/peanut/templates/NOTES.txt (100%) rename charts/{incubator => stable}/peanut/templates/common.yaml (100%) rename charts/{incubator => stable}/peanut/values.yaml (100%) diff --git a/charts/incubator/peanut/.helmignore b/charts/stable/peanut/.helmignore similarity index 100% rename from charts/incubator/peanut/.helmignore rename to charts/stable/peanut/.helmignore diff --git a/charts/incubator/peanut/CHANGELOG.md b/charts/stable/peanut/CHANGELOG.md similarity index 100% rename from charts/incubator/peanut/CHANGELOG.md rename to charts/stable/peanut/CHANGELOG.md diff --git a/charts/incubator/peanut/Chart.yaml b/charts/stable/peanut/Chart.yaml similarity index 82% rename from charts/incubator/peanut/Chart.yaml rename to charts/stable/peanut/Chart.yaml index 2bc8f20cfeca..564cfc2a0fd2 100644 --- a/charts/incubator/peanut/Chart.yaml +++ b/charts/stable/peanut/Chart.yaml @@ -5,7 +5,7 @@ annotations: truecharts.org/category: system truecharts.org/max_helm_version: "3.14" truecharts.org/min_helm_version: "3.11" - truecharts.org/train: incubator + truecharts.org/train: stable apiVersion: v2 appVersion: 2.5.0 dependencies: @@ -18,7 +18,7 @@ dependencies: import-values: [] deprecated: false description: A Tiny Dashboard for Network UPS Tools. -home: https://truecharts.org/charts/incubator/peanut +home: https://truecharts.org/charts/stable/peanut icon: https://truecharts.org/img/hotlink-ok/chart-icons/peanut.png keywords: - peanut @@ -31,7 +31,7 @@ maintainers: name: peanut sources: - https://github.com/Brandawg93/PeaNUT - - https://github.com/truecharts/charts/tree/master/charts/incubator/peanut + - https://github.com/truecharts/charts/tree/master/charts/stable/peanut - https://hub.docker.com/r/brandawg93/peanut type: application -version: 0.0.1 +version: 1.0.0 diff --git a/charts/incubator/peanut/README.md b/charts/stable/peanut/README.md similarity index 93% rename from charts/incubator/peanut/README.md rename to charts/stable/peanut/README.md index 8938ddbc134d..68f8187e8997 100644 --- a/charts/incubator/peanut/README.md +++ b/charts/stable/peanut/README.md @@ -7,7 +7,7 @@ title: README TrueCharts can be installed as both _normal_ Helm Charts or as Apps on TrueNAS SCALE. However only installations using the TrueNAS SCALE Apps system are supported. -For more information about this App, please check the docs on the TrueCharts [website](https://truecharts.org/charts/incubator/peanut) +For more information about this App, please check the docs on the TrueCharts [website](https://truecharts.org/charts/stable/peanut) **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)** diff --git a/charts/stable/peanut/docs/installation-notes.md b/charts/stable/peanut/docs/installation-notes.md new file mode 100644 index 000000000000..fadc3327bfd1 --- /dev/null +++ b/charts/stable/peanut/docs/installation-notes.md @@ -0,0 +1,14 @@ +# Installation Notes + +Notes about the proper setup of PeaNUT. + +## Configuration + +- NUT Host: This is the server that NUT is running on. On TrueNAS Scale this would be your Scale IP Address. +- NUT Port: This is the port that the NUT is running on. On TrueNAS Scale this is `3493` +- Username: This is the username of the NUT. On TrueNAS Scale this is set in the UPS Service as `Monitor User` the default is `upsmon` +- Password: This is the password of the NUT. On TrueNAS Scale this is set in the UPS Service as `Monitor Password` + +## Homepage Widget + +- PeaNUT supports Homepage integration and has a Widget. After enabling Homepage and the Widget enter the name of the UPS in the `API-key (key)` block. On TrueNAS Scale this is set in the UPS Service as `Identifier`. \ No newline at end of file diff --git a/charts/incubator/peanut/icon.png b/charts/stable/peanut/icon.png similarity index 100% rename from charts/incubator/peanut/icon.png rename to charts/stable/peanut/icon.png diff --git a/charts/incubator/peanut/questions.yaml b/charts/stable/peanut/questions.yaml similarity index 95% rename from charts/incubator/peanut/questions.yaml rename to charts/stable/peanut/questions.yaml index fa3e889ec22f..de433e9a2e62 100644 --- a/charts/incubator/peanut/questions.yaml +++ b/charts/stable/peanut/questions.yaml @@ -17,19 +17,19 @@ questions: type: dict attrs: - variable: NUT_HOST - label: Nut Host + label: NUT Host description: Host of NUT server schema: type: string default: "localhost" - variable: NUT_PORT - label: Nut Port + label: NUT Port description: Port of NUT server schema: type: int default: 3493 - variable: USERNAME - label: UserName + label: Username schema: type: string default: "" diff --git a/charts/incubator/peanut/templates/NOTES.txt b/charts/stable/peanut/templates/NOTES.txt similarity index 100% rename from charts/incubator/peanut/templates/NOTES.txt rename to charts/stable/peanut/templates/NOTES.txt diff --git a/charts/incubator/peanut/templates/common.yaml b/charts/stable/peanut/templates/common.yaml similarity index 100% rename from charts/incubator/peanut/templates/common.yaml rename to charts/stable/peanut/templates/common.yaml diff --git a/charts/incubator/peanut/values.yaml b/charts/stable/peanut/values.yaml similarity index 100% rename from charts/incubator/peanut/values.yaml rename to charts/stable/peanut/values.yaml