- 
-
-
-## About The Project
-
-## CLA: Before contributing
-
-Our CLA applies to this repository as well.
-
-Please ensure it's signed before submitting a PR:
-https://cla-assistant.io/truecharts/charts
-
-*We use the truecharts/charts link, as CLA assistant does not allow for creating a custom link to a private repository.
-However, they all sign the same CLA that applies project-wide*
-
-## License
-
-This tool is released as "All Rights reserved" and hence it's code should NOT be shared. This includes binaries that are modified to remove TrueCharts specific code, unless approved by Kjeld Schouten "The Owner".
-Those that are invited to have access to repository, are free to edit and use this code for testing purposes, as long as its sourcecode is not shared or saved in-the-cloud.
diff --git a/archive/clustertool/changelog.tmpl b/archive/clustertool/changelog.tmpl
deleted file mode 100644
index 1821f9a9068..00000000000
--- a/archive/clustertool/changelog.tmpl
+++ /dev/null
@@ -1,18 +0,0 @@
----
-title: Changelog
-pagefind: false
----
-
-All history information can be found at [Github History](https://github.com/trueforge-org/truecharts/commits/master/charts/{{ .Train }}/{{ .Name }})
-
-:::tip
-
-If you need more than 2 scrolls to find your current version, please consider updating the chart as soon as possible.
-
-:::
-{{ range $key := .SortedVersions }}
-## {{ $key }} • [Train: {{ (index $.Versions $key).Train }}]
-{{ range $commit := (index $.Versions $key).SortedCommits }}
-- {{ printf "%s • [`%s`](https://github.com/trueforge-org/truecharts/commit/%s) • [@%s] (%s)" $commit.Message (slice $commit.CommitHash 0 7) $commit.CommitHash $commit.Author.Name $commit.Author.Date -}}
-{{ end }}
-{{ end -}}
diff --git a/archive/clustertool/clustertool.LICENSE b/archive/clustertool/clustertool.LICENSE
deleted file mode 100644
index 33a8cbb23f0..00000000000
--- a/archive/clustertool/clustertool.LICENSE
+++ /dev/null
@@ -1,106 +0,0 @@
-Business Source License 1.1
-
-Parameters
-
-Licensor: The TrueCharts Project, it's owner and it's contributors
-Licensed Work: The TrueCharts "Blocky" Helm Chart
-Additional Use Grant: You may use the licensed work in production, as long
- as it is directly sourced from a TrueCharts provided
- official repository, catalog or source. You may also make private
- modification to the directly sourced licenced work,
- when used in production.
-
- The following cases are, due to their nature, also
- defined as 'production use' and explicitly prohibited:
- - Bundling, including or displaying the licensed work
- with(in) another work intended for production use,
- with the apparent intend of facilitating and/or
- promoting production use by third parties in
- violation of this license.
-
-Change Date: 2050-01-01
-
-Change License: 3-clause BSD license
-
-For information about alternative licensing arrangements for the Software,
-please contact: legal@truecharts.org
-
-Notice
-
-The Business Source License (this document, or the “License”) is not an Open
-Source license. However, the Licensed Work will eventually be made available
-under an Open Source License, as stated in this License.
-
-License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
-“Business Source License” is a trademark of MariaDB Corporation Ab.
-
------------------------------------------------------------------------------
-
-Business Source License 1.1
-
-Terms
-
-The Licensor hereby grants you the right to copy, modify, create derivative
-works, redistribute, and make non-production use of the Licensed Work. The
-Licensor may make an Additional Use Grant, above, permitting limited
-production use.
-
-Effective on the Change Date, or the fourth anniversary of the first publicly
-available distribution of a specific version of the Licensed Work under this
-License, whichever comes first, the Licensor hereby grants you rights under
-the terms of the Change License, and the rights granted in the paragraph
-above terminate.
-
-If your use of the Licensed Work does not comply with the requirements
-currently in effect as described in this License, you must purchase a
-commercial license from the Licensor, its affiliated entities, or authorized
-resellers, or you must refrain from using the Licensed Work.
-
-All copies of the original and modified Licensed Work, and derivative works
-of the Licensed Work, are subject to this License. This License applies
-separately for each version of the Licensed Work and the Change Date may vary
-for each version of the Licensed Work released by Licensor.
-
-You must conspicuously display this License on each original or modified copy
-of the Licensed Work. If you receive the Licensed Work in original or
-modified form from a third party, the terms and conditions set forth in this
-License apply to your use of that work.
-
-Any use of the Licensed Work in violation of this License will automatically
-terminate your rights under this License for the current and all other
-versions of the Licensed Work.
-
-This License does not grant you any right in any trademark or logo of
-Licensor or its affiliates (provided that you may use a trademark or logo of
-Licensor as expressly required by this License).
-
-TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
-AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
-EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
-TITLE.
-
-MariaDB hereby grants you permission to use this License’s text to license
-your works, and to refer to it using the trademark “Business Source License”,
-as long as you comply with the Covenants of Licensor below.
-
-Covenants of Licensor
-
-In consideration of the right to use this License’s text and the “Business
-Source License” name and trademark, Licensor covenants to MariaDB, and to all
-other recipients of the licensed work to be provided by Licensor:
-
-1. To specify as the Change License the GPL Version 2.0 or any later version,
- or a license that is compatible with GPL Version 2.0 or a later version,
- where “compatible” means that software provided under the Change License can
- be included in a program with software provided under GPL Version 2.0 or a
- later version. Licensor may specify additional Change Licenses without
- limitation.
-
-2. To either: (a) specify an additional grant of rights to use that does not
- impose any additional restriction on the right granted in this License, as
- the Additional Use Grant; or (b) insert the text “None”.
-
-3. To specify a Change Date.
-
-4. Not to modify this License in any other way.
diff --git a/archive/clustertool/cmd/adv.go b/archive/clustertool/cmd/adv.go
deleted file mode 100644
index 18bacb9eb56..00000000000
--- a/archive/clustertool/cmd/adv.go
+++ /dev/null
@@ -1,25 +0,0 @@
-package cmd
-
-import (
- "strings"
-
- "github.com/spf13/cobra"
-)
-
-var advLongHelp = strings.TrimSpace(`
-These are all advanced commands that should generally not be needed
-
-`)
-
-var adv = &cobra.Command{
- Use: "adv",
- Short: "Advanced cluster maintanence commands",
- Example: "clustertool adv
- clustertool
- - [](https://github.com/trueforge-org/truecharts/clustertool/releases) - [](https://github.com/trueforge-org/truecharts/clustertool/issues) - -
- A helper tool to help building TrueCharts helm charts
-
- ·
- Report Bug
- ·
- Request Feature
-
-
-
-## Migrate the PVCs
-
-### Get the PVCs names and paths
-
-The following commands will return the PVCs for the old and the new install.
-
-```bash
-k3s kubectl get pvc -n ix-vaultwarden
-k3s kubectl get pvc -n ix-testwarden
-```
-
-Take note of all the PVCs that do not contain `postgres`, `redis` or `cnpg`. `vaultwarden` only has 1 data PVC. There are apps that have more than 1. You'll want to migrate them all.
-
-Now, find the full paths to all these PVCs.
-
-```bash
-zfs list | grep pvc | grep legacy
-```
-
-If this returns a very long list, you can add `| grep MariaDB Database Migration
-
-
-If the app uses a MariaDB database, we need to make a backup and restore that backup to the new app's database. - -:::note[Requirements] - -Make sure you have `adminer` installed, as we'll be using it to make a backup and to restore the database. It's a TrueCharts app from the stable train. You can install it with all default settings, and it will work. - -::: - -### Configure database connections in adminer - -To get the MariaDB credentials from each install the easiest way (until a script does this) is logging into the main container shell and typing `env`, which pulls down the list of `environment variables` used by the container, including the `database credentials`. - - - -Repeat the same for the "new" app - - - -### Create database Backup - -Login to `adminer` using the 4 values highlighted in red above. For most users it'll be `appname-mariadb.ix-appname.svc.cluster.local:3306` or in this case `photoprism-mariadb.ix-photoprism.svc.cluster.local:3306` - - - -Click `Export`, choose a compression output (gzip) and press `export` - - - -### Restore database backup - -Now you login to `adminer` with the "new" app - - - -Click `Import`, then `Choose Files`, upload your backup and then click `Execute` - - - -
-View MariaDB export and import instructions
- -If the app uses a MariaDB database, we need to make a backup and restore that backup to the new app's database. - -:::note[Requirements] - -Make sure you have `adminer` installed, as we'll be using it to make a backup and to restore the database. It's a TrueCharts app from the stable train. You can install it with all default settings, and it will work. - -::: - -### Configure database connections in adminer - -To get the MariaDB credentials from each install the easiest way (until a script does this) is logging into the main container shell and typing `env`, which pulls down the list of `environment variables` used by the container, including the `database credentials`. - - - -Repeat the same for the "new" app - - - -### Create database Backup - -Login to `adminer` using the 4 values highlighted in red above. For most users it'll be `appname-mariadb.ix-appname.svc.cluster.local:3306` or in this case `photoprism-mariadb.ix-photoprism.svc.cluster.local:3306` - - - -Click `Export`, choose a compression output (gzip) and press `export` - - - -### Restore database backup - -Now you login to `adminer` with the "new" app - - - -Click `Import`, then `Choose Files`, upload your backup and then click `Execute` - - - -
enum:
- value: "RollingUpdate"
description: "Create new pods and then kill old ones"
- value: "Recreate"
description: "Kill existing pods before creating new ones" | -| schema.valid_chars | string | false | regular expression for input chars validation. | -| schema.subquestions | []subquestion | false | add an array of subquestions. | -| schema.show_if | string | false | show current variable if condition specified is true, for example `show_if: [["workloadType", "=", "CronJob"]]` | -| schema.show_subquestions_if | string | false | show subquestions if is true or equal to one of the options. for example `show_subquestion_if: "static"`. system will convert this to the filters format specified for `schema.show_if` automatically. | -| schema.attrs | []variables | false | specified when `schema.type` is dictionary to declare attributes allowed in the dictionary. | -| schema.items | []variables | false | specified when `schema.type` is list to declare attributes allowed in the list. | -| schema.private | bool | false | specified for declaring information sensitive fields. | -| schema.null | bool | false | specifies if the value for the variable can be null. defaults to false. | - -#### Subquestions - -`subquestions[]` cannot contain `subquestions` or `show_subquestions_if` keys, but all other keys in the above table are supported. Also variables having `schema.type` list do not support `subquestions`. - -#### Special Questions - -There are some novel cases where we would like to provide ability to configure / manage resources for workloads with getting some data from system dynamically. -So a chart can specify certain actions to be performed by the system for a variable by defining a reference. An example better illustrates this concept: - -```yaml -- variable: volume - label: "Volume" - schema: - type: dict - $ref: - - "normalize/ixVolume" - attrs: - - variable: mountPath - label: "Mount Path" - description: "Path where the volume will be mounted inside the pod" - schema: - type: path - required: true - - variable: datasetName - label: "Dataset Name" - schema: - type: string - required: true -``` - -In the above variable we define a `$ref` in schema which specifies that the system should take some action for normalizing the value specified for the variable. -In this specific case, `ix_volume` is a concept introduced where we recommend using a volume which we are able to rollback automatically on chart release rollback. In essence, -it is just a `hostPath` volume for which the system automatically creates the dataset specified. -We have following types of actions supported in `$ref` right now: - -1. definitions -2. normalize - For (1), system will automatically update schema for a particular definition. For example, - -```yaml -- variable: hostInterface - description: "Please specify host interface" - label: "Host Interface" - schema: - type: string - required: true - $ref: - - "definitions/interface" -``` - -System will automatically populate available interfaces for the user based on what interfaces are available on the system. -For (2), system will normalize values or perform some actions as discussed above. - -#### Standardized questions.yaml sections - -To minimize the maintenance load of our App collection, we always aim to standardize as much as possible. The same goes for questions.yaml. Included here are some code standardized code-snippets that are expected to be included in every App. -Be aware that sometimes specific functions might or might not completely function. However, omitting them would significantly increase the maintenance burden and this functionality is often incorporated into the common-chart anyway. - -#### Groups - -To make sure all apps stay somewhat the same, we use a list of standardized groups for the groups section. Please make sure to use these groups in your Apps: - -```yaml -groups: - - name: "Container Image" - description: "Image to be used for container" - - name: "Workload Configuration" - description: "Configure workload deployment" - - name: "Configuration" - description: "additional container configuration" - - name: "Networking" - description: "Configure Network and Services for container" - - name: "Storage" - description: "Persist and share data that is separate from the lifecycle of the container" - - name: "Resources and Devices" - description: "Specify resources/devices to be allocated to workload" - - name: "Ingress Configuration" - description: "Ingress Configuration" - - name: "Security" - description: "Configure security context" - - name: "Advanced" - description: "Advanced Configuration" - - name: "WARNING" - description: "WARNING" -``` - -#### General Configuration options - -These options are always\* included because almost every chart (eventually) has a use for them and/or other parts of the common chart depend on them. -They are called general options, because they affect the basic functionalities of a chart. For example: Custom User environment variables, permissions and timezones. - -\*`PUID`, `PGID`, `UMASK` are only included when they are needed. - -```yaml -- variable: env - group: "Configuration" - label: "Image Environment" - schema: - additional_attrs: true - type: dict - attrs: - - variable: TZ - label: "Timezone" - schema: - type: string - default: "Etc/UTC" - $ref: - - "definitions/timezone" - - variable: PUID - label: "PUID" - description: "Sets the PUID env var for LinuxServer.io (compatible) containers" - schema: - type: int - default: 568 - - variable: PGID - label: "PGID" - description: "Sets the PGID env var for LinuxServer.io (compatible) containers" - schema: - type: int - default: 568 - - variable: UMASK - label: "UMASK" - description: "Sets the UMASK env var for LinuxServer.io (compatible) containers" - schema: - type: string - default: "002" - -# Configure Custom Environment Variables -- variable: environmentVariables - label: "Image environment" - group: "Configuration" - schema: - type: list - default: [] - items: - - variable: environmentVariable - label: "Environment Variable" - schema: - type: dict - attrs: - - variable: name - label: "Name" - schema: - type: string - - variable: value - label: "Value" - schema: - type: string -``` - -#### Security Context Configuration options - -```yaml -# Enable privileged -- variable: securityContext - group: "Security" - label: "Security Context" - schema: - additional_attrs: true - type: dict - attrs: - - variable: privileged - label: "Enable privileged mode for Common-Chart based charts" - schema: - type: boolean - default: false -# Set Pod Security Policy -- variable: podSecurityContext - group: "Security" - label: "Pod Security Context" - schema: - additional_attrs: true - type: dict - attrs: - - variable: runAsNonRoot - label: "runAsNonRoot" - schema: - type: boolean - default: true - - 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 - - variable: fsGroupChangePolicy - label: "When should we take ownership?" - schema: - type: string - default: "OnRootMismatch" - enum: - - value: "OnRootMismatch" - description: "OnRootMismatch" - - value: "Always" - description: "Always" -``` diff --git a/archive/website/SCALE/guides/recover-cnpg.md b/archive/website/SCALE/guides/recover-cnpg.md deleted file mode 100644 index 3d08f2d5828..00000000000 --- a/archive/website/SCALE/guides/recover-cnpg.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: Recovering CNPG Apps after Reboot ---- - -:::danger - -TrueNAS SCALE Apps are considered Deprecated. We heavily recommend using a more mature Kubernetes platform such as "TalosOS" instead, and no longer offer an apps/charts catalogue for SCALE users to install. The below docs exist purely as historical references and may be removed at any time. - -::: - -Apps with a PostgreSQL database that were updated to the new CNPG common sometimes don't survive a reboot of TrueNAS Scale. The App then hangs on _DEPLOYING_ and pods are in state _Completed_ or _TaintToleration_. - -:::caution[Best Effort Policy] - -This guide has been written with the best efforts of the staff and tested as best possible. We are not responsible if it doesn't work for every scenario or user situation or if you suffer data loss as a result. -This guide has been tested with TrueNAS SCALE Bluefin 22.12.4.2, Cobia 23.10, CNPG 1.20.2_2.0.3 and HomeAssistant 2023.10.3_20.0.12. - -::: - -## Symptoms - -If you have rebooted and your Apps are hanging on _DEPLOYING_, check if you see pods in state _Completed_ or _TaintToleration_ and the apps main pod in state _Init_ with the -command `k3s kubectl get all -n ix-