From be7ad7fb41a0234c96c68319490795d8721d8f3a Mon Sep 17 00:00:00 2001 From: toby Date: Sun, 17 Jun 2018 18:35:01 +0200 Subject: [PATCH] first commit --- .gitignore | 1 + Makefile | 20 +++++ _templates/searchbox.html | 0 build.sh | 4 + conf.py | 168 ++++++++++++++++++++++++++++++++++++++ index.rst | 10 +++ rack1.rst | 168 ++++++++++++++++++++++++++++++++++++++ todo.rst | 2 + 8 files changed, 373 insertions(+) create mode 100644 .gitignore create mode 100644 Makefile create mode 100644 _templates/searchbox.html create mode 100644 build.sh create mode 100644 conf.py create mode 100644 index.rst create mode 100644 rack1.rst create mode 100644 todo.rst diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..88f9974 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +_build/* diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..94672a2 --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = usw2 +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/_templates/searchbox.html b/_templates/searchbox.html new file mode 100644 index 0000000..e69de29 diff --git a/build.sh b/build.sh new file mode 100644 index 0000000..bb01699 --- /dev/null +++ b/build.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +make html +rsync -Pir _build/html/* r:/var/www/html/usw2/ diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..2c08035 --- /dev/null +++ b/conf.py @@ -0,0 +1,168 @@ +# -*- coding: utf-8 -*- +# +# usw2 documentation build configuration file, created by +# sphinx-quickstart on Wed Jun 13 17:17:54 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'usw2' +copyright = u'2018, toby' +author = u'toby' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'1.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'usw2doc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'usw2.tex', u'usw2 Documentation', + u'toby', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'usw2', u'usw2 Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'usw2', u'usw2 Documentation', + author, 'usw2', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/index.rst b/index.rst new file mode 100644 index 0000000..7e05db4 --- /dev/null +++ b/index.rst @@ -0,0 +1,10 @@ +Wit usw2 +======== + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + todo + rack1 + diff --git a/rack1.rst b/rack1.rst new file mode 100644 index 0000000..9b22b14 --- /dev/null +++ b/rack1.rst @@ -0,0 +1,168 @@ +Rack 1: +******* + + + +device classes: +=============== + +- fspineX: supermicro fiber switch +- cspineX: edgecore copper switch +- edgeX: border/network 1U server (heavy on CPU) +- hX...: hypervisor +- dX...: data node +- ipmiX: cheap switch +- bastion: cheap server with extra nics + + + + +server NIC naming and requirements: +=================================== + +- regular server: + * ipmi: ipmi port of the server + * mgmt: 1gig pxeboot capable copper nic for mgmt (ssh, etc) and pxeboot + * peth: 10gig frontend fiber (2 per server) + * ceph: 10gig backend copper (2 per server) + + +- edge server (special case): + * same links as regular server + * xlink: 10gig fiber iBGP cross link (ideally 2 per server, could be mix and match with fiber and copper as they just go direclty to the peer edge server) + * up: 10gig fiber DIA uplink + + +- bastion server (special case): + * ipmigw: 1gig copper nic for ipmi network + * mgmtgw: 1gig copper nic for mgmt network + * peth1: 10gig fiber nic to uplink to fspine1 + * peth2: 10gig fiber nic to uplink to fspine2 + * ceph1: 10gig copper to cspine1 + * ceph2: 10gig copper to cspine2 + + + + +node id: +======== +- each chassis (regardless of switch or server) will need to get an ID assinged. +- the id should be a number from 10-255 +- this ID will be used in several locations: + * BGP asn final digits (i.e. ID 121 -> ASN: 4200002121) + * loopback IP final digits (i.e. ID 121 -> IP: 10.1.2.121) + * mgmt IP final digits (i.e. ID 121 -> 10.0.1.121) + * ipmi IP final digits (i.e. ID 121 -> 10.2.2.121 + + + + +IP allocations: +=============== + + +- Factory (usw1): + * 10.1.0.0/24: loopback tier spine + * 10.1.1.0/24: loopback tier border + * 10.1.2.0/24: loopback tier 2 + * 10.1.3.0/24: loopback tier 3 (arm tier) + * 10.1.4.0/24: loopback ceph + + * 10.0.0.0/24: mgmt/ipmi + * 10.2.0.0/24: ipmi to be used + + + +- DC (usw2): + * 10.1.16.0/24: loopback tier spine + * 10.1.17.0/24: loopback tier border + * 10.1.18.0/24: loopback tier 2 + * 10.1.19.0/24: loopback tier 3 (arm tier) + * 10.1.20.0/24: loopback ceph + + * 10.0.1.0/24: mgmt + * 10.2.1.0/24: ipmi + + + + + + +ipmi network: +============= + + +:: + + bastion:ipmigw +---+ eth48:ipmi1:eth1-20 +---+ + +---- edge1:ipmi + +---- edge2:ipmi + +---- h1:ipmi + +---- h2:ipmi + +---- h3:ipmi + ... + + +mgmt network: +============= + +:: + + bastion:mgmtgw +---+ eth48:mgmt1:eth1-20 +---+ + +---- edge1:mgmt + +---- edge2:mgmt + +---- h1:mgmt + +---- h2:mgmt + +---- h3:mgmt + ... + + + + + +frontend network: +================= + +:: + + fspine1:swp48 +-----+ swp48:fspine2 + swpX swpX + | | + +-+ peth1:edge1:peth2 +-+ + | xlink up1 +---|-------+ patch1: evocative-uplink + | + | + | | | + | + | + | xlink up2 +---|-------+ patch2: TBD + +-+ peth1:edge2:peth2 --+ + | | + ++ peth1:bastion:peth2 ++ + | | + | | + | | + | | + +--+ peth1:h 1:peth2 +--+ + +--+ peth1:h 1:peth2 +--+ + +--+ peth1:h 1:peth2 +--+ + +--------- .. ----------+ + + + +backend network: +================ + +:: + + cspine1:swp48 +-----+ swp48:cspine2 + swpX swpX + | | + ++ ceph1:bastion:ceph2 ++ + | | + | | + | | + +--+ ceph1:h 1:ceph2 +--+ + +--+ ceph1:h 1:ceph2 +--+ + +--+ ceph1:h 1:ceph2 +--+ + +--------- .. ----------+ + + diff --git a/todo.rst b/todo.rst new file mode 100644 index 0000000..4ccfbfb --- /dev/null +++ b/todo.rst @@ -0,0 +1,2 @@ +TODO: +*****