@canonical/jujulib/dist/api/facades/caasunit-provisioner/CAASUnitProvisionerV1.d.ts

Juju API client

/**
  Juju CAASUnitProvisioner version 1.
  This facade is available on:
    Controller-machine-agent
    Machine-agent
    Unit-agent
    Models

  NOTE: This file was generated using the Juju schema
  from Juju 2.8.2 at the git SHA 516c1904ce.
  Do not manually edit this file.
*/
import { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
export interface Address {
    scope: string;
    "space-id"?: string;
    "space-name"?: string;
    type: string;
    value: string;
}
export interface ApplicationGetConfigResults {
    Results: ConfigResult[];
}
export interface ApplicationUnitInfo {
    "provider-id": string;
    "unit-tag": string;
}
export interface ApplicationUnitParams {
    address: string;
    data?: AdditionalProperties;
    "filesystem-info"?: KubernetesFilesystemInfo[];
    info: string;
    ports: string[];
    "provider-id": string;
    stateful?: boolean;
    status: string;
    "unit-tag": string;
}
export interface ConfigResult {
    config: AdditionalProperties;
    error?: Error;
}
export interface Entities {
    entities: Entity[];
}
export interface Entity {
    tag: string;
}
export interface EntityStatus {
    data?: AdditionalProperties;
    info: string;
    since: string;
    status: string;
}
export interface EntityStatusArgs {
    data: AdditionalProperties;
    info: string;
    status: string;
    tag: string;
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface ErrorResult {
    error?: Error;
}
export interface ErrorResults {
    results: ErrorResult[];
}
export interface IntResult {
    error?: Error;
    result: number;
}
export interface IntResults {
    results: IntResult[];
}
export interface KubernetesDeploymentInfo {
    "deployment-type": string;
    "service-type": string;
}
export interface KubernetesDeviceParams {
    Attributes: Record<string, string>;
    Count: number;
    Type: string;
}
export interface KubernetesFilesystemAttachmentParams {
    "mount-point"?: string;
    provider: string;
    "read-only"?: boolean;
}
export interface KubernetesFilesystemInfo {
    data?: AdditionalProperties;
    "filesystem-id": string;
    info: string;
    "mount-point"?: string;
    pool: string;
    "read-only"?: boolean;
    size: number;
    status: string;
    storagename: string;
    volume: KubernetesVolumeInfo;
}
export interface KubernetesFilesystemParams {
    attachment?: KubernetesFilesystemAttachmentParams;
    attributes?: AdditionalProperties;
    provider: string;
    size: number;
    storagename: string;
    tags?: Record<string, string>;
}
export interface KubernetesProvisioningInfo {
    "charm-modified-version"?: number;
    constraints: Value;
    "deployment-info"?: KubernetesDeploymentInfo;
    devices?: KubernetesDeviceParams[];
    filesystems?: KubernetesFilesystemParams[];
    "operator-image-path"?: string;
    "pod-spec": string;
    "raw-k8s-spec"?: string;
    tags?: Record<string, string>;
    volumes?: KubernetesVolumeParams[];
}
export interface KubernetesProvisioningInfoResult {
    error?: Error;
    result: KubernetesProvisioningInfo;
}
export interface KubernetesProvisioningInfoResults {
    results: KubernetesProvisioningInfoResult[];
}
export interface KubernetesVolumeAttachmentParams {
    provider: string;
    "read-only"?: boolean;
}
export interface KubernetesVolumeInfo {
    data?: AdditionalProperties;
    info: string;
    persistent: boolean;
    pool?: string;
    size: number;
    status: string;
    "volume-id": string;
}
export interface KubernetesVolumeParams {
    attachment?: KubernetesVolumeAttachmentParams;
    attributes?: AdditionalProperties;
    provider: string;
    size: number;
    storagename: string;
    tags?: Record<string, string>;
}
export interface LifeResult {
    error?: Error;
    life: string;
}
export interface LifeResults {
    results: LifeResult[];
}
export interface NotifyWatchResult {
    NotifyWatcherId: string;
    error?: Error;
}
export interface NotifyWatchResults {
    results: NotifyWatchResult[];
}
export interface SetStatus {
    entities: EntityStatusArgs[];
}
export interface StringResult {
    error?: Error;
    result: string;
}
export interface StringResults {
    results: StringResult[];
}
export interface StringsWatchResult {
    changes?: string[];
    error?: Error;
    "watcher-id": string;
}
export interface UpdateApplicationServiceArg {
    addresses: Address[];
    "application-tag": string;
    generation?: number;
    "provider-id": string;
    scale?: number;
}
export interface UpdateApplicationServiceArgs {
    args: UpdateApplicationServiceArg[];
}
export interface UpdateApplicationUnitArgs {
    args: UpdateApplicationUnits[];
}
export interface UpdateApplicationUnitResult {
    error?: Error;
    info?: UpdateApplicationUnitsInfo;
}
export interface UpdateApplicationUnitResults {
    results: UpdateApplicationUnitResult[];
}
export interface UpdateApplicationUnits {
    "application-tag": string;
    generation?: number;
    scale?: number;
    status?: EntityStatus;
    units: ApplicationUnitParams[];
}
export interface UpdateApplicationUnitsInfo {
    units: ApplicationUnitInfo[];
}
export interface Value {
    arch?: string;
    container?: string;
    cores?: number;
    "cpu-power"?: number;
    "instance-type"?: string;
    mem?: number;
    "root-disk"?: number;
    "root-disk-source"?: string;
    spaces?: string[];
    tags?: string[];
    "virt-type"?: string;
    zones?: string[];
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**

*/
declare class CAASUnitProvisionerV1 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      ApplicationsConfig returns the config for the specified applications.
    */
    applicationsConfig(params: Entities): Promise<ApplicationGetConfigResults>;
    /**
      ApplicationsScale returns the scaling info for specified applications in this model.
    */
    applicationsScale(params: Entities): Promise<IntResults>;
    /**
      ClearApplicationsResources clears the flags which indicate
      applications still have resources in the cluster.
    */
    clearApplicationsResources(params: Entities): Promise<ErrorResults>;
    /**
      DeploymentMode returns the deployment mode of the given applications' charms.
    */
    deploymentMode(params: Entities): Promise<StringResults>;
    /**
      Life returns the life status of every supplied entity, where available.
    */
    life(params: Entities): Promise<LifeResults>;
    /**
      ProvisioningInfo returns the provisioning info for specified applications in this model.
    */
    provisioningInfo(params: Entities): Promise<KubernetesProvisioningInfoResults>;
    /**
      SetOperatorStatus updates the operator status for each given application.
    */
    setOperatorStatus(params: SetStatus): Promise<ErrorResults>;
    /**
      UpdateApplicationsService updates the Juju data model to reflect the given
      service details of the specified application.
    */
    updateApplicationsService(params: UpdateApplicationServiceArgs): Promise<ErrorResults>;
    /**
      UpdateApplicationsUnits updates the Juju data model to reflect the given
      units of the specified application.
    */
    updateApplicationsUnits(params: UpdateApplicationUnitArgs): Promise<UpdateApplicationUnitResults>;
    /**
      WatchApplications starts a StringsWatcher to watch CAAS applications
      deployed to this model.
    */
    watchApplications(params: any): Promise<StringsWatchResult>;
    /**
      WatchApplicationsScale starts a NotifyWatcher to watch changes
      to the applications' scale.
    */
    watchApplicationsScale(params: Entities): Promise<NotifyWatchResults>;
    /**
      WatchPodSpec starts a NotifyWatcher to watch changes to the
      pod spec for specified units in this model.
    */
    watchPodSpec(params: Entities): Promise<NotifyWatchResults>;
}
export default CAASUnitProvisionerV1;