Skip to content

bitpushr

5 posts by bitpushr

ClusterTool Public Beta Release

Howdy everyone! I’m back to share some exciting progress updates with you all regarding ClusterTool development, a brief recap on some minor announcements from our part in recent weeks, updated docs and more.

This will be a packed news article from us, so let’s get into it!

ClusterTool Public Beta Update

Over the course of the last month and since our last update, ClusterTool has undergone much development effort. As we previously outlined in our TrueNAS SCALE migration path roadmap post, ClusterTool’s public Beta release will be mostly feature-complete, includes SCALE migration tooling (already implemented and awaiting testing) and will be suitable for users to migrate to semi-permanent Talos clusters from TrueNAS SCALE app environments, with Talos running in a Virtual Machine (atop SCALE itself).

ClusterTool has also seen the addition of FluxCD functionality, among others, and new builds are regularly being posted for testing here. We invite discussion and feedback in the #clustertool channel of our Discord, or you can simply follow the development of ClusterTool there.

Additionally, through collaborative efforts, we’re onboarding additional developers to work on ClusterTool directly throughout its Beta period. The more feedback we get from users, the better we can make the experience for all! We invite our users to test ClusterTool thoroughly throughout this phase and discuss or report any feedback/issues using threads in the above-mentioned Discord channel.

Docs Updates

In tandem with ClusterTool development, over the course of the last month we’ve been focused on docs for our users to read regarding Talos, ClusterTool, minimum and recommended system requirements, and more. Here are some links to these docs, though please note some of them are continuing to evolve as we gather feedback throughout this transitory phase.

  • Link to our new Helm-specific guides, including a quick-start guide for installing charts, guides for adding storage and backup/restore functionality to charts, example VPN setup instructions for your charts and more

  • Link to our all-new ClusterTool docs section which includes various sections on what ClusterTool is, what the various functions of it do and more

  • Link to our ClusterTool getting started guide

  • Link to our TrueNAS SCALE -> ClusterTool/Talos migration guide which includes instructions for prerequisite steps to be performed by users on TrueNAS SCALE prior to migrating to Talos via ClusterTool

  • Link to our Talos VM system requirements section, which leads into platform-specific, start-to-finish guides on how to setup a Talos VM for our users be it on SCALE, Proxmox, unRAID or other host platforms.

As always, we welcome feedback and additions to our docs which you can submit by opening a PR in this repo for review. Specifically, we welcome instructions for setting up a Talos VM on platforms other than the ones we’ve already written guides for.

Recent Project Recaps

In addition to the above, we’ve been posting announcements and project-related updates in the #announcements channel of our Discord. To recap and quickly get up to speed, you will want to read from this post onwards but to summarise:

  • iX-Systems has decided to move TrueNAS SCALE to a Docker-based apps backend, which is inherently incompatbile with our Helm-based project, beginning with Electric Eel later this year

  • We released VolSync Backup/Restore functionality for our charts to help facilitate cloud-based backup and restoration of data for TrueCharts users, if desired

  • We released a statement on our decision to deprecate our TrueNAS SCALE apps

  • Updates to chart-specific changelogs on our website now happen much faster

  • We clarified that TrueNAS SCALE users will not be required to be on DragonFish prior to migrating to our Talos VM solution for our charts going forward, as Cobia is suitable for migration

  • We have removed the TrueNAS SCALE apps catalogue from our project, and associated SCALE-specific code, tooling, etc. has been removed. While the TrueCharts SCALE apps catalogue can no longer be added to SCALE systems, an archived version of our TrueNAS SCALE apps catalogue is available here for historical purposes. Users with TrueCharts apps still installed in SCALE environments continue to have their apps function ahead of the upcoming migration to Talos, however these apps are strictly in an as-is state and no longer receive any updates or support

  • We clarified (after some recent confusion from a YouTube video) that the project is still alive, that users should continue to wait for ClusterTool to reach RC or final status before deciding whether to migrate to Talos using it, or switch to an alternative apps platform such as iX/TrueNAS “official” apps, Plain Docker or something else.

This serves as a summary of recent project-related news, and with the rest of this news post, should get you up to speed on the status of things in one go. As always, we very much appreciate you sticking with us through this transition period and we’re certain that our project will come out the other side continuing to lead and provide a first-class charts experience for our users.

