Merge ~jingni.wjj/cloud-init:add_aliyun_doc into cloud-init:master

Proposed by Junjie.Wang
Status: Superseded
Proposed branch: ~jingni.wjj/cloud-init:add_aliyun_doc
Merge into: cloud-init:master
Diff against target: 92 lines (+75/-0)
2 files modified
doc/rtd/topics/datasources.rst (+1/-0)
doc/rtd/topics/datasources/aliyun.rst (+74/-0)
Reviewer Review Type Date Requested Status
Scott Moser Needs Fixing
Review via email: mp+343181@code.launchpad.net

This proposal has been superseded by a proposal from 2018-04-19.

Commit message

doc: Add documentation for AliYun datasource.

Just add some documentation to readthedocs for AliYun.

To post a comment you must log in.
Revision history for this message
Scott Moser (smoser) wrote :

Hi Junjie,

Thank you for the merge proposal.

I've done some changes and suggested them form merge into your branch at
 https://code.launchpad.net/~smoser/cloud-init/+git/cloud-init/+merge/343546

If you agree with those changes you can:

 git remote add smoser https://git.launchpad.net/~smoser/cloud-init
 git fetch smoser
 git merge --squash smoser/doc/add_aliyun_doc
 git push --force HEAD

Also, please fix your git config for name and email.
The 'name' field in your commit is set to jingni.wjj. I believe you have previously contributed with that set to 'Junjie Wang'.

Thanks.

review: Needs Fixing

Unmerged commits

4558c38... by Junjie.Wang

Squashed commit of the following:

commit 7df94002f20836f8d8849e7435d7e8e147aba620
Author: Scott Moser <email address hidden>
Date: Wed Apr 18 12:13:46 2018 -0400

    Suggested changes.

     - General re-wording and re-formatting.
     - Mention 'AliYun' specifically as that is the datasource name.
     - Add to topics/datasources.rst so it shows up in the list.
     - Make a single subsection 'Alibaba Cloud (AliYun)'.
     - Use subsubsections (^) for 'Versions', 'userdata' 'metadata'
     - use shell code blocks and 'curl' to show grabbing data.
     - converted dos to unix carriage returns
     - removed a non-breaking space (U+FEFF).

0f8a382... by Junjie.Wang

add doc describe aliyun datasource

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/doc/rtd/topics/datasources.rst b/doc/rtd/topics/datasources.rst
2index 7e2854d..38ba75d 100644
3--- a/doc/rtd/topics/datasources.rst
4+++ b/doc/rtd/topics/datasources.rst
5@@ -80,6 +80,7 @@ Follow for more information.
6 .. toctree::
7 :maxdepth: 2
8
9+ datasources/aliyun.rst
10 datasources/altcloud.rst
11 datasources/azure.rst
12 datasources/cloudsigma.rst
13diff --git a/doc/rtd/topics/datasources/aliyun.rst b/doc/rtd/topics/datasources/aliyun.rst
14new file mode 100644
15index 0000000..3f4f40c
16--- /dev/null
17+++ b/doc/rtd/topics/datasources/aliyun.rst
18@@ -0,0 +1,74 @@
19+.. _datasource_aliyun:
20+
21+Alibaba Cloud (AliYun)
22+======================
23+The ``AliYun`` datasource reads data from Alibaba Cloud ECS. Support is
24+present in cloud-init since 0.7.9.
25+
26+Metadata Service
27+----------------
28+The Alibaba Cloud metadata service is available at the well known url
29+``http://100.100.100.200/``. For more information see
30+Alibaba Cloud ECS on `metadata
31+<https://www.alibabacloud.com/help/zh/faq-detail/49122.htm>`__.
32+
33+Versions
34+^^^^^^^^
35+Like the EC2 metadata service, Alibaba Cloud's metadata service provides
36+versioned data under specific paths. As of April 2018, there are only
37+``2016-01-01`` and ``latest`` versions.
38+
39+It is expected that the dated version will maintain a stable interface but
40+``latest`` may change content at a future date.
41+
42+Cloud-init uses the ``2016-01-01`` version.
43+
44+You can list the versions available to your instance with:
45+
46+.. code-block:: shell-session
47+
48+ $ curl http://100.100.100.200/
49+ 2016-01-01
50+ latest
51+
52+Metadata
53+^^^^^^^^
54+Instance metadata can be queried at
55+``http://100.100.100.200/2016-01-01/meta-data``
56+
57+.. code-block:: shell-session
58+
59+ $ curl http://100.100.100.200/2016-01-01/meta-data
60+ dns-conf/
61+ eipv4
62+ hostname
63+ image-id
64+ instance-id
65+ instance/
66+ mac
67+ network-type
68+ network/
69+ ntp-conf/
70+ owner-account-id
71+ private-ipv4
72+ public-keys/
73+ region-id
74+ serial-number
75+ source-address
76+ sub-private-ipv4-list
77+ vpc-cidr-block
78+ vpc-id
79+
80+Userdata
81+^^^^^^^^
82+If provided, user-data will appear at
83+``http://100.100.100.200/2016-01-01/user-data``.
84+If no user-data is provided, this will return a 404.
85+
86+.. code-block:: shell-session
87+
88+ $ curl http://100.100.100.200/2016-01-01/user-data
89+ #!/bin/sh
90+ echo "Hello World."
91+
92+.. vi: textwidth=78

Subscribers

People subscribed via source and target branches