aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configguide
diff options
context:
space:
mode:
authorChristian Trautman <ctrautma@redhat.com>2016-08-11 08:53:20 -0400
committerMaryam Tahhan <maryam.tahhan@intel.com>2016-08-12 13:08:32 +0000
commitf6f05f632f85d86d397e2522bc43cb4407d9eba8 (patch)
tree1c56864917b1265a44790d3df2d326edb3173e18 /docs/configguide
parentea6a60dec01d154196c21cfdacf6fd3f6981c71c (diff)
doc_fixup: Grammar and link fixes to documentation
Fixes minor grammar and link issues. JIRA: VSPERF-349 Change-Id: Id8708aee5b099287b5c99e79ca6da9ab8778897f Signed-off-by: Christian Trautman <ctrautma@redhat.com>
Diffstat (limited to 'docs/configguide')
-rwxr-xr-xdocs/configguide/installation.rst4
-rw-r--r--docs/configguide/trafficgen.rst8
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst
index 70572b07..2dabfc7f 100755
--- a/docs/configguide/installation.rst
+++ b/docs/configguide/installation.rst
@@ -162,8 +162,8 @@ hugepage amounts to support running these configurations. It is recommended
to configure 1GB hugepages as the pagesize.
The amount of hugepages needed depends on your configuration files in vsperf.
-Each guest image requires 4096 by default according to the default settings in
-the ``04_vnf.conf`` file.
+Each guest image requires 4096 MB by default according to the default settings
+in the ``04_vnf.conf`` file.
.. code:: bash
diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst
index c698b8d6..28b34a6b 100644
--- a/docs/configguide/trafficgen.rst
+++ b/docs/configguide/trafficgen.rst
@@ -57,7 +57,7 @@ follows:
},
}
-The framesize paramter can be overridden from the configuration
+The framesize parameter can be overridden from the configuration
files by adding the following to your custom configuration file
``10_custom.conf``:
@@ -169,7 +169,7 @@ IxNetwork -> IxNetwork\_$(VER\_NUM) -> IxNetwork TCL Server)
Right click on IxNetwork TCL Server, select properties - Under shortcut tab in
the Target dialogue box make sure there is the argument "-tclport xxxx"
-where xxxx is your port number (take note of this port number you will
+where xxxx is your port number (take note of this port number as you will
need it for the 10\_custom.conf file).
.. image:: TCLServerProperties.png
@@ -329,7 +329,7 @@ Xena Networks
Installation
~~~~~~~~~~~~
-Xena Networks traffic generator requires certain files and packages to be
+Xena Networks traffic generator requires specific files and packages to be
installed. It is assumed the user has access to the Xena2544.exe file which
must be placed in VSPerf installation location under the tools/pkt_gen/xena
folder. Contact Xena Networks for the latest version of this file. The user
@@ -406,7 +406,7 @@ https://github.com/emmericp/MoonGen
* Note: Today, MoonGen with VSPERF only supports 10Gbps line speeds.
-For VSPerf use, MoonGen should be cloned from here (as opposed to the afore
+For VSPerf use, MoonGen should be cloned from here (as opposed to the previously
mentioned GitHub):
git clone https://github.com/atheurer/MoonGen
: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ } 
heat_template_version: ocata

description: >
  Example extra config for cluster config
  this example collects the hostname and MAC addresses for each node in
  the deployment, then distributes that info to all Controller nodes.

# Parameters passed from the parent template - note if you maintain
# out-of-tree templates they may require additional parameters if the
# in-tree templates add a new role.
parameters:
  servers:
    type: json
# Note extra parameters can be defined, then passed data via the
# environment parameter_defaults, without modifying the parent template

resources:

  CollectMacConfig:
    type: OS::Heat::SoftwareConfig
    properties:
      group: script
      config: |
        #!/bin/sh
        MACS=$(ifconfig  | grep ether | awk '{print $2}' | tr "\n" " ")
        HOSTNAME=$(hostname -s)
        echo "$HOSTNAME $MACS"

  # FIXME(shardy): Long term it'd be better if Heat SoftwareDeployments accepted
  # list instead of a map, then we could join the lists of servers into one
  # deployment instead of requiring one deployment per-role.
{% for role in roles %}
  CollectMacDeployments{{role.name}}:
    type: OS::Heat::SoftwareDeployments
    properties:
      name: CollectMacDeploymentsController
      servers:  {get_param: [servers, {{role.name}}]}
      config: {get_resource: CollectMacConfig}
      actions: ['CREATE'] # Only do this on CREATE
{% endfor %}

  # Now we distribute all-the-macs to all Controller nodes
  DistributeMacConfig:
    type: OS::Heat::SoftwareConfig
    properties:
      group: script
      inputs:
      - name: controller_mappings
      - name: compute_mappings
      - name: blockstorage_mappings
      - name: objectstorage_mappings
      - name: cephstorage_mappings
      config: |
        #!/bin/sh
        echo $controller_mappings > /root/controller_mappings
        echo $compute_mappings > /root/compute_mappings
        echo $blockstorage_mappings > /root/blockstorage_mappings
        echo $objectstorage_mappings > /root/objectstorage_mappings
        echo $cephstorage_mappings > /root/cephstorage_mappings
        echo "mappings = $(cat /root/*_mappings)"

  DistributeMacDeploymentsController:
    type: OS::Heat::SoftwareDeployments
    properties:
      name: DistributeMacDeploymentsController
      servers:  {get_param: [servers, Controller]}
      config: {get_resource: DistributeMacConfig}
      input_values:
        # FIXME(shardy): It'd be more convenient if we could join these
        # items together but because the returned format is a map (not a list)
        # we can't use list_join or str_replace.  Possible Heat TODO.
        controller_mappings: {get_attr: [CollectMacDeploymentsController, deploy_stdouts]}
        compute_mappings: {get_attr: [CollectMacDeploymentsCompute, deploy_stdouts]}
        blockstorage_mappings: {get_attr: [CollectMacDeploymentsBlockStorage, deploy_stdouts]}
        objectstorage_mappings: {get_attr: [CollectMacDeploymentsObjectStorage, deploy_stdouts]}
        cephstorage_mappings: {get_attr: [CollectMacDeploymentsCephStorage, deploy_stdouts]}
      actions: ['CREATE'] # Only do this on CREATE