Skip to content

Commit cb630cc

Browse files
yoctozeptomarkgoddard
authored andcommitted
[docs] Mark init-runonce properly
This is a docs amendment to let users know that calling init-runonce is not a required deployment step and it may not work for them if they modified the defaults. Change-Id: Ia3922b53d91a1a820447fec6a8074b941edc2ee9 (cherry picked from commit 1c93c8e)
1 parent 143cca5 commit cb630cc

File tree

4 files changed

+38
-23
lines changed

4 files changed

+38
-23
lines changed

doc/source/reference/bare-metal/ironic-guide.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,6 @@ Run the deploy as usual:
128128
129129
Post-deployment configuration
130130
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131-
A script named `init-runonce` is supplied as part of kolla-ansible to
132-
initialise the cloud with some defaults (only to be used for demo purposes):
133-
134-
.. code-block:: console
135-
136-
tools/init-runonce
137-
138131
The :ironic-doc:`Ironic documentation <install/configure-glance-images>`
139132
describes how to create the deploy kernel and ramdisk and register them with
140133
Glance. In this example we're reusing the same images that were fetched for the
@@ -198,13 +191,17 @@ Use the following commands to wait for the resources to become available:
198191
199192
Booting the baremetal
200193
~~~~~~~~~~~~~~~~~~~~~
201-
You can now use the following sample command to boot the baremetal instance:
194+
Assuming you have followed the examples above and created the demo resources
195+
as shown in the :doc:`../../user/quickstart`, you can now use the following
196+
example command to boot the baremetal instance:
202197

203198
.. code-block:: console
204199
205200
openstack server create --image cirros --flavor my-baremetal-flavor \
206201
--key-name mykey --network public1 demo1
207202
203+
In other cases you will need to adapt the command to match your environment.
204+
208205
Notes
209206
~~~~~
210207

doc/source/reference/networking/neutron-extensions.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,17 @@ and versioning may differ depending on deploy configuration):
5151
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
5252
97d25657d55e operator:5000/kolla/centos-source-neutron-vpnaas-agent:4.0.0 "kolla_start" 44 minutes ago Up 44 minutes neutron_vpnaas_agent
5353
54-
Kolla-Ansible includes a small script that can be used in tandem with
54+
.. warning::
55+
56+
You are free to use the following ``init-runonce`` script for demo
57+
purposes but note it does **not** have to be run in order to use your
58+
cloud. Depending on your customisations, it may not work, or it may
59+
conflict with the resources you want to create. You have been warned.
60+
61+
Similarly, the ``init-vpn`` script does **not** have to be run unless
62+
you want to follow this particular demo.
63+
64+
Kolla Ansible includes a small script that can be used in tandem with
5565
``tools/init-runonce`` to verify the VPN using two routers and two Nova VMs:
5666

5767
.. code-block:: console

doc/source/reference/orchestration-and-nfv/tacker-guide.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -90,17 +90,6 @@ Source credentials file.
9090
9191
$ . /etc/kolla/admin-openrc.sh
9292
93-
Create base neutron networks and glance images.
94-
95-
.. code-block:: console
96-
97-
$ ./tools/init-runonce
98-
99-
.. note::
100-
101-
``init-runonce`` file is located in ``$PYTHON_PATH/kolla-ansible``
102-
folder in kolla-ansible installation from pip.
103-
10493
In kolla-ansible git repository a `tacker demo <https://github.com/openstack/kolla-ansible/tree/master/contrib/demos/tacker>`_
10594
is present in ``kolla-ansible/contrib/demos/tacker/`` that will
10695
create a very basic VNF from a cirros image in ``demo-net`` network.
@@ -116,11 +105,20 @@ Install python-tackerclient.
116105
117106
$ pip install python-tackerclient
118107
119-
Execute ``deploy-tacker-demo`` script to initialize the VNF creation.
108+
.. warning::
109+
110+
You are free to use the following ``init-runonce`` script for demo
111+
purposes but note it does **not** have to be run in order to use your
112+
cloud. Depending on your customisations, it may not work, or it may
113+
conflict with the resources you want to create. You have been warned.
114+
115+
From kolla-ansible git repository, execute ``init-runonce`` and
116+
``deploy-tacker-demo`` scripts to initialize the demo VNF creation.
120117

121118
.. code-block:: console
122119
123-
$ ./deploy-tacker-demo
120+
$ ./tools/init-runonce
121+
$ ./contrib/demos/tacker/deploy-tacker-demo
124122
125123
Tacker demo script will create sample VNF Descriptor (VNFD) file,
126124
then register a default VIM, create a tacker VNFD and finally
@@ -173,3 +171,6 @@ can be cleaned up executing ``cleanup-tacker`` script.
173171
174172
$ ./cleanup-tacker
175173
174+
.. warning::
175+
176+
The above does not clean up resources created by ``init-runonce``.

doc/source/user/quickstart.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -564,7 +564,14 @@ Using OpenStack
564564
#. Depending on how you installed Kolla-Ansible, there is a script that will
565565
create example networks, images, and so on.
566566

567-
* For deployment or evaluation, run ``init-runonce`` script.
567+
.. warning::
568+
569+
You are free to use the following ``init-runonce`` script for demo
570+
purposes but note it does **not** have to be run in order to use your
571+
cloud. Depending on your customisations, it may not work, or it may
572+
conflict with the resources you want to create. You have been warned.
573+
574+
* For deployment or evaluation, run:
568575

569576
If using a virtual environment:
570577

0 commit comments

Comments
 (0)