summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources
diff options
context:
space:
mode:
authorArnd Hannemann <arnd.hannemann@metrosystems.net>2017-08-21 15:47:50 +0200
committerScott Moser <smoser@brickies.net>2017-09-21 14:41:01 -0400
commit99ef5adfed0b31f87f8ea56b22113737f41bba9d (patch)
tree49078d086db9eeaeba12adfc76620d0bf479c8de /doc/rtd/topics/datasources
parent0451a9f60960da56e3af4f97bbcece3d98482f86 (diff)
downloadvyos-cloud-init-99ef5adfed0b31f87f8ea56b22113737f41bba9d.tar.gz
vyos-cloud-init-99ef5adfed0b31f87f8ea56b22113737f41bba9d.zip
doc: document GCE datasource.
Add some minimal documentation for GCE datasource.
Diffstat (limited to 'doc/rtd/topics/datasources')
-rw-r--r--doc/rtd/topics/datasources/gce.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/rtd/topics/datasources/gce.rst b/doc/rtd/topics/datasources/gce.rst
new file mode 100644
index 00000000..8406695c
--- /dev/null
+++ b/doc/rtd/topics/datasources/gce.rst
@@ -0,0 +1,20 @@
+.. _datasource_gce:
+
+Google Compute Engine
+=====================
+
+The GCE datasource gets its data from the internal compute metadata server.
+Metadata can be queried at the URL
+'``http://metadata.google.internal/computeMetadata/v1/``'
+from within an instance. For more information see the `GCE metadata docs`_.
+
+Currently the default project and instance level metadatakeys keys
+``project/attributes/sshKeys`` and ``instance/attributes/ssh-keys`` are merged
+to provide ``public-keys``.
+
+``user-data`` and ``user-data-encoding`` can be provided to cloud-init by
+setting those custom metadata keys for an *instance*.
+
+.. _GCE metadata docs: https://cloud.google.com/compute/docs/storing-retrieving-metadata#querying
+
+.. vi: textwidth=78