@datatr-ux/ovhcloud-types 1.0.3 → 1.0.4

package/package/dist/cloud/project/ai/app/AppSpecInput.d.ts

@@ -0,0 +1,43 @@
+import { DeploymentStrategy } from './DeploymentStrategy';
+import { JobEnv } from '../job/JobEnv';
+import { ProbeInput } from './ProbeInput';
+import { ResourcesInput } from '../ResourcesInput';
+import { ScalingStrategyInput } from './ScalingStrategyInput';
+import { Volume } from '../volume/Volume';
+/** AI Solutions App Spec Object to create a app */
+export interface AppSpecInput {
+    /** App command */
+    command?: string[];
+    /** Default port to access http service inside the app */
+    defaultHttpPort?: number;
+    /** AI App deployment strategy */
+    deploymentStrategy?: DeploymentStrategy;
+    /** List of environment variable to be set inside the app */
+    envVars?: JobEnv[];
+    /** GRPC Port that we want to expose in case workload HTTP & gRPC servers cannot be multiplexed to listen on the same port */
+    grpcPort?: number;
+    /** Docker or capability image to use in the app. App capability images must comply with the pattern 'image-id:version' */
+    image: string;
+    /** Labels are used to scope tokens, labels prefixed by 'ovh/' are owned by the platform and overridden */
+    labels?: {
+        [key: string]: string;
+    };
+    /** App liveness probe */
+    livenessProbe?: ProbeInput;
+    /** App name */
+    name: string;
+    /** Partner ID */
+    partnerId?: string;
+    /** App readiness probe */
+    probe?: ProbeInput;
+    /** Host region of the app */
+    region: string;
+    /** App resources */
+    resources: ResourcesInput;
+    /** App scaling strategy */
+    scalingStrategy?: ScalingStrategyInput;
+    /** Whether if app api port can be accessed without any authentication token */
+    unsecureHttp?: boolean;
+    /** App Data linked */
+    volumes?: Volume[];
+}

package/package/dist/cloud/project/ai/app/AppStateEnum.d.ts

@@ -0,0 +1,13 @@
+/** State of the application */
+export declare enum AppStateEnum {
+    "DELETED" = "DELETED",
+    "DELETING" = "DELETING",
+    "ERROR" = "ERROR",
+    "FAILED" = "FAILED",
+    "INITIALIZING" = "INITIALIZING",
+    "QUEUED" = "QUEUED",
+    "RUNNING" = "RUNNING",
+    "SCALING" = "SCALING",
+    "STOPPED" = "STOPPED",
+    "STOPPING" = "STOPPING"
+}

package/package/dist/cloud/project/ai/app/AppStateHistory.d.ts

@@ -0,0 +1,8 @@
+import { AppStateEnum } from './AppStateEnum';
+/** AI Solutions App State History Object */
+export interface AppStateHistory {
+    /** Date when the status occurred */
+    date: string;
+    /** State of the app */
+    state: AppStateEnum;
+}

package/package/dist/cloud/project/ai/app/AppStatus.d.ts

@@ -0,0 +1,33 @@
+import { DataSync } from '../volume/DataSync';
+import { AppStateHistory } from './AppStateHistory';
+import { Info } from '../Info';
+import { Ip } from '../../../../Ip';
+import { AppStateEnum } from './AppStateEnum';
+import { VolumeStatus } from '../volume/VolumeStatus';
+/** AI Solutions App Status Object */
+export interface AppStatus {
+    /** Number of available replicas */
+    availableReplicas: number;
+    /** Status about the datasync linked to the app */
+    dataSync: DataSync[];
+    /** Address to reach when you want to access the App's gRPC services */
+    grpcAddress?: string;
+    /** Job state history */
+    history: AppStateHistory[];
+    /** Information about the app */
+    info: Info;
+    /** App info url */
+    infoUrl?: string;
+    /** Internal IP address of the app service */
+    internalServiceIp?: Ip;
+    /** Date of the last app state change */
+    lastTransitionDate?: string;
+    /** App resource usage url */
+    monitoringUrl?: string;
+    /** State of the app */
+    state?: AppStateEnum;
+    /** App access url */
+    url?: string;
+    /** App Data linked */
+    volumes?: VolumeStatus[];
+}

