public inbox for pdm-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: "Lukas Wagner" <l.wagner@proxmox.com>
To: "Proxmox Datacenter Manager development discussion"
	<pdm-devel@lists.proxmox.com>,
	"Christoph Heiss" <c.heiss@proxmox.com>
Subject: Re: [pdm-devel] [PATCH datacenter-manager v2 09/14] config: add auto-installer configuration module
Date: Tue, 09 Dec 2025 11:22:43 +0100	[thread overview]
Message-ID: <DETM16IMGFHP.1OTPW3UTGN9PW@proxmox.com> (raw)
In-Reply-To: <20251205112528.373387-10-c.heiss@proxmox.com>

One note inline, otherwise this looks good to me.

On Fri Dec 5, 2025 at 12:25 PM CET, Christoph Heiss wrote:
> Provides some primitives for the auto-installer integration to save
> state about
> - individual installations (as plain JSON, as these aren't
>   configurations files) and
> - prepared answer file configurations, as section config
>
> The new files (including lock files) are placed under
> `/etc/proxmox-datacenter-manager/autoinst`.
>
> Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
> ---
> Changes v1 -> v2:
>   * no changes
>
>  lib/pdm-config/Cargo.toml          |  2 +
>  lib/pdm-config/src/auto_install.rs | 85 ++++++++++++++++++++++++++++++
>  lib/pdm-config/src/lib.rs          |  1 +
>  lib/pdm-config/src/setup.rs        |  7 +++
>  4 files changed, 95 insertions(+)
>  create mode 100644 lib/pdm-config/src/auto_install.rs
>
> diff --git a/lib/pdm-config/Cargo.toml b/lib/pdm-config/Cargo.toml
> index d39c2ad..c43579d 100644
> --- a/lib/pdm-config/Cargo.toml
> +++ b/lib/pdm-config/Cargo.toml
> @@ -12,6 +12,7 @@ nix.workspace = true
>  once_cell.workspace = true
>  openssl.workspace = true
>  serde.workspace = true
> +serde_json.workspace = true
>  
>  proxmox-config-digest = { workspace = true, features = [ "openssl" ] }
>  proxmox-http = { workspace = true, features = [ "http-helpers" ] }
> @@ -23,5 +24,6 @@ proxmox-shared-memory.workspace = true
>  proxmox-simple-config.workspace = true
>  proxmox-sys = { workspace = true, features = [ "acl", "crypt", "timer" ] }
>  proxmox-acme-api.workspace = true
> +proxmox-serde.workspace = true
>  pdm-api-types.workspace = true
>  pdm-buildcfg.workspace = true
> diff --git a/lib/pdm-config/src/auto_install.rs b/lib/pdm-config/src/auto_install.rs
> new file mode 100644
> index 0000000..0374a70
> --- /dev/null
> +++ b/lib/pdm-config/src/auto_install.rs
> @@ -0,0 +1,85 @@
> +//! Implements configuration for the auto-installer integration.
> +
> +use anyhow::Result;
> +use proxmox_schema::ApiType;
> +use proxmox_section_config::{SectionConfig, SectionConfigData, SectionConfigPlugin};
> +use std::{fs::File, sync::LazyLock};
> +
> +use pdm_api_types::{
> +    auto_installer::{Installation, PreparedInstallationConfig, PREPARED_INSTALL_CONFIG_ID_SCHEMA},
> +    ConfigDigest,
> +};
> +use proxmox_product_config::{open_api_lockfile, replace_config, ApiLockGuard};
> +use proxmox_sys::error::SysError;
> +
> +pub const CONFIG_PATH: &str = pdm_buildcfg::configdir!("/autoinst");
> +
> +static CONFIG: LazyLock<SectionConfig> = LazyLock::new(|| {
> +    let mut config = SectionConfig::new(&PREPARED_INSTALL_CONFIG_ID_SCHEMA);
> +
> +    config.register_plugin(SectionConfigPlugin::new(
> +        "prepared-answer".into(),
> +        Some("id".into()),
> +        PreparedInstallationConfig::API_SCHEMA.unwrap_object_schema(),
> +    ));
> +    config
> +});
> +
> +const PREPARED_CONF_FILE: &str = pdm_buildcfg::configdir!("/autoinst/prepared.cfg");
> +const PREPARED_LOCK_FILE: &str = pdm_buildcfg::configdir!("/autoinst/.prepared.lock");
> +
> +// Information about installations themselves are not configuration files and thus are saved
> +// as JSON.
> +const INSTALLATIONS_CONF_FILE: &str = pdm_buildcfg::configdir!("/autoinst/installations.json");
> +const INSTALLATIONS_LOCK_FILE: &str = pdm_buildcfg::configdir!("/autoinst/.installations.lock");

Any particular reason why you put `installations.json` in the config
directory and not in /var/lib/proxmox-datacenter-manager/... as 'state'?
To me this more seems like application state rather than configuration.