Thank you for your continued support and understanding as we work to provide the best tools and services for our community. Stay tuned for more exciting updates in the months ahead!

ClusterTool Public Alpha Release and Updated Support Scope

We’re back to share some new updates with our users around ClusterTool, an updated support policy and further updates on the status of TrueNAS SCALE support.

ClusterTool Public Alpha Release

First up, we are excited to announce the public Alpha release of ClusterTool! This marks a significant step forward in our mission to provide powerful tools for bootstrapping and managing your own Kubernetes clusters on Talos, our platform of choice going forward.

Please note that KubeApps is not yet compatible with ClusterTool, and we currently do not offer any migration tooling to facilitate the transition of TrueNAS SCALE apps to Talos. This will come in a future release, per the timeline we previously outlined here.

You can find and download the latest releases of ClusterTool here. We also have a clustertool channel available on our Discord which users can use to discuss usage of the tool, and users can find our ClusterTool documentation here.

Updated Support Policy

We have updated our support policy in an effort to provide clearer, more defined guidelines for our users going forward. The updated policy includes information on our expectations around assumed/prior knowledge for users going forward, what’s not covered by TrueCharts support and more.

We would like to note that, in general, using our Charts with Kubernetes running on Talos will be a radically different experience compared to the prior experience afforded by TrueNAS SCALE. We are expecting some users that might have previously been comfortable running TrueCharts charts on SCALE, will not be comfortable with continuing to use TrueCharts on Talos.

In the future, we will post a news article outlining alternative options for TrueCharts users who do not wish to continue on Talos. These options may include

  • Migrating to iX/TrueNAS “official” apps
  • Migrating to unRAID
  • Migrating to a sandbox or “DIY Docker” setup
  • Options afforded by ElfHosted.

Going forward, we will assume users that wish to continue using TrueCharts on Talos have prior knowledge of the following:

  • How to use a shell, terminal or console
  • How to use basic shell commands to manage or perform actions on platforms such as Talos
  • How to use kubectl to get pods or services, describe issues, etc.
  • Basic knowledge of Talos including what “applying” does, what a “machineconfig” is and how “upgrades” work vs k8s-upgrade
  • Basic knowledge of Kubernetes including what a “pod” or “container” is
  • Others outlined below.

TrueCharts support will also not assist users with (including but not limited to) the below:

  • Network configuration
  • CloudFlare proxying
  • How to install or use kubectl or talosctl
  • Helm 101 (how to install, upgrade or edit a Helm Chart)
  • Configuring specific apps/software in TrueCharts Charts, e.g. Plex/Sonarr/etc. configuration.

For more information, please review the updated support policy here.

Discontinuation of Support for TrueCharts App Installs on TrueNAS SCALE

As part of our commitment to the path forward away from running TrueCharts apps on TrueNAS SCALE, we have discontinued support for new TrueCharts app installs on TrueNAS SCALE. TrueNAS SCALE is now a deprecated platform as far as TrueCharts apps are concerned, and this change is to ensure users are not left without support for new app installations.

Code related to the building of, development of, and other aspects of TrueNAS SCALE apps/charts support has been removed from the TrueCharts project backend.

To clarify: users can still install existing versions of TrueCharts apps/charts on TrueNAS SCALE, but they will not be eligible for support.

We advise users to await further migration updates as outlined in our roadmap linked above.

Thank you for your continued support and understanding as we work to provide the best tools and services for our community. Stay tuned for more exciting updates in the months ahead!

Enhanced Chart Backup and Restore Solutions

Enhancing Backups and Restores for TrueCharts Users

Today, we are pleased to announce new solutions for backing up and restoring of TrueCharts CNPG and application/chart data. We hope you enjoy!

Introducing CloudNativePG Backup and Restore Support for TrueCharts

We are excited to announce that TrueCharts now supports CloudNativePG backup and restore functionalities with S3 storage providers such as MinIO hosts, BackBlaze, CloudFlare, Amazon (coming soon) and more. This new feature offers TrueCharts users a seamless and efficient way to manage their database backups directly to the cloud, or to a local MinIO host.

