From 29e852a7311423a7dcc90d6e50c118aeb6886bc5 Mon Sep 17 00:00:00 2001
From: Mike Splain <mike.splain@gmail.com>
Date: Tue, 31 Jul 2018 08:55:01 -0400
Subject: [PATCH] Add readme

---
 hack/machine_types/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 hack/machine_types/README.md

diff --git a/hack/machine_types/README.md b/hack/machine_types/README.md
new file mode 100644
index 0000000000..9d9e5ddebb
--- /dev/null
+++ b/hack/machine_types/README.md
@@ -0,0 +1,19 @@
+Machine Types Generator
+=======================
+
+To prevent errors or lagging updates, we use this generator to update the known aws machine types
+that are [hard coded in kops](https://github.com/kubernetes/kops/blob/7d7112c1e9a52d4f677db6bd98943d308ec9f581/upup/pkg/fi/cloudup/awsup/machine_types.go#L76).
+
+This generator uses the AWS Pricing API to get most of it's info on what instance types are supported.
+
+Usage
+-----
+```
+make update-machine-types
+git add .
+git commit -am "Updated machine types"
+```
+
+TODO:
+-----
+* Cross reference other regions besides us-east-1.  Currently we just look at one region to determine instance types.