arista-eos 1.1.0

data/guide/conf.py

@@ -0,0 +1,282 @@
+# -*- coding: utf-8 -*-
+#
+# puppet_eos documentation build configuration file, created by
+# sphinx-quickstart on Mon Apr  6 20:46:10 2015.
+#
+# 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.
+
+import sys
+import os
+
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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.
+#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 = [
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'puppet_eos'
+copyright = u'2015, Arista Networks - EOS+ Consulting Services'
+
+# 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.
+#
+import re
+p = re.compile("version\": \"(.*)\"")
+with open("../metadata.json") as f:
+    data = f.read()
+    ver = p.search(data)
+    if ver:
+        version = ver.group(1)
+
+#print "Version: {}".format(version)
+
+# The short X.Y version.
+#version = '1.0'
+# The full version, including alpha/beta/rc tags.
+#release = '1.0'
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = 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 = 'default'
+
+# 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 themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+html_logo = '_static/arista_logo_jpg-11.jpg'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+html_favicon = '_static/favicon.ico'
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'puppet_eosdoc'
+
+
+# -- 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': '',
+}
+
+# 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 = [
+  ('index', 'puppet_eos.tex', u'puppet\\_eos Module Documentation',
+   u'Arista Networks - EOS+ Consulting Services', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+latex_logo = '_static/arista_logo_jpg-11.jpg'
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'puppet_eos', u'puppet_eos Module Documentation',
+     [u'Arista Networks - EOS+ Consulting Services'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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 = [
+  ('index', 'puppet_eos', u'puppet_eos Module Documentation',
+   u'Arista Networks - EOS+ Consulting Services', 'puppet_eos', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

data/guide/cookbook.rst

@@ -0,0 +1,135 @@
+Cookbook
+============
+
+.. contents:: :local:
+
+Creating a Node Profile Manifest
+--------------------------------
+
+A common pattern is to use node profile manifests to define reusable blocks that get applied to individual nodes, as needed. Node profile manifests define contain classes which define the desired state for one or more settings. These profile classes are, then, assigned to nodes based on the node classification. Profile classes may use parameters (specified in a resource definition or Hiera) to allow customization per node.
+
+Recipe 1: Masterless / Headless
+-------------------------------
+
+Puppet may be run in a masterless / headless manner.  This method is useful for testing as well as full deployments. When running headless, modules, manifests, etc are made available to each node (NFS, wget, git, subversion) then are applied at the node with the ``puppet apply <manifest>`` command.
+
+Recipe 2: MLAG
+--------------
+
+Below are two sample manifests (classes) that can be applied to nodes to configure MLAG between a spine and ToR switch.
+This is a very basic example to illustrate the use of the eos types.  A more useful class would accept variables or read data from hiera 
+to use for interface IDs, VLAN IDs, peer-addresses, etc.
+
+Spine1 Sample
+^^^^^^^^^^^^^
+
+.. code-block:: puppet
+
+  # Configure peer link and MLAG peer.
+  eos_vlan { "4094":
+    trunk_groups => ["mlagpeer"],
+  }
+  eos_interface { "Port-Channel10":
+    description => "MLAG Peer link",
+    ensure => present,
+  }
+  eos_portchannel { "Port-Channel10":
+    lacp_mode => active,
+    members => ["Ethernet1", "Ethernet2"],
+  }
+  eos_switchport { "Port-Channel10":
+    ensure => present,
+    mode => trunk,
+    # trunk_group => "mlagpeer",
+  }
+  eos_stp_config { "4094":
+    mode => "none",
+  }
+  eos_ipinterface { "Vlan4094":
+    address => "10.0.0.1/30",
+  }
+  eos_mlag { "Rack2":
+    local_interface => "Vlan4094",
+    peer_address => "10.0.0.2",
+    peer_link => "Port-Channel10",
+    domain_id => "mlag1",
+    enable => true,
+  }
+
+  # Configure downstream links
+  eos_portchannel { "Port-Channel3":
+    lacp_mode => active,
+    members => ["Ethernet2/4"],
+  }
+  eos_mlag_interface { "Port-Channel3":
+    mlag_id => 3,
+    ensure => present,
+  }
+  eos_switchport { "Port-Channel3":
+    ensure => present,
+    mode => trunk,
+    trunk_native_vlan => 300,
+    trunk_allowed_vlans => [301, 302, 303, 305, 306, 307],
+  }
+
+  # Create vlans
+  eos_vlan { "300":
+    vlan_name => "ztp_bootstrap",
+    ensure => present,
+  }
+
+  $vlans = ["301", "302", "303", "305", "306", "307"]
+  each($vlans) |$value| { eos_vlan { $value: ensure => present, } }
+
+
+ToR Sample
+^^^^^^^^^^
+
+.. code-block:: puppet
+
+  eos_interface { "Port-Channel3":
+  ensure => present,
+  description => "MLAG uplink to spine" 
+  }
+  eos_switchport {'Ethernet1':
+    ensure => present,
+  }
+  eos_switchport {'Ethernet2':
+    ensure => present,
+  }
+  eos_portchannel { "Port-Channel3":
+    lacp_mode => active,
+    members => ["Ethernet1", "Ethernet2"],
+  }
+  eos_switchport { "Port-Channel3":
+    ensure => present,
+    mode => trunk,
+    trunk_native_vlan => 300,
+    trunk_allowed_vlans => [301, 302, 303, 305, 306, 307],
+  }
+
+  eos_switchport {'Ethernet3':
+    access_vlan => 302,
+    mode => access,
+    ensure => present,
+  }
+  eos_switchport {'Ethernet4':
+    access_vlan => 301,
+    mode => access,
+    ensure => present,
+  }
+
+  $vlans = ["301", "302", "303", "305", "306", "307"]
+
+  # In Puppet 3.7 with "parser = future" 
+  #each($vlans) |$value| { eos_vlan { $value: ensure => present } }
+
+  # Existing syntax
+  define newvlan {
+    eos_vlan { $name: 
+      ensure => present 
+    }
+  }
+  newvlan { $vlans :
+  }
+

data/guide/developing.rst

@@ -0,0 +1,55 @@
+Developing
+==========
+
+.. contents:: :local:
+
+Overview
+--------
+
+This module can be configured to run directly from source and configured to do
+local development, sending the commands to the node over HTTPS/HTTP.  The
+following instructions explain how to configure your local development
+environment.
+
+Running from source
+-------------------
+
+This module requires one dependency in addition to Puppet that must be checked
+out as a Git working copy in the context of ongoing development in addition to
+running Puppet from source.
+
+ * Ruby client for eAPI: `rbeapi <https://github.com/arista-eosplus/rbeapi>`_
+
+The dependency is managed via the bundler Gemfile and the environment needs to
+be configured to use local Git copies::
+
+    cd /workspace
+    git clone https://github.com/arista-eosplus/rbeapi.git
+    export GEM_RBEAPI_VERSION=file:///workspace/rbeapi
+
+Once the dependencies are installed and the environment configured, then
+install all of the dependencies::
+
+    git clone https://github.com/arista-eosplus/puppet-eos.git
+    cd puppet-eos
+    bundle install --path .bundle/gems
+
+Once everything is installed, run the spec tests to make sure everything is
+working properly::
+
+    bundle exec rspec spec
+
+Finally, configure the eapi.conf file for rbeapi `See rbeapi for
+details <https://github.com/arista-eosplus/rbeapi#example-eapiconf-file>`_ and
+set the connection environment variable to run sanity tests
+using `puppet resource`::
+
+    export RBEAPI_CONNECTION=veos01
+
+Contributing
+------------
+
+Contributions to this project are gladly welcomed in the form of issues (bugs,
+questions, enhancement proposals) and pull requests.  All pull requests must be
+accompanied by spec unit tests and up-to-date inline docstrings otherwise the
+pull request will be rejected.