---
title: Machine APIs
---

# Machine APIs {#machine-apis}

## ContainerRuntimeConfig \[machineconfiguration.openshift.io/v1\] {#_containerruntimeconfig_machineconfigurationopenshiftiov1}

Description
:   ContainerRuntimeConfig describes a customized Container Runtime configuration.

    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## ControllerConfig \[machineconfiguration.openshift.io/v1\] {#_controllerconfig_machineconfigurationopenshiftiov1}

Description
:   ControllerConfig describes configuration for MachineConfigController. This is currently only used to drive the MachineConfig objects generated by the TemplateController.

    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## ControlPlaneMachineSet \[machine.openshift.io/v1\] {#_controlplanemachineset_machineopenshiftiov1}

Description
:   ControlPlaneMachineSet ensures that a specified number of control plane machine replicas are running at any given time. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## KubeletConfig \[machineconfiguration.openshift.io/v1\] {#_kubeletconfig_machineconfigurationopenshiftiov1}

Description
:   KubeletConfig describes a customized Kubelet configuration.

    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineConfig \[machineconfiguration.openshift.io/v1\] {#_machineconfig_machineconfigurationopenshiftiov1}

Description
:   MachineConfig defines the configuration for a machine

    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineConfigPool \[machineconfiguration.openshift.io/v1\] {#_machineconfigpool_machineconfigurationopenshiftiov1}

Description
:   MachineConfigPool describes a pool of MachineConfigs.

    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineHealthCheck \[machine.openshift.io/v1beta1\] {#_machinehealthcheck_machineopenshiftiov1beta1}

Description
:   MachineHealthCheck is the Schema for the machinehealthchecks API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## Machine \[machine.openshift.io/v1beta1\] {#_machine_machineopenshiftiov1beta1}

Description
:   Machine is the Schema for the machines API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineSet \[machine.openshift.io/v1beta1\] {#_machineset_machineopenshiftiov1beta1}

Description
:   MachineSet ensures that a specified number of machines replicas are running at any given time. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineConfigNode \[machineconfiguration.openshift.io/v1\] {#_machineconfignode_machineconfigurationopenshiftiov1}

Description
:   MachineConfigNode describes the health of the Machines on the system Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineOSBuild \[machineconfiguration.openshift.io/v1\] {#_machineosbuild_machineconfigurationopenshiftiov1}

Description
:   MachineOSBuild describes a build process managed and deployed by the MCO Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## MachineOSConfig \[machineconfiguration.openshift.io/v1\] {#_machineosconfig_machineconfigurationopenshiftiov1}

Description
:   MachineOSConfig describes the configuration for a build process managed by the MCO Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```

## PinnedImageSet \[machineconfiguration.openshift.io/v1\] {#_pinnedimageset_machineconfigurationopenshiftiov1}

Description
:   PinnedImageSet describes a set of images that should be pinned by CRI-O and pulled to the nodes which are members of the declared MachineConfigPools.

    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type
:   ```
    `object`
    ```