By leveraging solutions provided by S3 storage providers, TrueCharts users can now

  • Enhance data security by storing backups in secure, scalable and durable storage

  • Optimize storage costs by taking advantage of the inherently cost-effective and scalable nature of S3 storage

  • Ensure reliability by benefiting from the high availability and enhanced redundancy offers by S3 providers

  • Simplify backup management by easily automating backup scheduled and managing them from an apps’ TrueNAS SCALE GUI or other interface

With this addition, TrueCharts users can rest assured that their applications’ CNPG data is easily recovered as needed, minimizing the risk of data loss and downtime.

Simplifying PVC Backups with VolSync

In addition to the above CNPG enhancements, TrueCharts is proud to introduce VolSync’s automatic backup and restore capabilities for PVC storage. VolSync simplifies the process of managing PVC backups, ensuring that your data is safeguarded.

Key features of VolSync include

  • Automatic backups of a chart or apps’ PVC data

  • Effortless restoring of PVC containers to a prior state when an app is (re)installed

  • Management on a per-app basis from an apps’ TrueNAS SCALE GUI, Helm or other any interface

By integrating VolSync, TrueCharts users achieve a higher level of data resilience, making it easier than ever to safeguard or recover an application/charts’ data.

Expanding Backups and Restores on Helm

TrueCharts is a multi-platform project that builds Helm charts with multiple downstream targets, including TrueNAS SCALE among others. As such, we’ve also published the above CNPG and VolSync guides to the Helm platform section of our docs. This allows TrueCharts users running Helm directly to also integrate these new features.

Caveats

Currently, this new restore functionality isn’t yet functional on TrueNAS SCALE due to an upstream bug with OpenEBS. We’ve submitted a bug report and will update the docs page linked below once this is resolved. For users of our charts on other Helm platforms, this does not apply, so backup and restore functionality should work fine.

Documentation and Instructions

You can find our initial guides and documentation for how to take advantage of the above exciting new solutions for SCALE here, and in the Helm section linked above. Please note that these pages will evolve and be updated in the near future, especially once functionality on SCALE is restored, and we welcome discussion in our Discord channel.

Closing Out

We’re committed to providing continual improvements and features to our users, thanks largely to those who have generously donated towards our project 💙. You allow TrueCharts to continue evolving.

If you find our documentation/guides helpful or want to join the ranks of the over 250 people helping buy us Coffee ☕ you can do this via our Open Collective page here:

One time or recurring Coffee donations 🫶

Thank you for choosing TrueCharts. Happy charting!

TrueNAS SCALE DragonFish Release and Support

Ahead of TrueNAS SCALE DragonFish hitting the open waters, TrueCharts is right alongside it with full support for the release. In this news post we’ll go over the improvements that can be expected from the update, the steps required for TrueCharts users to migrate their apps to this latest release and some things to keep in mind going forward.

This will be a relatively long but important post, so let’s get started!

TrueNAS SCALE DragonFish 🐟

DragonFish is the latest update to the iX-Systems TrueNAS SCALE platform, and brings a bevy of improvements and additions. These include new and reworked sections of the GUI, changes to ZFS ARC memory behavior that bring it inline with TrueNAS CORE, Linux kernel and GPU driver updates (including Intel ARC GPU support), improvements to SMB and NFS shares and more. Read more about the changes with DragonFish here.

TrueCharts and DragonFish: A Perfect Match 💞

Going forward, TrueCharts wants to confirm that DragonFish is the ONLY supported SCALE version by TrueCharts from its release onwards. This allows us to focus our efforts on ensuring compatibility, stability, and optimal performance for TrueNAS SCALE DragonFish users into the future. This means that there are a couple of things to note, depending on which version of TrueNAS SCALE you’re running.

TrueNAS SCALE Cobia Users

For existing TrueNAS SCALE users remaining on Cobia until such time they update, we understand that migration takes time. Whilst DragonFish is the future, you can select a special branch of TrueCharts in TrueNAS SCALE’s catalogue settings called legacy_23.10 (instead of main). This is, however, not covered by TrueCharts support from the release of DragonFish onwards.

Users Upgrading to TrueNAS SCALE DragonFish

