Merge "[docs] Mark init-runonce properly" into stable/wallaby

Author: Zuul

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

@@ -128,13 +128,6 @@ Run the deploy as usual:
 
 Post-deployment configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A script named `init-runonce` is supplied as part of kolla-ansible to
-initialise the cloud with some defaults (only to be used for demo purposes):
-
-.. code-block:: console
-
-  tools/init-runonce
-
 The :ironic-doc:`Ironic documentation <install/configure-glance-images>`
 describes how to create the deploy kernel and ramdisk and register them with
 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:
 
 Booting the baremetal
 ~~~~~~~~~~~~~~~~~~~~~
-You can now use the following sample command to boot the baremetal instance:
+Assuming you have followed the examples above and created the demo resources
+as shown in the :doc:`../../user/quickstart`, you can now use the following
+example command to boot the baremetal instance:
 
 .. code-block:: console
 
   openstack server create --image cirros --flavor my-baremetal-flavor \
     --key-name mykey --network public1 demo1
 
+In other cases you will need to adapt the command to match your environment.
+
 Notes
 ~~~~~
 

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

@@ -51,6 +51,16 @@ and versioning may differ depending on deploy configuration):
    CONTAINER ID   IMAGE                                                               COMMAND         CREATED          STATUS        PORTS  NAMES
    97d25657d55e   operator:5000/kolla/centos-source-neutron-vpnaas-agent:4.0.0   "kolla_start"   44 minutes ago   Up 44 minutes        neutron_vpnaas_agent
 
+.. warning::
+
+   You are free to use the following ``init-runonce`` script for demo
+   purposes but note it does **not** have to be run in order to use your
+   cloud. Depending on your customisations, it may not work, or it may
+   conflict with the resources you want to create. You have been warned.
+
+   Similarly, the ``init-vpn`` script does **not** have to be run unless
+   you want to follow this particular demo.
+
 Kolla Ansible includes a small script that can be used in tandem with
 ``tools/init-runonce`` to verify the VPN using two routers and two Nova VMs:
 

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

@@ -90,17 +90,6 @@ Source credentials file.
 
    $ . /etc/kolla/admin-openrc.sh
 
-Create base neutron networks and glance images.
-
-.. code-block:: console
-
-   $ ./tools/init-runonce
-
-.. note::
-
-   ``init-runonce`` file is located in ``$PYTHON_PATH/kolla-ansible``
-   folder in kolla-ansible installation from pip.
-
 In kolla-ansible git repository a `tacker demo <https://github.com/openstack/kolla-ansible/tree/master/contrib/demos/tacker>`_
 is present in ``kolla-ansible/contrib/demos/tacker/`` that will
 create a very basic VNF from a cirros image in ``demo-net`` network.
@@ -116,11 +105,20 @@ Install python-tackerclient.
 
    $ pip install python-tackerclient
 
-Execute ``deploy-tacker-demo`` script to initialize the VNF creation.
+.. warning::
+
+   You are free to use the following ``init-runonce`` script for demo
+   purposes but note it does **not** have to be run in order to use your
+   cloud. Depending on your customisations, it may not work, or it may
+   conflict with the resources you want to create. You have been warned.
+
+From kolla-ansible git repository, execute ``init-runonce`` and
+``deploy-tacker-demo`` scripts to initialize the demo VNF creation.
 
 .. code-block:: console
 
-   $ ./deploy-tacker-demo
+   $ ./tools/init-runonce
+   $ ./contrib/demos/tacker/deploy-tacker-demo
 
 Tacker demo script will create sample VNF Descriptor (VNFD) file,
 then register a default VIM, create a tacker VNFD and finally
@@ -173,3 +171,6 @@ can be cleaned up executing ``cleanup-tacker`` script.
 
    $ ./cleanup-tacker
 
+.. warning::
+
+   The above does not clean up resources created by ``init-runonce``.

doc/source/user/quickstart.rst

@@ -554,7 +554,14 @@ Using OpenStack
 #. Depending on how you installed Kolla Ansible, there is a script that will
    create example networks, images, and so on.
 
-   * For deployment or evaluation, run ``init-runonce`` script.
+   .. warning::
+
+      You are free to use the following ``init-runonce`` script for demo
+      purposes but note it does **not** have to be run in order to use your
+      cloud. Depending on your customisations, it may not work, or it may
+      conflict with the resources you want to create. You have been warned.
+
+   * For deployment or evaluation, run:
 
      If using a virtual environment: