Skip to content
Switch branches/tags


Failed to load latest commit information.
Latest commit message
Commit time
Jul 19, 2018

Machine API Operator

The Machine API Operator manages the lifecycle of specific purpose CRDs, controllers and RBAC objects that extend the Kubernetes API. This allows to convey desired state of machines in a cluster in a declarative fashion.

See for more details.

Have a question? See our Frequently Asked Questions for common inquiries.


Machine API Operator overview


  • MachineSet
  • Machine
  • MachineHealthCheck


  • MachineSet Controller

Ensure presence of expected number of replicas and a given provider config for a set of machines.

Ensure that a provider instance is created for a Machine object in a given provider.

  • Node link Controller

Ensure machines have a nodeRef based on IPs or providerID matching. Annotate nodes with a label containing the machine name.

  • Machine healthcheck controller

Ensure machines targeted by MachineHealthCheck objects satisfy a healthiness criteria or are remediated otherwise.

Creating machines

You can create a new machine by applying a manifest representing an instance of the machine CRD

The label will be used by the controllers to lookup for the right cloud instance.

You can set other labels to provide a convenient way for users and consumers to retrieve groups of machines: worker worker


  • Generate code (if needed):

    $ make generate
  • Build:

    $ make build
  • Run:

    $ ./bin/machine-api-operator start --kubeconfig ${HOME}/.kube/config --images-json=pkg/operator/fixtures/images.json
  • Image:

    $ make image

The Machine API Operator is designed to work in conjunction with the Cluster Version Operator. You can see it in action by running an OpenShift Cluster deployed by the Installer.

However you can run it in a vanilla Kubernetes cluster by precreating some assets:

For more information see hacking-guide.

Machine API operator with Kubemark over Kubernetes

INFO: For development and testing purposes only

  1. Deploy MAO over Kubernetes:
 $ kustomize build | kubectl apply -f -
  1. Deploy Kubemark actuator prerequisities:

    $ kustomize build config | kubectl apply -f -
  2. Create cluster to tell the MAO to deploy kubemark provider:

    kind: CustomResourceDefinition
        kind: Infrastructure
        listKind: InfrastructureList
        plural: infrastructures
        singular: infrastructure
      scope: Cluster
      - name: v1
        served: true
    storage: true
    kind: Infrastructure
      name: cluster
      platform: kubemark

    The file is already present under config/kubemark-config-infra.yaml so it's sufficient to run:

    $ kubectl apply -f config/kubemark-config-infra.yaml

OpenShift Bugzilla

The Bugzilla product for this repository is "Cloud Compute" under OpenShift Container Platform.

CI & tests

Run unit test:

$ make test

Run e2e-aws-operator tests. This tests assume that a cluster deployed by the Installer is up and running and a KUBECONFIG environment variable is set:

$ make test-e2e

Tests are located under machine-api-operator repository and executed in prow CI system. A link to failing tests is published as a comment in PR by @openshift-ci-robot. Current test status for all OpenShift components can be found in

CI configuration is stored under openshift/release repository and is split into 4 files:

More information about those files can be found in ci-operator onboarding file.