package/package/dist/cloud/project/ai/app/DeploymentStrategy.d.ts

@@ -0,0 +1,9 @@
+/** AI Solutions AI App deployment strategy object */
+export interface DeploymentStrategy {
+    /** Maximum number of replicas that can be created over the desired number of Pods (can be expressed as a percentage of the desired pods, suffixed with '%') */
+    maxSurge?: string;
+    /** Maximum number of replicas that can be unavailable during the update process (can be expressed as a percentage of the desired pods, suffixed with '%') */
+    maxUnavailable?: string;
+    /** Number of seconds you want to wait for your Deployment to progress before the system reports back that the Deployment has failed progressing */
+    progressDeadlineSeconds?: number;
+}

package/package/dist/cloud/project/ai/app/Probe.d.ts

@@ -0,0 +1,17 @@
+/** AI Solutions App Probe Object */
+export interface Probe {
+    /** Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. */
+    failureThreshold?: number;
+    /** Number of seconds after the container has started before liveness probes are initiated. */
+    initialDelaySeconds?: number;
+    /** Path to access to check for readiness */
+    path?: string;
+    /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. */
+    periodSeconds?: number;
+    /** Port to access to check for readiness */
+    port?: number;
+    /** Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. */
+    successThreshold?: number;
+    /** Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. */
+    timeoutSeconds?: number;
+}

package/package/dist/cloud/project/ai/app/ProbeInput.d.ts

@@ -0,0 +1,17 @@
+/** AI Solutions App Probe Object */
+export interface ProbeInput {
+    /** Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. */
+    failureThreshold?: number;
+    /** Number of seconds after the container has started before liveness probes are initiated. */
+    initialDelaySeconds?: number;
+    /** Path to access to check for readiness */
+    path?: string;
+    /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. */
+    periodSeconds?: number;
+    /** Port to access to check for readiness */
+    port?: number;
+    /** Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. */
+    successThreshold?: number;
+    /** Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. */
+    timeoutSeconds?: number;
+}

package/package/dist/cloud/project/ai/app/ScalingAutomaticStrategy.d.ts

@@ -0,0 +1,12 @@
+import { ScalingAutomaticStrategyResourceTypeEnum } from './ScalingAutomaticStrategyResourceTypeEnum';
+/** AI Solutions App automatic scaling strategy object */
+export interface ScalingAutomaticStrategy {
+    /** The average resource usage threshold that the app upscale or downscale will be triggered from, in percent */
+    averageUsageTarget: number;
+    /** Maximum number of replicas */
+    replicasMax: number;
+    /** Minimum number of replicas */
+    replicasMin: number;
+    /** Type of the resource to base the automatic scaling on */
+    resourceType: ScalingAutomaticStrategyResourceTypeEnum;
+}

package/package/dist/cloud/project/ai/app/ScalingAutomaticStrategyInput.d.ts

@@ -0,0 +1,12 @@
+import { ScalingAutomaticStrategyResourceTypeEnum } from './ScalingAutomaticStrategyResourceTypeEnum';
+/** AI Solutions App automatic scaling strategy object */
+export interface ScalingAutomaticStrategyInput {
+    /** The average resource usage threshold that the app upscale or downscale will be triggered from, in percent */
+    averageUsageTarget: number;
+    /** Maximum number of replicas */
+    replicasMax: number;
+    /** Minimum number of replicas */
+    replicasMin: number;
+    /** Type of the resource to base the automatic scaling on */
+    resourceType: ScalingAutomaticStrategyResourceTypeEnum;
+}

package/package/dist/cloud/project/ai/app/ScalingAutomaticStrategyResourceTypeEnum.d.ts

@@ -0,0 +1,5 @@
+/** Resource type for App automatic scaling strategy */
+export declare enum ScalingAutomaticStrategyResourceTypeEnum {
+    "CPU" = "CPU",
+    "RAM" = "RAM"
+}

