palette-sdk-typescript/dist/schemas/vmProbe.d.ts

TypeScript SDK for Spectro Cloud Palette API

/**
 * Copyright (c) Spectro Cloud
 * SPDX-License-Identifier: Apache-2.0
 */
/**
 * Generated by orval v7.17.0 🍺
 * Do not edit manually.
 * Palette APIs - 4.8
 * OpenAPI spec version: v1
 */
import type { VmExecAction } from './vmExecAction';
import type { VmGuestAgentPing } from './vmGuestAgentPing';
import type { VmHttpGetAction } from './vmHttpGetAction';
import type { VmTcpSocketAction } from './vmTcpSocketAction';
/**
 * Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic.
 */
export type VmProbe = {
    exec?: VmExecAction;
    /** Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. */
    failureThreshold?: number;
    guestAgentPing?: VmGuestAgentPing;
    httpGet?: VmHttpGetAction;
    /** Number of seconds after the VirtualMachineInstance has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
    initialDelaySeconds?: number;
    /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. */
    periodSeconds?: number;
    /** Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. */
    successThreshold?: number;
    tcpSocket?: VmTcpSocketAction;
    /** Number of seconds after which the probe times out. For exec probes the timeout fails the probe but does not terminate the command running on the guest. This means a blocking command can result in an increasing load on the guest. A small buffer will be added to the resulting workload exec probe to compensate for delays caused by the qemu guest exec mechanism. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */
    timeoutSeconds?: number;
};
//# sourceMappingURL=vmProbe.d.ts.map