Skip to main content

vantage_sdk.workbench.configuration_preset

SDK helpers + mirror models for configuration presets.

Classes​

ConfigurationPresetSDK()​

SDK for the /configuration-preset CRUD (all kinds).

Methods​

  • create(self, ctx: 'typer.Context', *, cluster_name: 'str', preset: 'dict | BaseModel') -> 'ClusterServiceResponse': Create a configuration preset.
  • delete(self, ctx: 'typer.Context', *, cluster_name: 'str', kind: 'str', name: 'str') -> 'ClusterServiceResponse': Delete a configuration preset (idempotent server-side).
  • get(self, ctx: 'typer.Context', *, cluster_name: 'str', kind: 'str', name: 'str') -> 'ClusterServiceResponse': Get a single configuration preset by kind + name.
  • list(self, ctx: 'typer.Context', *, cluster_name: 'str', kind: 'str | None' = None) -> 'ClusterServiceResponse': List configuration presets, optionally scoped to one kind.
  • normalize_kind(kind: 'str') -> 'str': Lowercase and validate a kind against CONFIGURATION_PRESET_KINDS.
  • resolve(self, ctx: 'typer.Context', *, cluster_name: 'str', kind: 'str', name: 'str', size_preset: 'str | None' = None, overrides: 'dict | None' = None) -> 'ClusterServiceResponse': Preview the effective configuration a workload create would resolve to.
  • update(self, ctx: 'typer.Context', *, cluster_name: 'str', kind: 'str', name: 'str', preset: 'dict | BaseModel') -> 'ClusterServiceResponse': Full replace of an existing configuration preset (PUT).

UserServiceConfigurationOptions(*, image: str | None = None, resolution: str | None = None, slurm_cluster: str | None = None, size_preset: str | None = None, extra_labels: dict[str, str] = <factory>) -> None​

Loose mirror of the per-workload user-service configuration options.

UserServiceConfigurationPreset(*, kind: str, name: str, description: str | None = None, labels: dict[str, str] = <factory>, hidden: bool = False, created_by: str | None = None, options: vantage_sdk.workbench.configuration_preset.UserServiceConfigurationOptions = <factory>) -> None​

Mirror of a user-service configuration preset (kind == workload).