package/package/dist/cloud/project/ai/app/ScalingFixedStrategy.d.ts

@@ -0,0 +1,5 @@
+/** AI Solutions App Status Object */
+export interface ScalingFixedStrategy {
+    /** Number of wanted replicas */
+    replicas: number;
+}

package/package/dist/cloud/project/ai/app/ScalingFixedStrategyInput.d.ts

@@ -0,0 +1,5 @@
+/** AI Solutions App Status Object */
+export interface ScalingFixedStrategyInput {
+    /** Number of wanted replicas */
+    replicas: number;
+}

package/package/dist/cloud/project/ai/app/ScalingStrategy.d.ts

@@ -0,0 +1,9 @@
+import { ScalingAutomaticStrategy } from './ScalingAutomaticStrategy';
+import { ScalingFixedStrategy } from './ScalingFixedStrategy';
+/** AI Solutions App Status Object */
+export interface ScalingStrategy {
+    /** Strategy setting a variable number of replicas, based on an average resource usage threshold */
+    automatic?: ScalingAutomaticStrategy;
+    /** Strategy setting a fix number of replicas */
+    fixed?: ScalingFixedStrategy;
+}

package/package/dist/cloud/project/ai/app/ScalingStrategyInput.d.ts

@@ -0,0 +1,9 @@
+import { ScalingAutomaticStrategyInput } from './ScalingAutomaticStrategyInput';
+import { ScalingFixedStrategyInput } from './ScalingFixedStrategyInput';
+/** AI Solutions App Status Object */
+export interface ScalingStrategyInput {
+    /** Strategy setting a variable number of replicas, based on an average resource usage threshold (conflicts with 'fixed' property when both are not null) */
+    automatic?: ScalingAutomaticStrategyInput;
+    /** Strategy setting a fix number of replicas (conflicts with 'automatic' property when both are not null) */
+    fixed?: ScalingFixedStrategyInput;
+}

package/package/dist/cloud/project/ai/app/UpdateInput.d.ts

@@ -0,0 +1,23 @@
+import { DeploymentStrategy } from './DeploymentStrategy';
+import { Env } from '../Env';
+/** AI Solutions AI App update object */
+export interface UpdateInput {
+    /** App command and arguments */
+    command?: string[];
+    /** Number of CPU resources requested (applies to CPU flavors) */
+    cpu?: number;
+    /** Default port to access http service inside the app */
+    defaultHttpPort?: number;
+    /** Deployment strategy to use when updating this AI App */
+    deploymentStrategy?: DeploymentStrategy;
+    /** Environment variables to be patched (empty/null value to remove) */
+    envVars?: Env[];
+    /** App instance flavor */
+    flavor?: string;
+    /** Number of GPU resources requested (applies to GPU flavors) */
+    gpu?: number;
+    /** GRPC Port that we want to expose in case workload HTTP & gRPC servers cannot be multiplexed to listen on the same port */
+    grpcPort?: number;
+    /** URL of the Docker image for this AI deployment */
+    url?: string;
+}

package/package/dist/cloud/project/ai/app/index.d.ts

@@ -0,0 +1,18 @@
+export * from './App';
+export * from './AppImageInput';
+export * from './AppSpec';
+export * from './AppSpecInput';
+export * from './AppStateEnum';
+export * from './AppStateHistory';
+export * from './AppStatus';
+export * from './DeploymentStrategy';
+export * from './Probe';
+export * from './ProbeInput';
+export * from './ScalingAutomaticStrategy';
+export * from './ScalingAutomaticStrategyInput';
+export * from './ScalingAutomaticStrategyResourceTypeEnum';
+export * from './ScalingFixedStrategy';
+export * from './ScalingFixedStrategyInput';
+export * from './ScalingStrategy';
+export * from './ScalingStrategyInput';
+export * from './UpdateInput';

package/package/dist/cloud/project/ai/capabilities/Features.d.ts

@@ -0,0 +1,7 @@
+/** AI Solutions Features */
+export interface Features {
+    /** Inform if the AI Solutions is in Lab mode or not */
+    lab: boolean;
+    /** Capability to add registry */
+    registry: boolean;
+}

