Remove usages of :linenos: in docs
Some markup features are sphinx-specific and are not supported by current library. Some bug were reported https://bugs.launchpad.net/doc8/+bug/1426503 about this, but it is not fixed and we need working docs. In current situation whole blocks of code are not shown so i removed usages of error-inflicting directive :linenos: Change-Id: I25e2d193b10d713bbe64fb227afb71310874bb9f
This commit is contained in:
parent
fed92fdd6e
commit
afeee484a4
@ -28,7 +28,6 @@ The following example creates a simple instance, booted from an image, and
|
|||||||
connecting to the ``private`` network:
|
connecting to the ``private`` network:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
instance:
|
instance:
|
||||||
@ -62,7 +61,6 @@ The following example demonstrates the use of the ``port`` and ``network``
|
|||||||
properties:
|
properties:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
instance_port:
|
instance_port:
|
||||||
@ -103,7 +101,6 @@ ports 80 and 443 (web server) and associates this security group to an instance
|
|||||||
port:
|
port:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
web_secgroup:
|
web_secgroup:
|
||||||
@ -153,7 +150,6 @@ The following example creates an instance and a floating IP, and associate the
|
|||||||
floating IP to the instance:
|
floating IP to the instance:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
floating_ip:
|
floating_ip:
|
||||||
@ -186,7 +182,6 @@ the :ref:`OS::Neutron::FloatingIPAssociation` resource to associate the
|
|||||||
floating IP to a port:
|
floating IP to a port:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
net:
|
net:
|
||||||
@ -219,7 +214,6 @@ the floating IP. However the approach mentioned above will work better
|
|||||||
with stack updates.
|
with stack updates.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
instance_port:
|
instance_port:
|
||||||
@ -246,7 +240,6 @@ The ``key_name`` attribute of the :ref:`OS::Nova::Server` resource defines
|
|||||||
the key pair to use to enable SSH remote access:
|
the key pair to use to enable SSH remote access:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
my_instance:
|
my_instance:
|
||||||
@ -273,7 +266,6 @@ The following example creates a new key pair and uses it as authentication key
|
|||||||
for an instance:
|
for an instance:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
my_key:
|
my_key:
|
||||||
@ -307,7 +299,6 @@ Use the :ref:`OS::Neutron::Net` resource to create a network, and the
|
|||||||
:ref:`OS::Neutron::Subnet` resource to provide a subnet for this network:
|
:ref:`OS::Neutron::Subnet` resource to provide a subnet for this network:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
new_net:
|
new_net:
|
||||||
@ -328,7 +319,6 @@ Use the :ref:`OS::Neutron::Router` resource to create a router. You can
|
|||||||
define its gateway with the ``external_gateway_info`` property:
|
define its gateway with the ``external_gateway_info`` property:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
router1:
|
router1:
|
||||||
@ -340,7 +330,6 @@ You can connect subnets to routers with the
|
|||||||
:ref:`OS::Neutron::RouterInterface` resource:
|
:ref:`OS::Neutron::RouterInterface` resource:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
subnet1_interface:
|
subnet1_interface:
|
||||||
@ -361,7 +350,6 @@ The following example creates a network stack:
|
|||||||
In this example, the ``public`` network is an existing shared network:
|
In this example, the ``public`` network is an existing shared network:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
internal_net:
|
internal_net:
|
||||||
@ -397,7 +385,6 @@ volume.
|
|||||||
For example:
|
For example:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
my_new_volume:
|
my_new_volume:
|
||||||
@ -409,7 +396,6 @@ The volumes that you create are empty by default. Use the ``image`` property to
|
|||||||
create a bootable volume from an existing image:
|
create a bootable volume from an existing image:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
my_new_bootable_volume:
|
my_new_bootable_volume:
|
||||||
@ -426,7 +412,6 @@ properties to create a new volume from an existing source.
|
|||||||
For example, to create a new volume from a backup:
|
For example, to create a new volume from a backup:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
another_volume:
|
another_volume:
|
||||||
@ -446,7 +431,6 @@ The following example creates a volume and an instance, and attaches the volume
|
|||||||
to the instance:
|
to the instance:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
new_volume:
|
new_volume:
|
||||||
@ -476,7 +460,6 @@ The following example creates a bootable volume from an image, and uses it to
|
|||||||
boot an instance:
|
boot an instance:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
bootable_volume:
|
bootable_volume:
|
||||||
|
@ -38,7 +38,6 @@ definition using only predefined properties. For example, the template below
|
|||||||
could be used to deploy a single compute instance:
|
could be used to deploy a single compute instance:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
heat_template_version: 2015-04-30
|
heat_template_version: 2015-04-30
|
||||||
|
|
||||||
@ -88,7 +87,6 @@ The following example extends the previous template to provide parameters for
|
|||||||
the key pair, image and flavor properties of the resource:
|
the key pair, image and flavor properties of the resource:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
heat_template_version: 2015-04-30
|
heat_template_version: 2015-04-30
|
||||||
|
|
||||||
@ -133,7 +131,6 @@ following example defines a default value ``m1.small`` for the
|
|||||||
``flavor`` property:
|
``flavor`` property:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
flavor:
|
flavor:
|
||||||
@ -153,7 +150,6 @@ stack details and can be accessed by any user in the same tenant. To hide the
|
|||||||
value of a parameter, use the ``hidden`` boolean attribute of the parameter:
|
value of a parameter, use the ``hidden`` boolean attribute of the parameter:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
database_password:
|
database_password:
|
||||||
@ -171,7 +167,6 @@ The following example restricts the ``flavor`` parameter to a list of three
|
|||||||
possible values:
|
possible values:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
flavor:
|
flavor:
|
||||||
@ -185,7 +180,6 @@ possible values:
|
|||||||
The following example defines multiple constraints for a password definition:
|
The following example defines multiple constraints for a password definition:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
database_password:
|
database_password:
|
||||||
|
@ -60,7 +60,6 @@ specify a shell script in the ``user_data`` property and have it be executed by
|
|||||||
the server during boot:
|
the server during boot:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
@ -81,7 +80,6 @@ Often there is a need to set variable values based on parameters or resources
|
|||||||
in the stack. This can be done with the :code:`str_replace` intrinsic function:
|
in the stack. This can be done with the :code:`str_replace` intrinsic function:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
foo:
|
foo:
|
||||||
@ -112,7 +110,6 @@ template, so the ``get_file`` intrinsic function can be used to maintain the
|
|||||||
script in a separate file:
|
script in a separate file:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
foo:
|
foo:
|
||||||
@ -148,7 +145,6 @@ For ``RAW`` the user_data is passed to Nova unmodified. For a Cloud-init_
|
|||||||
enabled image, the following are both valid ``RAW`` user-data:
|
enabled image, the following are both valid ``RAW`` user-data:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
@ -229,7 +225,6 @@ The following template example uses the convenience attribute ``curl_cli``
|
|||||||
which builds a curl command with a valid token:
|
which builds a curl command with a valid token:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
wait_condition:
|
wait_condition:
|
||||||
@ -304,7 +299,6 @@ The above template example only needs to have the ``type`` changed to the
|
|||||||
swift signal resources:
|
swift signal resources:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
signal:
|
signal:
|
||||||
@ -345,7 +339,6 @@ The resource :ref:`OS::Heat::SoftwareConfig` is used for storing configs
|
|||||||
represented by text scripts, for example:
|
represented by text scripts, for example:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
boot_script:
|
boot_script:
|
||||||
@ -371,7 +364,6 @@ ensures that the cloud-config is valid YAML, although no further checks for
|
|||||||
valid cloud-config are done.
|
valid cloud-config are done.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
file_content:
|
file_content:
|
||||||
@ -399,7 +391,6 @@ The resource :ref:`OS::Heat::MultipartMime` allows multiple
|
|||||||
resources to be combined into a single Cloud-init_ multi-part message:
|
resources to be combined into a single Cloud-init_ multi-part message:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
file_content:
|
file_content:
|
||||||
@ -480,7 +471,6 @@ custom image. The following script uses diskimage-builder to create an image
|
|||||||
required in later examples:
|
required in later examples:
|
||||||
|
|
||||||
.. code-block:: sh
|
.. code-block:: sh
|
||||||
:linenos:
|
|
||||||
|
|
||||||
# Clone the required repositories. Some of these are also available
|
# Clone the required repositories. Some of these are also available
|
||||||
# via pypi or as distro packages.
|
# via pypi or as distro packages.
|
||||||
@ -535,7 +525,6 @@ file. See the following example for a script
|
|||||||
which expects inputs ``foo``, ``bar`` and generates an output ``result``.
|
which expects inputs ``foo``, ``bar`` and generates an output ``result``.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
config:
|
config:
|
||||||
@ -634,7 +623,6 @@ to the ``config`` property of the config resource, as in the following
|
|||||||
example:
|
example:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
@ -722,7 +710,6 @@ to be modified with the following:
|
|||||||
export DEPLOYMENT_TOOL="heat-config-puppet"
|
export DEPLOYMENT_TOOL="heat-config-puppet"
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
:linenos:
|
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
@ -769,7 +756,6 @@ This demonstrates the use of the ``get_file`` function, which will attach the
|
|||||||
contents of the file ``example-puppet-manifest.pp``, containing:
|
contents of the file ``example-puppet-manifest.pp``, containing:
|
||||||
|
|
||||||
.. code-block:: puppet
|
.. code-block:: puppet
|
||||||
:linenos:
|
|
||||||
|
|
||||||
file { 'barfile':
|
file { 'barfile':
|
||||||
ensure => file,
|
ensure => file,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user