[pbs-devel] [PATCH proxmox-backup v2] api-types: remove influxdb bucket name restrictions

[pbs-devel] [PATCH proxmox-backup v2] api-types: remove influxdb bucket name restrictions

[Gabriel Goller]

Remove the regex for influxdb organizations and buckets. Influxdb does
not place any constraints on these names and allows all characters. This
allows influxdb organization names with slashes.

Also remove a duplicate comment and add some missing ones.

This also aligns the behavior to PVE as there are no restrictions there
either.

The motivation for this patch is this forum post:
https://forum.proxmox.com/threads/influx-db-organization-doesnt-allow-slash.145402/

Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
 pbs-api-types/src/metrics.rs | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/pbs-api-types/src/metrics.rs b/pbs-api-types/src/metrics.rs
index 6800c23b..23421035 100644
--- a/pbs-api-types/src/metrics.rs
+++ b/pbs-api-types/src/metrics.rs
@@ -12,14 +12,12 @@ pub const METRIC_SERVER_ID_SCHEMA: Schema = StringSchema::new("Metrics Server ID
     .schema();
 
 pub const INFLUXDB_BUCKET_SCHEMA: Schema = StringSchema::new("InfluxDB Bucket.")
-    .format(&PROXMOX_SAFE_ID_FORMAT)
     .min_length(3)
     .max_length(32)
     .default("proxmox")
     .schema();
 
 pub const INFLUXDB_ORGANIZATION_SCHEMA: Schema = StringSchema::new("InfluxDB Organization.")
-    .format(&PROXMOX_SAFE_ID_FORMAT)
     .min_length(3)
     .max_length(32)
     .default("proxmox")
@@ -129,13 +127,14 @@ pub struct InfluxDbHttp {
     pub enable: bool,
     /// The base url of the influxdb server
     pub url: String,
-    /// The Optional Token
     #[serde(skip_serializing_if = "Option::is_none")]
     /// The (optional) API token
     pub token: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
+    /// Named location where time series data is stored
     pub bucket: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
+    /// Workspace for a group of users
     pub organization: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
     /// The (optional) maximum body size
-- 
2.43.0



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

Re: [pbs-devel] [PATCH proxmox-backup v2] api-types: remove influxdb bucket name restrictions

[Fabian Grünbichler]

On April 22, 2024 9:59 am, Gabriel Goller wrote:
> Remove the regex for influxdb organizations and buckets. Influxdb does
> not place any constraints on these names and allows all characters. This
> allows influxdb organization names with slashes.

these are passed as-is into the URI, and there are characters not
allowed in queries (without encoding), so either these restrictions need
to be added here, or proxmox-metrics needs to learn to encode them ;)

> 
> Also remove a duplicate comment and add some missing ones.
> 
> This also aligns the behavior to PVE as there are no restrictions there
> either.
> 
> The motivation for this patch is this forum post:
> https://forum.proxmox.com/threads/influx-db-organization-doesnt-allow-slash.145402/
> 
> Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
> ---
>  pbs-api-types/src/metrics.rs | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/pbs-api-types/src/metrics.rs b/pbs-api-types/src/metrics.rs
> index 6800c23b..23421035 100644
> --- a/pbs-api-types/src/metrics.rs
> +++ b/pbs-api-types/src/metrics.rs
> @@ -12,14 +12,12 @@ pub const METRIC_SERVER_ID_SCHEMA: Schema = StringSchema::new("Metrics Server ID
>      .schema();
>  
>  pub const INFLUXDB_BUCKET_SCHEMA: Schema = StringSchema::new("InfluxDB Bucket.")
> -    .format(&PROXMOX_SAFE_ID_FORMAT)
>      .min_length(3)
>      .max_length(32)
>      .default("proxmox")
>      .schema();
>  
>  pub const INFLUXDB_ORGANIZATION_SCHEMA: Schema = StringSchema::new("InfluxDB Organization.")
> -    .format(&PROXMOX_SAFE_ID_FORMAT)
>      .min_length(3)
>      .max_length(32)
>      .default("proxmox")
> @@ -129,13 +127,14 @@ pub struct InfluxDbHttp {
>      pub enable: bool,
>      /// The base url of the influxdb server
>      pub url: String,
> -    /// The Optional Token
>      #[serde(skip_serializing_if = "Option::is_none")]
>      /// The (optional) API token
>      pub token: Option<String>,
>      #[serde(skip_serializing_if = "Option::is_none")]
> +    /// Named location where time series data is stored
>      pub bucket: Option<String>,
>      #[serde(skip_serializing_if = "Option::is_none")]
> +    /// Workspace for a group of users
>      pub organization: Option<String>,
>      #[serde(skip_serializing_if = "Option::is_none")]
>      /// The (optional) maximum body size
> -- 
> 2.43.0
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
> 


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

Re: [pbs-devel] [PATCH proxmox-backup v2] api-types: remove influxdb bucket name restrictions

[Gabriel Goller]

On Mon Apr 22, 2024 at 1:57 PM CEST, Fabian Grünbichler wrote:
> On April 22, 2024 9:59 am, Gabriel Goller wrote:
> > Remove the regex for influxdb organizations and buckets. Influxdb does
> > not place any constraints on these names and allows all characters. This
> > allows influxdb organization names with slashes.
>
> these are passed as-is into the URI, and there are characters not
> allowed in queries (without encoding), so either these restrictions need
> to be added here, or proxmox-metrics needs to learn to encode them ;)

Good point!
Submitted a v3.


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