package/package/dist/cloud/project/ai/capabilities/Flavor.d.ts

@@ -0,0 +1,20 @@
+import { GpuInformation } from './flavor/GpuInformation';
+import { ResourcesPerUnit } from './flavor/ResourcesPerUnit';
+import { FlavorTypeEnum } from './FlavorTypeEnum';
+/** AI Solutions Flavor */
+export interface Flavor {
+    /** Is the flavor the default one for a flavor type */
+    default: boolean;
+    /** Flavor description */
+    description: string;
+    /** Describe GPU information */
+    gpuInformation?: GpuInformation;
+    /** Flavor id */
+    id: string;
+    /** Maximum amount available for a job / notebook */
+    max: number;
+    /** Describe the amount of resources given per unit of the flavor */
+    resourcesPerUnit: ResourcesPerUnit;
+    /** Flavor type */
+    type: FlavorTypeEnum;
+}

package/package/dist/cloud/project/ai/capabilities/FlavorTypeEnum.d.ts

@@ -0,0 +1,5 @@
+/** Flavor Type */
+export declare enum FlavorTypeEnum {
+    "cpu" = "cpu",
+    "gpu" = "gpu"
+}

package/package/dist/cloud/project/ai/capabilities/LicensingTypeEnum.d.ts

@@ -0,0 +1,7 @@
+/** Licensing Type */
+export declare enum LicensingTypeEnum {
+    "per-app" = "per-app",
+    "per-replica" = "per-replica",
+    "per-resource" = "per-resource",
+    "per-second-bracket" = "per-second-bracket"
+}

package/package/dist/cloud/project/ai/capabilities/Preset.d.ts

@@ -0,0 +1,25 @@
+import { PresetCapabilities } from './PresetCapabilities';
+import { PresetDocumentationUrl } from './PresetDocumentationUrl';
+import { Partner } from '../job/Partner';
+import { PresetTypeEnum } from './PresetTypeEnum';
+/** AI Solutions Preset image */
+export interface Preset {
+    /** Preset capabilities */
+    capabilities: PresetCapabilities;
+    /** Preset description */
+    descriptions: string[];
+    /** URL toward the preset image documentation */
+    docUrl: PresetDocumentationUrl[];
+    /** Preset id */
+    id: string;
+    /** URL toward the logo to illustrate the preset */
+    logoUrl: string;
+    /** Preset name */
+    name: string;
+    /** Partner name */
+    partner: Partner;
+    /** Snippet example of the doc */
+    snippet: string;
+    /** Preset type */
+    type: PresetTypeEnum;
+}

package/package/dist/cloud/project/ai/capabilities/PresetCapabilities.d.ts

@@ -0,0 +1,17 @@
+import { FlavorTypeEnum } from './FlavorTypeEnum';
+import { PresetResources } from './PresetResources';
+/** AI Solutions Preset image enabled features */
+export interface PresetCapabilities {
+    /** Exec enabled */
+    exec: boolean;
+    /** Flavor types */
+    flavorTypes: FlavorTypeEnum[];
+    /** Log enabled */
+    log: boolean;
+    /** Resources requirements */
+    resources: PresetResources;
+    /** SSH enabled */
+    ssh: boolean;
+    /** Volume enabled */
+    volume: boolean;
+}

package/package/dist/cloud/project/ai/capabilities/PresetDocumentationUrl.d.ts

@@ -0,0 +1,7 @@
+/** AI Solutions Preset image */
+export interface PresetDocumentationUrl {
+    /** Documentation Name */
+    name: string;
+    /** Documentation URL */
+    url: string;
+}

package/package/dist/cloud/project/ai/capabilities/PresetResources.d.ts

@@ -0,0 +1,5 @@
+/** AI Solutions Preset resources requirements */
+export interface PresetResources {
+    /** Maximum number of GPUs supported */
+    maxGpu: number;
+}

package/package/dist/cloud/project/ai/capabilities/PresetTypeEnum.d.ts

