Skip to content

Commit f038c58

Browse files
committed
ref(docs): move "make disco-url" section inline to each install doc
1 parent 6242a5d commit f038c58

7 files changed

Lines changed: 20 additions & 25 deletions

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
A discovery URL links `etcd`_ instances together by storing their peer
2+
addresses and metadata under a unique identifier. Run this command from the root
3+
of the repository to generate a ``contrib/coreos/user-data`` file with a new
4+
discovery URL:
5+
6+
.. code-block:: console
7+
8+
$ make discovery-url
9+
10+
Required scripts are supplied in this ``user-data`` file, so do not provision a
11+
Deis cluster without running ``make discovery-url``.
12+
13+
.. _`etcd`: https://github.com/coreos/etcd

docs/installing_deis/aws.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,7 @@ Deis clusters of less than 3 nodes are unsupported.
7171
Generate a New Discovery URL
7272
----------------------------
7373

74-
To get started with provisioning Deis, we will need to generate a new Discovery URL. Discovery URLs
75-
help connect `etcd`_ instances together by storing a list of peer addresses and metadata under a
76-
unique address. You can generate a new discovery URL for use in your platform by
77-
running the following from the root of the repository:
78-
79-
.. code-block:: console
80-
81-
$ make discovery-url
82-
83-
This will write a new discovery URL to the user-data file. Some convenience scripts are supplied in
84-
this user-data file, so it is mandatory for provisioning Deis.
74+
.. include:: ../_includes/_generate-discovery-url.rst
8575

8676

8777
Customize cloudformation.json

docs/installing_deis/baremetal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Customize user-data
3939
Generate a New Discovery URL
4040
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4141

42-
Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
42+
.. include:: ../_includes/_generate-discovery-url.rst
4343

4444

4545
SSH Key

docs/installing_deis/digitalocean.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ Generate SSH Key
4141
Generate a New Discovery URL
4242
----------------------------
4343

44-
Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
44+
.. include:: ../_includes/_generate-discovery-url.rst
45+
4546

4647
Create CoreOS Droplets
4748
----------------------

docs/installing_deis/quick-start.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,8 @@ Generate SSH Key
2626
Generate a New Discovery URL
2727
----------------------------
2828

29-
Discovery URLs help connect `etcd`_ instances together by storing a list of peer addresses and metadata under a
30-
unique address. You can generate a new discovery URL for use in your platform by
31-
running the following from the root of the repository:
29+
.. include:: ../_includes/_generate-discovery-url.rst
3230

33-
.. code-block:: console
34-
35-
$ make discovery-url
36-
37-
This will write a new discovery URL to the user-data file. Some essential scripts are supplied in
38-
this user-data file, so it is mandatory for provisioning Deis.
3931

4032
Check System Requirements
4133
-------------------------
@@ -71,4 +63,3 @@ please refer to :ref:`install_deisctl` and :ref:`install_deis_platform`.
7163

7264

7365
.. _`CoreOS`: https://coreos.com/
74-
.. _`etcd`: https://github.com/coreos/etcd

docs/installing_deis/rackspace.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Tell supernova about the key pair and give it an identifiable name:
6161
Generate a New Discovery URL
6262
----------------------------
6363

64-
Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
64+
.. include:: ../_includes/_generate-discovery-url.rst
6565

6666

6767
Choose number of instances

docs/installing_deis/vagrant.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Generate SSH Key
3434
Generate a New Discovery URL
3535
----------------------------
3636

37-
Please refer to :ref:`generate_discovery_url` for generating a new Discovery URL.
37+
.. include:: ../_includes/_generate-discovery-url.rst
3838

3939

4040
Boot CoreOS

0 commit comments

Comments
 (0)