aboutsummaryrefslogtreecommitdiffstats
path: root/docs/report/introduction
diff options
context:
space:
mode:
authorpmikus <pmikus@cisco.com>2021-11-03 15:34:22 +0000
committerPeter Mikus <pmikus@cisco.com>2021-11-03 15:37:20 +0000
commite6b2505e14723eaca82204f1f6ef25af4f3e77e7 (patch)
tree39fdc84ab91f07953d03d464fd121a38dff3cdd3 /docs/report/introduction
parentc4ef85bfbdcf2c73919d8d23a409f02edacf9973 (diff)
fix(Docs): Report section updates
Signed-off-by: pmikus <pmikus@cisco.com> Change-Id: Icd04b75d320f067bd66402d5bb499070ee2768f3
Diffstat (limited to 'docs/report/introduction')
-rw-r--r--docs/report/introduction/documentation/index.rst1
-rw-r--r--docs/report/introduction/methodology.rst1
-rw-r--r--docs/report/introduction/methodology_aws/aws_ami.rst17
-rw-r--r--docs/report/introduction/methodology_aws/aws_instances.rst7
-rw-r--r--docs/report/introduction/methodology_aws/index.rst4
-rw-r--r--docs/report/introduction/methodology_containers.rst (renamed from docs/report/introduction/documentation/containers.rst)0
6 files changed, 13 insertions, 17 deletions
diff --git a/docs/report/introduction/documentation/index.rst b/docs/report/introduction/documentation/index.rst
index 5975fb9300..42afab7506 100644
--- a/docs/report/introduction/documentation/index.rst
+++ b/docs/report/introduction/documentation/index.rst
@@ -8,6 +8,5 @@ Documentation
.. toctree::
- containers
documentation
diff --git a/docs/report/introduction/methodology.rst b/docs/report/introduction/methodology.rst
index 3e1030bf72..3fcd5bea8d 100644
--- a/docs/report/introduction/methodology.rst
+++ b/docs/report/introduction/methodology.rst
@@ -24,6 +24,7 @@ Test Methodology
methodology_reconf
methodology_vpp_startup_settings
methodology_kvm_vms_vhost_user
+ methodology_containers
methodology_lxc_drc_container_memif
methodology_nfv_service_density
methodology_vpp_device_functional
diff --git a/docs/report/introduction/methodology_aws/aws_ami.rst b/docs/report/introduction/methodology_aws/aws_ami.rst
index 2a94a6b0cc..0eebdf9d9c 100644
--- a/docs/report/introduction/methodology_aws/aws_ami.rst
+++ b/docs/report/introduction/methodology_aws/aws_ami.rst
@@ -1,14 +1,15 @@
-AWS Amazon Machine Images
--------------------------
+Amazon Machine Images
+---------------------
-An Amazon Machine Image (AMI) provides the information required to launch an
-instance. CSIT is using Amazon EBS where the root device for an instance
-launched from the AMI is an Amazon Elastic Block Store (Amazon EBS) volume
-created from an Amazon EBS snapshot.
+An :abbr:`AMI (Amazon Machine Image)` provides the information required to
+launch an instance. CSIT is using Amazon :abbr:`EBS (Elastic Block Store)` where
+the root device for an instance launched from the AMI is a volume created from
+an Amazon EBS snapshot.
A the TG and SUT instances have slightly different software requirements,
we are defining two AMIs for TG and SUT separately. AMI details examples:
+TG:
- AMI Name: csit_c5n_ubuntu_focal_tg
- Platform details: Linux/UNIX
- Architecture: x86_64
@@ -19,6 +20,7 @@ we are defining two AMIs for TG and SUT separately. AMI details examples:
- Root Device Name: /dev/sda1
- Root Device Type: ebs
+SUT:
- AMI Name: csit_c5n_ubuntu_focal_sut
- Platform details: Linux/UNIX
- Architecture: x86_64
@@ -40,7 +42,4 @@ part of automated scripts. To create CSIT AMIs:
Building AMIs requires Hashicorp Packer with Amazon plugin installed.
-Reference
----------
-
.. [aws_ami] `Amazon Machine Images <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`_
diff --git a/docs/report/introduction/methodology_aws/aws_instances.rst b/docs/report/introduction/methodology_aws/aws_instances.rst
index 204c15eb79..0df0321c5f 100644
--- a/docs/report/introduction/methodology_aws/aws_instances.rst
+++ b/docs/report/introduction/methodology_aws/aws_instances.rst
@@ -1,5 +1,5 @@
-AWS Instances
--------------
+Instances
+---------
CSIT is using C5n instances for high compute applications that can take
advantage of improved network throughput and packet rate performance. C5n
@@ -51,9 +51,6 @@ CPU utilization when compared to traditional virtualized network interfaces
Current advertised limits are captured in [aws_limits]_.
-Reference
----------
-
.. [aws_it] `Instance types <https://aws.amazon.com/ec2/instance-types/>`_
.. [aws_ena] `Elastic Network Adapter <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking-ena.html>`_
.. [aws_limits] `<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/compute-optimized-instances.html>`_ \ No newline at end of file
diff --git a/docs/report/introduction/methodology_aws/index.rst b/docs/report/introduction/methodology_aws/index.rst
index 602f2c4b3b..5da5253ccf 100644
--- a/docs/report/introduction/methodology_aws/index.rst
+++ b/docs/report/introduction/methodology_aws/index.rst
@@ -3,6 +3,6 @@ Amazon Web Services
.. toctree::
- aws_terraform
- aws_ami
aws_instances
+ aws_ami
+ aws_terraform
diff --git a/docs/report/introduction/documentation/containers.rst b/docs/report/introduction/methodology_containers.rst
index 14817df64f..14817df64f 100644
--- a/docs/report/introduction/documentation/containers.rst
+++ b/docs/report/introduction/methodology_containers.rst