@@ -0,0 +1,6 @@
+/** Preset Type */
+export declare enum PresetTypeEnum {
+    "app" = "app",
+    "job" = "job",
+    "notebook" = "notebook"
+}

package/package/dist/cloud/project/ai/capabilities/ProjectQuotas.d.ts

@@ -0,0 +1,9 @@
+/** AI Solutions Project Quotas */
+export interface ProjectQuotas {
+    /** Project's quotas per compute-type resource (e.g CPU/GPU) */
+    resources: {
+        [key: string]: number;
+    };
+    /** Storage quota (in bits) that is allocated to the project */
+    storage: number;
+}

package/package/dist/cloud/project/ai/capabilities/Region.d.ts

@@ -0,0 +1,13 @@
+/** AI Solutions Region */
+export interface Region {
+    /** Client Install Url */
+    cliInstallUrl: string;
+    /** Documentation Url */
+    documentationUrl: string;
+    /** Region id */
+    id: string;
+    /** Region Registry Url */
+    registryUrl: string;
+    /** Region version */
+    version: string;
+}

package/package/dist/cloud/project/ai/capabilities/app/Image.d.ts

@@ -0,0 +1,22 @@
+import { LicensingTypeEnum } from '../LicensingTypeEnum';
+/** AI Solutions App image object */
+export interface Image {
+    /** Short description of the image */
+    description: string;
+    /** URL of the image documentation */
+    docUrl: string;
+    /** Unique identifier of the image */
+    id: string;
+    /** Type of licensing */
+    licensing: LicensingTypeEnum;
+    /** URL of the logo of the image */
+    logoUrl: string;
+    /** Name of the image */
+    name: string;
+    /** ID of the partner providing the image */
+    partnerId: string;
+    /** Name of the partner providing the image */
+    partnerName: string;
+    /** List of available versions of this image */
+    versions: string[];
+}

package/package/dist/cloud/project/ai/capabilities/app/index.d.ts

@@ -0,0 +1 @@
+export * from './Image';

package/package/dist/cloud/project/ai/capabilities/flavor/GpuInformation.d.ts

@@ -0,0 +1,9 @@
+/** AI Solutions Global GPU information */
+export interface GpuInformation {
+    /** The GPU Brand */
+    gpuBrand: string;
+    /** The GPU Memory in bits */
+    gpuMemory: number;
+    /** The GPU Model */
+    gpuModel: string;
+}

package/package/dist/cloud/project/ai/capabilities/flavor/ResourcesPerUnit.d.ts

@@ -0,0 +1,13 @@
+/** AI Solutions Global Resource per flavor unit */
+export interface ResourcesPerUnit {
+    /** The amount of cpu for one unit of the flavor */
+    cpu: number;
+    /** The amount of ephemeral storage in bytes */
+    ephemeralStorage: number;
+    /** The amount of memory in bytes */
+    memory: number;
+    /** The guarantee private bandwidth in bytes per seconds */
+    privateNetwork: number;
+    /** The guarantee public bandwidth in bytes per seconds */
+    publicNetwork: number;
+}

package/package/dist/cloud/project/ai/capabilities/flavor/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GpuInformation';
+export * from './ResourcesPerUnit';

package/package/dist/cloud/project/ai/capabilities/index.d.ts

@@ -0,0 +1,19 @@
+import * as app from './app/index';
+import * as flavor from './flavor/index';
+import * as job from './job/index';
+import * as notebook from './notebook/index';
+export * from './Features';
+export * from './Flavor';
+export * from './FlavorTypeEnum';
+export * from './LicensingTypeEnum';
+export * from './Preset';
+export * from './PresetCapabilities';
+export * from './PresetDocumentationUrl';
+export * from './PresetResources';
+export * from './PresetTypeEnum';
+export * from './ProjectQuotas';
+export * from './Region';
+export { app };
+export { flavor };
+export { job };
+export { notebook };

package/package/dist/cloud/project/ai/capabilities/job/Image.d.ts

