update documentation for seed data

3 files changed, 55 insertions, 0 deletions

diff --git a/doc/examples/seed/README b/doc/examples/seed/README
new file mode 100644
index 00000000..927768f8
--- /dev/null
+++ b/doc/examples/seed/README
@@ -0,0 +1,22 @@
+This directory is an example of a 'seed' directory.
+
+
+copying these files inside an instance's
+  /var/lib/cloud/data/cache/nocloud
+or
+  /var/lib/cloud/data/cache/nocloud-net
+
+will cause the 'DataSourceNoCloud' and 'DataSourceNoCloudNet' modules
+to enable and read the given data.
+
+The directory must have both files.
+
+- user-data:
+  This is the user data, as would be consumed from ec2's metadata service
+  see examples in doc/examples.
+- meta-data:
+  This file is yaml formated data similar to what is in the ec2 metadata
+  service under meta-data/.  See the example, or, on an ec2 instance,
+  run:
+     python -c 'import boto.utils, yaml; print(
+        yaml.dump(boto.utils.get_instance_metadata()))'
diff --git a/doc/examples/seed/meta-data b/doc/examples/seed/meta-data
new file mode 100644
index 00000000..d0551448
--- /dev/null
+++ b/doc/examples/seed/meta-data
@@ -0,0 +1,30 @@
+# this is yaml formated data
+# it is expected to be roughly what you would get from running the following
+# on an ec2 instance:
+# python -c 'import boto.utils, yaml; print(yaml.dump(boto.utils.get_instance_metadata()))'
+ami-id: ami-fd4aa494
+ami-launch-index: '0'
+ami-manifest-path: ubuntu-images-us/ubuntu-lucid-10.04-amd64-server-20100427.1.manifest.xml
+block-device-mapping: {ami: sda1, ephemeral0: sdb, ephemeral1: sdc, root: /dev/sda1}
+hostname: domU-12-31-38-07-19-44.compute-1.internal
+instance-action: none
+instance-id: i-87018aed
+instance-type: m1.large
+kernel-id: aki-c8b258a1
+local-hostname: domU-12-31-38-07-19-44.compute-1.internal
+local-ipv4: 10.223.26.178
+placement: {availability-zone: us-east-1d}
+public-hostname: ec2-184-72-174-120.compute-1.amazonaws.com
+public-ipv4: 184.72.174.120
+public-keys:
+  ec2-keypair.us-east-1: [ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCD9dlT00vOUC8Ttq6YH8RzUCVqPQl6HaSfWSTKYnZiVCpTBj1CaRZPLRLmkSB9Nziy4aRJa/LZMbBHXytQKnB1psvNknqC2UNlrXXMk+Vx5S4vg21MXYYimK4uZEY0Qz29QUiTyNsx18jpAaF4ocUpTpRhxPEBCcSCDmMbc27MU2XuTbasM2NjW/w0bBF3ZFhdH68dZICXdTxS2jUrtrCnc1D/QXVZ5kQO3jsmSyJg8E0nE+6Onpx2YRoVRSwjpGzVZ+BlXPnN5xBREBG8XxzhNFHJbek+RgK5TfL+k4yD4XhnVZuZu53cBAFhj+xPKhtisSd+YmaEq+Jt9uS0Ekd5
+      ec2-keypair.us-east-1, '']
+reservation-id: r-e2225889
+security-groups: default
+
+# of the fields above:
+# required:
+#  instance-id
+# suggested:
+#  local-hostname
+#  public-keys
diff --git a/doc/examples/seed/user-data b/doc/examples/seed/user-data
new file mode 100644
index 00000000..2bc87c0b
--- /dev/null
+++ b/doc/examples/seed/user-data
@@ -0,0 +1,3 @@
+#cloud-config
+runcmd:
+ - [ sh, -c, 'echo ==== $(date) ====; echo HI WORLD; echo =======' ]