New feature: Community-Scripts API

[michelroegl-brunner]

Introducing Our New LXC Diagnostics API

We're excited to introduce a new API that collects diagnostic data during the creation of LXC containers. This feature aims to enhance troubleshooting, performance analysis, and overall system insight while ensuring a seamless container deployment experience.
Related Pull Request: #1801

What Data is Collected?

Our diagnostics API captures essential details about each container, including the following list, but no user data gets stored!

• ct_type – Type of container
• disk_size – Allocated disk space
• core_count – Number of CPU cores assigned
• ram_size – Amount of allocated RAM
• os_type – Operating system type
• os_version – Version of the OS
• disableip6 – Whether IPv6 is disabled
• nsapp – Namespace application
• method – Method used for container creation
• pve_version – Proxmox Virtual Environment version

How to Disable Diagnostics

If you prefer not to use this feature, you can disable it by setting DIAGNOSTICS=no in the configuration file, or in the menu:

nano /usr/local/community-scripts/diagnostics

If this file does not exist, it will be created automatically during container creation with the value set according to your choice. Additionally, you can disable diagnostics through the interactive menu during the setup process.

Why Use This Feature?

By enabling diagnostics, you gain valuable insights into your LXC deployments, making it easier to track resource allocation, system performance, and troubleshoot issues effectively.

We’re committed to improving the LXC experience, and we welcome feedback on this new API. Let us know how it helps you, and feel free to share any suggestions for enhancements!

Where to find the data?

As with the merge of #1841, you can review the data here

Screenshots

• First use on a Proxmox node
  

• New menu
  

• Diagnostic Settings
  
  

[thorazine74]

This should be opt-in by default, not opt-out 👎

[michelroegl-brunner]

it is?

[MickLesk]

Is it. Per Default its "none" and you have the choose. After this you can change it manually or with every script call.

[thorazine74]

Maybe you have a different understanding of what opt-in is...
The default answer to the question shown to the user is YES.
In a typical script installation flow, pressing Enter = Next.
So for an average user that just install the script pressing Enter > Next > Enter > Next it would choose that option.

Also, once the user makes a choice once, the setting is permanently saved on the host, so if the user installs another LXC, diagnostic data will be automatically collected and sent.
This should not be done without explicitly asking the user in a separate question, if he wants to send diagnostic data just this time, or with each LXC install from now on.

[fjbravo]

What are the SSH details gathered by the diagnostics?
ssh – SSH configuration

[michelroegl-brunner]

It just was if enabled yes/no. No passwords.
But we have removed it. i need to update the docs.