As we have already outlined in previous communications, DragonFish includes an important change to how TrueCharts apps function on the SCALE platform. This means that there are two ways you can proceed with using our apps on DragonFish. These are

  1. Completely resetting the complete apps system by unsetting the Apps pool, removing the ix-applications dataset, and selecting the apps pool again, once your TrueNAS SCALE system is updated to DragonFish per our getting started guide for new users.

  2. Following our migration process for Cobia to DragonFish, developed in collaboration with and using tools/processes provided by HeavyBullets. Whilst this process is a manual one and is REQUIRED to be performed in one session/attempt, as noted on the page, it has been designed to be as smooth as possible after much internal testing and development from HeavyBullets. Thanks Heavy! ❤️

New TrueNAS SCALE DragonFish Users

New users joining the TrueCharts family will default to the DragonFish-supported main branch per our getting started guide.

Updated TrueNAS SCALE Support Policy

To ensure transparency, we’ve updated our TrueNAS SCALE support page to highlight which SCALE features and versions are supported by TrueCharts and which ones aren’t. Make sure to check it out to understand the scope of support our volunteers can provide you.

Enhanced TrueNAS SCALE GUI Options for TrueCharts Apps

We’ve updated the TrueCharts apps/charts options in the SCALE GUI to provide additional links to supporting documentation. We’ve also streamlined naming across all supported TrueCharts deployment platforms for a cohesive and user-friendly experience regardless of what platform you want to run Kubernetes on. We won’t judge!

Closing Out

We’re committed to providing the best support and experience for our TrueCharts users on TrueNAS SCALE DragonFish. The TrueCharts team would also like to thank those who have generously donated towards our project for their continued support 💙. You keep TrueCharts thriving and allow us to continue providing resources such as our new and improved website to the community.

If you find our documentation/guides helpful or want to join the ranks of the over 250 people helping buy us Coffee ☕you can do this via our Open Collective page here:

One time or recurring Coffee donations 🫶

Thank you for choosing TrueCharts, and here’s to a future filled with innovation and collaboration. Happy charting!

A New Dawn for TrueCharts: Now Powered by Starlight

Howdy everyone! After much work, we are excited to announce that our website has undergone a significant transformation. We’ve rebuilt our entire website atop Starlight, a stellar web framework, to help our documentation shine ✨ brighter ✨ than ever before.

In this news post, we’ll dive into what Starlight is, why we chose it, and the benefits it brings to our website and, ultimately, to you, our valued users.

What is Starlight? 🌠

Starlight is a modern, high-performance web framework designed to simplify and accelerate websites. Developed by the hugely talented team over at Astro, Starlight offers a fresh approach to building documentation websites by leveraging the power of static site generation, inherently fast design and secure operation. Starlight will enable us to create more dynamic, interactive docs for our users without compromising on performance or the their experience.

With Starlight, we can focus on building the features and content that TrueCharts is known for.

Why Starlight? 💡

There’s a few key reasons we chose to use Starlight for the new website. These include

Performance 🚀

Thanks to Starlight’s static site generation capabilities, we pre-render our website pages at build time, resulting in lightning-fast load times for viewers and improved performance. This ensures that our visitors have a seamless browsing experience irrespective of their device or network conditions.

Faster Build Times ⏰

Updates and changes to our website and documentation can now be made available to viewers much faster than they were in the past. This allows us to rapidly update, improve or otherwise make changes to our docs as needed.

Scalability 🌐

Starlight allows our website to effortlessly accommodate increases in traffic to ensure we remain accessible and responsive for our viewers, even during peak visitor times or when major developments result in a need for our users to consult our documentation.

What’s Next for TrueCharts?

We’re thrilled with the improvements that Starlight has brought to our website to further enhance your browsing experience, and we’re committed to delivering a faster, more secure, and engaging docs experience. Right now, the TrueCharts team is focused on updating our documentation standards and finalizing support and documentation for the upcoming TrueNAS SCALE DragonFish release.

The TrueCharts team would also like to thank those who have generously donated towards our project for their continued support 💙. You keep TrueCharts thriving and allow us to continue providing resources such as our new and improved website to the community.

If you find some use from our new website experience or want to join the ranks of the over 250 people helping buy us Coffee ☕, you can do this via our Open Collective page here:

One time or recurring Coffee donations 🫶

Happy charting!