Added FAQ section to documentation

Added a section for frequently asked questions that can be
expended on when relevant. Also made two addtions to .gitignore
to refrain from tracking Sphinx build files and IDE files

Change-Id: I384502a3b919773f5839dac50af420b277c34f94
This commit is contained in:
Danny Massa 2020-05-21 09:36:37 -05:00
parent 7fe5ca0645
commit a561300154
3 changed files with 55 additions and 0 deletions

10
.gitignore vendored
View File

@ -4,3 +4,13 @@ peggles/
# Unit test / coverage reports
.tox/
config-ssh
# Sphinx Build Files
_build
# Various user specific files
.DS_Store
.idea/
.vimrc
*.swp
.vscode/

44
doc/source/faq.rst Normal file
View File

@ -0,0 +1,44 @@
==========================
Frequently Asked Questions
==========================
.. contents:: Table of Contents
:depth: 3
What is a good starting point to develop understanding of Airship?
------------------------------------------------------------------
Firstly, a good understanding of each Airship component should be attained.
Afterwards, familiarity with the YAML manifest files of Airship is highly
recommended. Airship Treasuremap contains the Seaworthy manifest files, which
can be explored to develop an understanding of how configuration of Airship is
done.
Airship Calico BGP peers with the Airship Network infrastructure. Where does Calico peer to?
--------------------------------------------------------------------------------------------
Calico BGP peers with the C-leaf.
While working with SR-IOV networks in OpenStack, what kind of VLAN creation options are there?
----------------------------------------------------------------------------------------------
Traffic for a VNF enters the C-leaf and gets switched at layer 2 towards the
said VNF because it is VLAN based. Each tenant has its own separate VLAN. While
provisioning SR-IOV networks in OpenStack the platform supports a variety of
configurations. 2 flat network topologies can be created using VLAN 0 in
OpenStack so that the virtual function has no filter. Furthermore, there can
also be 2 VLAN based networks using provider network with SR-IOV NIC and use
them in guest.
While provisioning SR-IOV ports what kind of IP addresses are used at the OpenStack level?
------------------------------------------------------------------------------------------
Fake IP addresses in OpenStack has been used in some production deployments.
This is how some of the sensitive tenants use the SR-IOV networks. A common way
to assign fake IP address is to use the 169.x.x.x IP network. A deployment
engineer can view this fake IP range in the OpenStack dashboard for the SR-IOV
networks & ports. These fake IP addresses mean nothing and are used only to
provide OpenStack with some view of the IPs. The real IPs and subnets of SR-IOV
networks are completely different and provisioned on the VMs, and BGP
communicated by VMs to the R-leaf.
Where can I find more information about hardware infrastructure?
----------------------------------------------------------------
In the
`CNTT Documentation <https://github.com/cntt-n/CNTT/tree/master/doc/tech>`__

View File

@ -199,6 +199,7 @@ Process Flows
airsloop
airskiff
development_guide
faq
.. _Barbican: https://docs.openstack.org/barbican/latest/api/
.. _Helm Homepage: https://helm.sh/