@@ -0,0 +1,15 @@
+/** AI Solutions Job image object */
+export interface Image {
+    /** Short description of the image */
+    description: string;
+    /** URL of the image documentation */
+    docUrl: string;
+    /** Unique identifier of the image */
+    id: string;
+    /** URL of the logo of the image */
+    logoUrl: string;
+    /** Name of the image */
+    name: string;
+    /** List of available versions of this image */
+    versions: string[];
+}

package/package/dist/cloud/project/ai/capabilities/job/index.d.ts

@@ -0,0 +1 @@
+export * from './Image';

package/package/dist/cloud/project/ai/capabilities/notebook/Editor.d.ts

@@ -0,0 +1,15 @@
+/** AI Solutions Notebook editor object */
+export interface Editor {
+    /** Short description of the editor */
+    description: string;
+    /** URL of the editor documentation */
+    docUrl: string;
+    /** Unique identifier of the editor */
+    id: string;
+    /** URL of the logo of the editor */
+    logoUrl: string;
+    /** Name of the editor */
+    name: string;
+    /** List of available versions of this editor */
+    versions: string[];
+}

package/package/dist/cloud/project/ai/capabilities/notebook/Framework.d.ts

@@ -0,0 +1,17 @@
+/** AI Solutions Notebook framework object */
+export interface Framework {
+    /** Short description of the framework */
+    description: string;
+    /** URL of the framework documentation */
+    docUrl: string;
+    /** Unique identifier of the framework */
+    id: string;
+    /** URL of the logo of the framework */
+    logoUrl: string;
+    /** Name of the framework */
+    name: string;
+    /** List of paths that are automatically saved */
+    savedPaths?: string[];
+    /** List of available versions of this framework */
+    versions: string[];
+}

package/package/dist/cloud/project/ai/capabilities/notebook/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Editor';
+export * from './Framework';

package/package/dist/cloud/project/ai/index.d.ts

@@ -0,0 +1,41 @@
+import * as app from './app/index';
+import * as capabilities from './capabilities/index';
+import * as job from './job/index';
+import * as notebook from './notebook/index';
+import * as partner from './partner/index';
+import * as registry from './registry/index';
+import * as token from './token/index';
+import * as volume from './volume/index';
+export * from './AuthorizationStatus';
+export * from './BasicAuthCredentialsInput';
+export * from './Command';
+export * from './DataStore';
+export * from './DataStoreAuth';
+export * from './DataStoreCredentialsInput';
+export * from './DataStoreInput';
+export * from './DataStoreOwnerEnum';
+export * from './DataStoreTypeEnum';
+export * from './Env';
+export * from './GenericResponse';
+export * from './GitCredentialsInput';
+export * from './Info';
+export * from './InfoCodeEnum';
+export * from './Label';
+export * from './LogLine';
+export * from './Logs';
+export * from './OrderEnum';
+export * from './Resources';
+export * from './ResourcesInput';
+export * from './S3CredentialsInput';
+export * from './ShutdownStrategyEnum';
+export * from './SshCredentialsInput';
+export * from './TokenRoleEnum';
+export * from './VolumePermissionEnum';
+export { app };
+export { capabilities };
+export { job };
+export { notebook };
+export { partner };
+export { registry };
+export { token };
+export { volume };

package/package/dist/cloud/project/ai/job/Job.d.ts

@@ -0,0 +1,17 @@
+import { JobSpec } from './JobSpec';
+import { JobStatus } from './JobStatus';
+/** AI Solutions Job Object */
+export interface Job {
+    /** Job creation date */
+    createdAt: string;
+    /** Job Id */
+    id: string;
+    /** Job specifications */
+    spec: JobSpec;
+    /** Job status */
+    status: JobStatus;
+    /** Job update date */
+    updatedAt: string;
+    /** Job user owner */
+    user: string;
+}

package/package/dist/cloud/project/ai/job/JobEnv.d.ts

@@ -0,0 +1,7 @@
+/** AI Solutions Job Env Object */
+export interface JobEnv {
+    /** Name of the environment variable to set inside the job */
+    name: string;
+    /** Value of the environment variable to set inside the job */
+    value: string;
+}