@codingame/kubevirt-api
Version:
kubevirt OpenAPI automation for TypeScript
77 lines (76 loc) • 2.99 kB
TypeScript
/**
* KubeVirt API
* This is KubeVirt API an add-on for Kubernetes.
*
* The version of the OpenAPI document: 1.0.0
* Contact: kubevirt-dev@googlegroups.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { K8sIoApiCoreV1ExecAction, K8sIoApiCoreV1HTTPGetAction, K8sIoApiCoreV1TCPSocketAction } from './';
/**
* Probe describes a health check to be performed against a VirtualMachineInstance to determine whether it is alive or ready to receive traffic.
* @export
* @interface V1Probe
*/
export interface V1Probe {
/**
*
* @type {K8sIoApiCoreV1ExecAction}
* @memberof V1Probe
*/
exec?: K8sIoApiCoreV1ExecAction;
/**
* Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
* @type {number}
* @memberof V1Probe
*/
failureThreshold?: number;
/**
* GuestAgentPing configures the guest-agent based ping probe
* @type {object}
* @memberof V1Probe
*/
guestAgentPing?: object;
/**
*
* @type {K8sIoApiCoreV1HTTPGetAction}
* @memberof V1Probe
*/
httpGet?: K8sIoApiCoreV1HTTPGetAction;
/**
* 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
* @type {number}
* @memberof V1Probe
*/
initialDelaySeconds?: number;
/**
* How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
* @type {number}
* @memberof V1Probe
*/
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.
* @type {number}
* @memberof V1Probe
*/
successThreshold?: number;
/**
*
* @type {K8sIoApiCoreV1TCPSocketAction}
* @memberof V1Probe
*/
tcpSocket?: K8sIoApiCoreV1TCPSocketAction;
/**
* 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
* @type {number}
* @memberof V1Probe
*/
timeoutSeconds?: number;
}
export declare function V1ProbeFromJSON(json: any): V1Probe;
export declare function V1ProbeFromJSONTyped(json: any, _ignoreDiscriminator: boolean): V1Probe;
export declare function V1ProbeToJSON(value?: V1Probe | null): any;