> +
> +pub fn installations_read_lock() -> Result<ApiLockGuard> {
> +    open_api_lockfile(INSTALLATIONS_LOCK_FILE, None, false)
> +}
> +
> +pub fn installations_write_lock() -> Result<ApiLockGuard> {
> +    open_api_lockfile(INSTALLATIONS_LOCK_FILE, None, true)
> +}
> +
> +pub fn read_installations() -> Result<(Vec<Installation>, ConfigDigest)> {
> +    let content: serde_json::Value = match File::open(INSTALLATIONS_CONF_FILE) {
> +        Ok(file) => serde_json::from_reader(std::io::BufReader::new(file))?,
> +        Err(ref err) if err.not_found() => serde_json::json!([]),
> +        Err(err) => return Err(err.into()),
> +    };
> +
> +    let digest = proxmox_serde::json::to_canonical_json(&content).map(ConfigDigest::from_slice)?;
> +    let data = serde_json::from_value(content)?;
> +
> +    Ok((data, digest))
> +}
> +
> +/// Write lock must be already held.
> +pub fn save_installations(config: &[Installation]) -> Result<()> {
> +    let raw = serde_json::to_string(&config)?;
> +    replace_config(INSTALLATIONS_CONF_FILE, raw.as_bytes())
> +}
> +
> +pub fn prepared_answers_read_lock() -> Result<ApiLockGuard> {
> +    open_api_lockfile(PREPARED_LOCK_FILE, None, false)
> +}
> +
> +pub fn prepared_answers_write_lock() -> Result<ApiLockGuard> {
> +    open_api_lockfile(PREPARED_LOCK_FILE, None, true)
> +}
> +
> +pub fn read_prepared_answers() -> Result<(SectionConfigData, ConfigDigest)> {
> +    let content =
> +        proxmox_sys::fs::file_read_optional_string(PREPARED_CONF_FILE)?.unwrap_or_default();
> +
> +    let digest = ConfigDigest::from_slice(content.as_bytes());
> +    let data = CONFIG.parse(PREPARED_CONF_FILE, &content)?;
> +
> +    Ok((data, digest))
> +}
> +
> +/// Write lock must be already held.
> +pub fn save_prepared_answers(config: &SectionConfigData) -> Result<()> {
> +    let raw = CONFIG.write(PREPARED_CONF_FILE, config)?;
> +    replace_config(PREPARED_CONF_FILE, raw.as_bytes())
> +}
> diff --git a/lib/pdm-config/src/lib.rs b/lib/pdm-config/src/lib.rs
> index 4c49054..5b9bcca 100644
> --- a/lib/pdm-config/src/lib.rs
> +++ b/lib/pdm-config/src/lib.rs
> @@ -2,6 +2,7 @@ use anyhow::{format_err, Error};
>  use nix::unistd::{Gid, Group, Uid, User};
>  pub use pdm_buildcfg::{BACKUP_GROUP_NAME, BACKUP_USER_NAME};
>  
> +pub mod auto_install;
>  pub mod certificate_config;
>  pub mod domains;
>  pub mod node;
> diff --git a/lib/pdm-config/src/setup.rs b/lib/pdm-config/src/setup.rs
> index 5f920c8..5adb05f 100644
> --- a/lib/pdm-config/src/setup.rs
> +++ b/lib/pdm-config/src/setup.rs
> @@ -24,6 +24,13 @@ pub fn create_configdir() -> Result<(), Error> {
>          0o750,
>      )?;
>  
> +    mkdir_perms(
> +        crate::auto_install::CONFIG_PATH,
> +        api_user.uid,
> +        api_user.gid,
> +        0o750,
> +    )?;
> +
>      Ok(())
>  }
>  



_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel


  reply	other threads:[~2025-12-09 10:22 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-05 11:25 [pdm-devel] [PATCH proxmox/datacenter-manager v2 00/14] initial auto-installer integration Christoph Heiss
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 01/14] api-macro: allow $ in identifier name Christoph Heiss
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 02/14] network-types: move `Fqdn` type from proxmox-installer-common Christoph Heiss
2025-12-09  9:13   ` Lukas Wagner
2025-12-09 12:26     ` Christoph Heiss
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 03/14] network-types: implement api type for Fqdn Christoph Heiss
2025-12-09  9:13   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 04/14] network-types: add api wrapper type for std::net::IpAddr Christoph Heiss
2025-12-09  9:16   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 05/14] installer-types: add common types used by the installer Christoph Heiss
2025-12-09  9:35   ` Lukas Wagner
2025-12-09 12:17     ` Christoph Heiss
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 06/14] installer-types: add types used by the auto-installer Christoph Heiss
2025-12-09  9:44   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH proxmox v2 07/14] installer-types: implement api type for all externally-used types Christoph Heiss
2025-12-09  9:52   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 08/14] api-types: add api types for auto-installer integration Christoph Heiss
2025-12-09 10:03   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 09/14] config: add auto-installer configuration module Christoph Heiss
2025-12-09 10:22   ` Lukas Wagner [this message]
2025-12-09 12:10     ` Christoph Heiss
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 10/14] acl: wire up new /system/auto-installation acl path Christoph Heiss
2025-12-09 10:23   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 11/14] server: api: add auto-installer integration module Christoph Heiss
2025-12-09 11:01   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 12/14] ui: auto-installer: add installations overview panel Christoph Heiss
2025-12-09 12:35   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 13/14] ui: auto-installer: add prepared answer configuration panel Christoph Heiss
2025-12-09 13:01   ` Lukas Wagner
2025-12-05 11:25 ` [pdm-devel] [PATCH datacenter-manager v2 14/14] docs: add documentation for auto-installer integration Christoph Heiss
2025-12-09 13:12   ` Lukas Wagner
2025-12-05 11:53 ` [pdm-devel] [PATCH proxmox/datacenter-manager v2 00/14] initial " Thomas Lamprecht
2025-12-05 15:50   ` Christoph Heiss
2025-12-05 15:57     ` Thomas Lamprecht
2025-12-09 13:38 ` Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DETM16IMGFHP.1OTPW3UTGN9PW@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=c.heiss@proxmox.com \
    --cc=pdm-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal