docs/index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="Welcome to the Contiv documentation!">

    <link rel="shortcut icon" href="/assets/images/favicon.png">
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">

    <title>Documentation - Contiv</title>

    <link href="/assets/stylesheets/application-799c3eac.css" rel="stylesheet"/>

    <!--[if lt IE 9]><script src="/assets/javascripts/html5shiv-8b3747c5.js"></script><script src="/assets/javascripts/respond.min-88c91176.js"></script><![endif]-->

    
  </head>

  <body id="page-Documentation" class=" page-Documentation layout-docs page-sub">

<div id="header" class="navbar-static-top">
  <div class="container">
    <div class="row">
      <div class="col-xs-12">
        <div class="navbar-header">
          <div class="navbar-brand">
            <a class="logo" href="/">Contiv</a>
          </div>
          <button class="navbar-toggle" type="button">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <div class="buttons hidden-xs">
          <nav role="navigation">
            <ul class="main-links nav navbar-nav navbar-left">
              <li class="first li-under"><a href="/install/index.html">Getting Started</a></li>
              <li class="li-under"><a href="http://docs.contiv.io/" target="_blank">Docs</a></li>
              <li class="li-under"><a href="/articles/index.html">Articles</a></li>
            </ul>
            <ul class="external-links nav navbar-nav navbar-left">
              <li class="github">
                <a href="https://github.com/contiv" target="_blank">GitHub</a>
              </li>
            </ul>
            <ul class="external-links nav navbar-nav navbar-left">
              <li>
                <a href="https://twitter.com/projectcontiv" target="_blank"><i class="fa fa-twitter"></i></a>
              </li>
            </ul>
          </nav>
        </div>
      </div>
    </div>
  </div>
</div>


<div class="sidebar-overlay"></div>


<aside id="sidebar" class="sidebar sidebar-default sidebar-fixed-right" role="navigation">
    
    <div class="sidebar-header header-cover">
        
        <div class="sidebar-image">
            <img src="/assets/images/logo-header@2x.png" width="49px" height="56px">
        </div>
    </div>

    
    <ul class="main nav sidebar-nav">
        <li class="first"><a href="/intro/index.html">Intro</a></li>
        <li class=""><a href="/docs/index.html">Docs</a></li>
    </ul>
    <div class="divider"></div>
    
    <ul class="external nav sidebar-nav">
        <li class=""><a class="v-btn gray sml" href="https://github.com/contiv"><svg id="svg-download" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 14 14" style="enable-background:new 0 0 14 14;">
  <style>
  </style>
  <path class="" d="M13,0H1C0.5,0,0,0.5,0,1v12c0,0.5,0.5,1,1,1h4.7c0,0,0,0,0-0.1c0-0.2,0-0.6,0-1.1c-1.8,0.4-2.2-0.9-2.2-0.9
    c-0.3-0.8-0.7-1-0.7-1c-0.6-0.4,0-0.4,0-0.4c0.7,0,1,0.7,1,0.7c0.6,1,1.5,0.7,1.9,0.5c0.1-0.4,0.2-0.7,0.4-0.9c-1.5-0.2-3-0.7-3-3.2
    c0-0.7,0.3-1.3,0.7-1.8C3.7,5.8,3.5,5.1,3.9,4.2c0,0,0.6-0.2,1.8,0.7c0.5-0.1,1.1-0.2,1.6-0.2c0.6,0,1.1,0.1,1.6,0.2
    c1.3-0.8,1.8-0.7,1.8-0.7c0.4,0.9,0.1,1.6,0.1,1.7c0.4,0.5,0.7,1,0.7,1.8c0,2.5-1.5,3.1-3,3.2C8.7,11.1,9,11.5,9,12.1
    c0,0.9,0,1.6,0,1.8c0,0,0,0,0,0.1h4c0.5,0,1-0.5,1-1V1C14,0.5,13.5,0,13,0z"/>
</svg>
GitHub</a></li>
    </ul>
</aside>


<div class="container">
	<div class="row">
		<div class="col-md-3 col-sm-3 col-xs-12">
					<div class="docs-sidebar hidden-print affix-top" role="complementary">
			<ul class="nav docs-sidenav">
				<li class="active">
					<a href="/docs/index.html">Documentation Home</a>
				</li>

				<li>
					<a href="/docs/netplugin.html">Contiv Network</a>
				</li>

				<li>
					<a href="/docs/volplugin.html">Contiv Storage</a>
                </li>
			</ul>
		</div>

		</div>  
		<div id="main-content" class="col-sm-9 col-md-9 col-xs-12" role="main">
			<div class="bs-docs-section">
				
	<h1>Contiv Tools</h1>
<p>This page describes the command line user interface for various contiv tools. The CLI
utilizes the REST interface to a cluster-wide master entity that can be accessible to
any automation tool.</p>

<h2>Contiv Networking</h2>
<p><a href="https://github.com/contiv/netplugin">netplugin</a> allows cluster wide connectivity
and policy controls for container networking across a multi-host cluster. If you are
interested in contributing to the project or learn more about the architecture, please
see the <a href="https://github.com/contiv/netplugin/blob/master/README.md">README</a> for
more information.</p>

<h2>Contiv Storage</h2>
<p><a href="https://github.com/contiv/volplugin">volplugin</a> controls
<a href="http://ceph.com/">Ceph</a> RBD devices with a master/slave model to orchestrate
the mounting and cross-host remounting of volumes scheduled with containers.
<strong>This provides highly available, persistent volumes that can live anywhere on
your network, and be referenced by containers for use.</strong> You can control
docker to mount these volumes with a plugin, or you can (soon) use schedulers,
as well as docker-compose to manage your application alongside Ceph volumes.</p>
<p>This documentation is for the users and administrators of volplugin. If you
wish to learn more about the project for development purposes, please see
<a href="https://github.com/contiv/volplugin/blob/master/README.md">the README</a>
for more information.</p>


			</div>
		</div>
	</div>
</div>


<div id="footer">
  <div class="container">
    <div class="row">
      <div class="col-sm-6 col-xs-12">
        <ul class="footer-links nav navbar-nav">
          <li><a href="/install/index.html">Getting Started</a></li>
          <li><a href="http://docs.contiv.io/">Docs</a></li>
          <li><a href="/articles/index.html">Articles</a></li>
          <li><a href="https://github.com/contiv">GitHub</a></li>
        </ul>
      </div>
      <div class="footer-contiv col-sm-6 col-xs-12">
        <div class="pull-right">
          <a class="contiv-project" href="http://contiv.io">
              Contiv
          </a>
        </div>
      </div>
    </div>
  </div>
</div>
</div>

<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

  ga('create', 'UA-74790221-1', 'auto');
  ga('send', 'pageview');

</script>

</body>
</html>