_site/getting-started/index.html - incubator-ariatosca-website - Git at Google

 <!DOCTYPE html>
 <html>
   <head>
     <meta charset="utf-8">
     <title>Getting Started with ARIA TOSCA • Apache ARIA TOSCA</title>


     	<!-- Twitter Cards -->
 	<meta name="twitter:title" content="Getting Started with ARIA TOSCA">


 	<meta name="twitter:card" content="summary">
 	<meta name="twitter:image" content="/images/aria-icon.png">

 	<!-- Open Graph -->
 	<meta property="og:locale" content="en">
 	<meta property="og:type" content="article">
 	<meta property="og:title" content="Getting Started with ARIA TOSCA">

 	<meta property="og:url" content="/getting-started/">
 	<meta property="og:site_name" content="Apache ARIA TOSCA">

     <link rel="canonical" href="/getting-started/">

     <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Apache ARIA TOSCA Atom Feed">
     <link href="/sitemap.xml" type="application/xml" rel="sitemap" title="Sitemap">

     <meta name="HandheldFriendly" content="True">
     <meta name="MobileOptimized" content="320">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta http-equiv="cleartype" content="on">

     <link rel="stylesheet" href="/css/main.css">
     <!-- HTML5 Shiv and Media Query Support for IE -->
     <!--[if lt IE 9]>
       <script src="/js/vendor/html5shiv.min.js"></script>
       <script src="/js/vendor/respond.min.js"></script>
     <![endif]-->

   </head>

   <body id="js-body">
     <!--[if lt IE 9]><div class="upgrade notice-warning"><strong>Your browser is quite old!</strong> Why not <a href="http://whatbrowser.org/">upgrade to a newer one</a> to better enjoy this site?</div><![endif]-->

     <header id="masthead">
   <div class="inner-wrap">
     <a href="/" class="site-title">Apache ARIA TOSCA</a>
     <nav role="navigation" class="menu top-menu">
         <ul class="menu-item">
 	<li class="home"><a href="/">Apache ARIA TOSCA</a></li>


     <li><a href="/about/" >About</a></li>


     <li><a href="/community/" >Community</a></li>


     <li><a href="/getting-started/" >Getting Started</a></li>


     <li><a href="/roadmap/" >Roadmap</a></li>

 </ul>
     </nav>
   </div><!-- /.inner-wrap -->
 </header><!-- /.masthead -->
     <nav role="navigation" id="js-menu" class="sliding-menu-content">
   <h5>Apache ARIA TOSCA <span>Table of Contents</span></h5>
   <ul class="menu-item">
     <li>
       <a href="/about/">

         <div class="title">About</div>
         <p class="excerpt">About ARIA TOSCA</p>
       </a>
     </li><li>
       <a href="/community/">

         <div class="title">Community</div>
         <p class="excerpt">Joing the ARIA TOSCA Community</p>
       </a>
     </li><li>
       <a href="/getting-started/">

         <div class="title">Getting Started</div>
         <p class="excerpt">Getting started with ARIA TOSCA</p>
       </a>
     </li><li>
       <a href="/roadmap/">

         <div class="title">Roadmap</div>
         <p class="excerpt">Roadmap Features of ARIA TOSCA</p>
       </a>
     </li>
   </ul>
 </nav>
 <button type="button" id="js-menu-trigger" class="sliding-menu-button lines-button x2" role="button" aria-label="Toggle Navigation">
   <span class="nav-lines"></span>
 </button>

 <div id="js-menu-screen" class="menu-screen"></div>


     <div id="page-wrapper">
       <div id="main" role="main">
 	<article class="wrap" itemscope itemtype="http://schema.org/Article">


 		<div class="page-title">
 			<h1>Getting Started with ARIA TOSCA</h1>
 		</div>
 		<div class="inner-wrap">
 			<div id="content" class="page-content" itemprop="articleBody">
 				<h2 id="installation">Installation</h2>

 <p>ARIA is <a href="https://pypi.python.org/pypi/ariatosca">available on PyPI</a>.</p>

 <p>To install ARIA directly from PyPI (using a <code class="highlighter-rouge">wheel</code>), use:</p>

 <div class="highlighter-rouge"><pre class="highlight"><code># pip install aria
 </code></pre>
 </div>

 <p>To install ARIA from source, download the source tarball from
 <a href="https://pypi.python.org/pypi/ariatosca">PyPI</a>, extract it, and then when inside the extracted
 directory, use:</p>

 <div class="highlighter-rouge"><pre class="highlight"><code># pip install .
 </code></pre>
 </div>

 <p>The source package comes along with relevant examples and documentation. Additionally, <code class="highlighter-rouge">requirements.txt</code> is included for
 installing the depending packages with which ARIA was tested.</p>

 <p>Note that for the <code class="highlighter-rouge">pip install</code> commands mentioned above, you must use a privileged user, or use
 virtualenv.</p>

 <p>ARIA itself is in a <code class="highlighter-rouge">wheel</code> format compatible with all platforms. Some dependencies, however,
 might require compilation (based on a given platform), and therefore possibly some system
 dependencies are required as well.</p>

 <p>On Ubuntu or other Debian-based systems::</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
 </code></pre>
 </div>

 <p>On Archlinux::</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>sudo pacman -S python-setuptools
 </code></pre>
 </div>

 <p>ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.</p>

 <h2 id="getting-started-with-aria-tosca">Getting Started with ARIA TOSCA</h2>

 <p>This section will describe how to run a simple “Hello World” example.</p>

 <p>First, provide ARIA with the ARIA “hello world” service-template and name it (e.g.
 <code class="highlighter-rouge">my-service-template</code>)::</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>aria service-templates store examples/hello-world/helloworld.yaml my-service-template
 </code></pre>
 </div>

 <p>Now create a service based on this service-template and name it (e.g. <code class="highlighter-rouge">my-service</code>)::</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>aria services create my-service -t my-service-template
 </code></pre>
 </div>

 <p>Finally, start an <code class="highlighter-rouge">install</code> workflow execution on <code class="highlighter-rouge">my-service</code> like so::</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>aria executions start install -s my-service
 </code></pre>
 </div>

 <p>You should now have a simple web-server running on your local machine. You can try visiting
 <code class="highlighter-rouge">http://localhost:9090</code> to view your deployed application.</p>

 <p>To uninstall and clean your environment, follow these steps::</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>aria executions start uninstall -s my-service
 aria services delete my-service
 aria service-templates delete my-service-template
 </code></pre>
 </div>

 <h2 id="license">License</h2>

 <p>ARIA is licensed under the
 <a href="https://github.com/apache/incubator-ariatosca/blob/master/LICENSE">Apache License 2.0</a></p>

 				<hr />
 				<footer class="page-footer">


 				</footer><!-- /.footer -->
 				<aside>

 				</aside>
 			</div><!-- /.content -->
 		</div><!-- /.inner-wrap -->

 	</article><!-- ./wrap -->
 </div><!-- /#main -->

       <footer role="contentinfo" id="site-footer">
 	<nav role="navigation" class="menu bottom-menu">
 		<ul class="menu-item">


 			<li><a href="/about/" >About</a></li>


 			<li><a href="/Community/" >Community</a></li>


 			<li><a href="/start/" >Getting Started</a></li>


 			<li><a href="/docs/" >Roadmap</a></li>

 		</ul>
 	</nav><!-- /.bottom-menu -->
 	<p class="copyright">ARIA is an agile reference implementation of automation based on OASIS TOSCA Specification. It is a framework for implementing orchestration software and a command line tool to execute TOSCA based application blueprints.</p>
 	<p class="copyright">&#169; 2017 <a href="">Apache ARIA TOSCA</a>.</p>

 </footer>

     </div>

     <script src="/js/vendor/jquery-1.9.1.min.js"></script>
     <script src="/js/main.js"></script>

   </body>

 </html>
	<!DOCTYPE html>
	<html>
	<head>
	<meta charset="utf-8">
	<title>Getting Started with ARIA TOSCA • Apache ARIA TOSCA</title>



	<!-- Twitter Cards -->
	<meta name="twitter:title" content="Getting Started with ARIA TOSCA">




	<meta name="twitter:card" content="summary">
	<meta name="twitter:image" content="/images/aria-icon.png">

	<!-- Open Graph -->
	<meta property="og:locale" content="en">
	<meta property="og:type" content="article">
	<meta property="og:title" content="Getting Started with ARIA TOSCA">

	<meta property="og:url" content="/getting-started/">
	<meta property="og:site_name" content="Apache ARIA TOSCA">

	<link rel="canonical" href="/getting-started/">

	<link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Apache ARIA TOSCA Atom Feed">
	<link href="/sitemap.xml" type="application/xml" rel="sitemap" title="Sitemap">

	<meta name="HandheldFriendly" content="True">
	<meta name="MobileOptimized" content="320">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<meta http-equiv="cleartype" content="on">

	<link rel="stylesheet" href="/css/main.css">
	<!-- HTML5 Shiv and Media Query Support for IE -->
	<!--[if lt IE 9]>
	<script src="/js/vendor/html5shiv.min.js"></script>
	<script src="/js/vendor/respond.min.js"></script>
	<![endif]-->

	</head>

	<body id="js-body">
	<!--[if lt IE 9]><div class="upgrade notice-warning"><strong>Your browser is quite old!</strong> Why not <a href="http://whatbrowser.org/">upgrade to a newer one</a> to better enjoy this site?</div><![endif]-->

	<header id="masthead">
	<div class="inner-wrap">
	<a href="/" class="site-title">Apache ARIA TOSCA</a>
	<nav role="navigation" class="menu top-menu">
	<ul class="menu-item">
	<li class="home"><a href="/">Apache ARIA TOSCA</a></li>


	<li><a href="/about/" >About</a></li>


	<li><a href="/community/" >Community</a></li>


	<li><a href="/getting-started/" >Getting Started</a></li>


	<li><a href="/roadmap/" >Roadmap</a></li>

	</ul>
	</nav>
	</div><!-- /.inner-wrap -->
	</header><!-- /.masthead -->
	<nav role="navigation" id="js-menu" class="sliding-menu-content">
	<h5>Apache ARIA TOSCA <span>Table of Contents</span></h5>
	<ul class="menu-item">
	<li>
	<a href="/about/">

	<div class="title">About</div>
	<p class="excerpt">About ARIA TOSCA</p>
	</a>
	</li><li>
	<a href="/community/">

	<div class="title">Community</div>
	<p class="excerpt">Joing the ARIA TOSCA Community</p>
	</a>
	</li><li>
	<a href="/getting-started/">

	<div class="title">Getting Started</div>
	<p class="excerpt">Getting started with ARIA TOSCA</p>
	</a>
	</li><li>
	<a href="/roadmap/">

	<div class="title">Roadmap</div>
	<p class="excerpt">Roadmap Features of ARIA TOSCA</p>
	</a>
	</li>
	</ul>
	</nav>
	<button type="button" id="js-menu-trigger" class="sliding-menu-button lines-button x2" role="button" aria-label="Toggle Navigation">
	<span class="nav-lines"></span>
	</button>

	<div id="js-menu-screen" class="menu-screen"></div>


	<div id="page-wrapper">
	<div id="main" role="main">
	<article class="wrap" itemscope itemtype="http://schema.org/Article">


	<div class="page-title">
	<h1>Getting Started with ARIA TOSCA</h1>
	</div>
	<div class="inner-wrap">
	<div id="content" class="page-content" itemprop="articleBody">
	<h2 id="installation">Installation</h2>

	<p>ARIA is <a href="https://pypi.python.org/pypi/ariatosca">available on PyPI</a>.</p>

	<p>To install ARIA directly from PyPI (using a <code class="highlighter-rouge">wheel</code>), use:</p>

	<div class="highlighter-rouge"><pre class="highlight"><code># pip install aria
	</code></pre>
	</div>

	<p>To install ARIA from source, download the source tarball from
	<a href="https://pypi.python.org/pypi/ariatosca">PyPI</a>, extract it, and then when inside the extracted
	directory, use:</p>

	<div class="highlighter-rouge"><pre class="highlight"><code># pip install .
	</code></pre>
	</div>

	<p>The source package comes along with relevant examples and documentation. Additionally, <code class="highlighter-rouge">requirements.txt</code> is included for
	installing the depending packages with which ARIA was tested.</p>

	<p>Note that for the <code class="highlighter-rouge">pip install</code> commands mentioned above, you must use a privileged user, or use
	virtualenv.</p>

	<p>ARIA itself is in a <code class="highlighter-rouge">wheel</code> format compatible with all platforms. Some dependencies, however,
	might require compilation (based on a given platform), and therefore possibly some system
	dependencies are required as well.</p>

	<p>On Ubuntu or other Debian-based systems::</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
	</code></pre>
	</div>

	<p>On Archlinux::</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>sudo pacman -S python-setuptools
	</code></pre>
	</div>

	<p>ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.</p>

	<h2 id="getting-started-with-aria-tosca">Getting Started with ARIA TOSCA</h2>

	<p>This section will describe how to run a simple “Hello World” example.</p>

	<p>First, provide ARIA with the ARIA “hello world” service-template and name it (e.g.
	<code class="highlighter-rouge">my-service-template</code>)::</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>aria service-templates store examples/hello-world/helloworld.yaml my-service-template
	</code></pre>
	</div>

	<p>Now create a service based on this service-template and name it (e.g. <code class="highlighter-rouge">my-service</code>)::</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>aria services create my-service -t my-service-template
	</code></pre>
	</div>

	<p>Finally, start an <code class="highlighter-rouge">install</code> workflow execution on <code class="highlighter-rouge">my-service</code> like so::</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>aria executions start install -s my-service
	</code></pre>
	</div>

	<p>You should now have a simple web-server running on your local machine. You can try visiting
	<code class="highlighter-rouge">http://localhost:9090</code> to view your deployed application.</p>

	<p>To uninstall and clean your environment, follow these steps::</p>

	<div class="highlighter-rouge"><pre class="highlight"><code>aria executions start uninstall -s my-service
	aria services delete my-service
	aria service-templates delete my-service-template
	</code></pre>
	</div>

	<h2 id="license">License</h2>

	<p>ARIA is licensed under the
	<a href="https://github.com/apache/incubator-ariatosca/blob/master/LICENSE">Apache License 2.0</a></p>

	<hr />
	<footer class="page-footer">



	</footer><!-- /.footer -->
	<aside>

	</aside>
	</div><!-- /.content -->
	</div><!-- /.inner-wrap -->

	</article><!-- ./wrap -->
	</div><!-- /#main -->

	<footer role="contentinfo" id="site-footer">
	<nav role="navigation" class="menu bottom-menu">
	<ul class="menu-item">


	<li><a href="/about/" >About</a></li>


	<li><a href="/Community/" >Community</a></li>


	<li><a href="/start/" >Getting Started</a></li>


	<li><a href="/docs/" >Roadmap</a></li>

	</ul>
	</nav><!-- /.bottom-menu -->
	<p class="copyright">ARIA is an agile reference implementation of automation based on OASIS TOSCA Specification. It is a framework for implementing orchestration software and a command line tool to execute TOSCA based application blueprints.</p>
	<p class="copyright">© 2017 <a href="">Apache ARIA TOSCA</a>.</p>

	</footer>

	</div>

	<script src="/js/vendor/jquery-1.9.1.min.js"></script>
	<script src="/js/main.js"></script>

	</body>

	</html>