Skip to content
This repository has been archived by the owner on Jun 23, 2018. It is now read-only.

Commit

Permalink
Clean up, add definitions, add some info on install
Browse files Browse the repository at this point in the history
  • Loading branch information
script-deployer committed Aug 5, 2016
1 parent 424f2a2 commit 2fe6674
Show file tree
Hide file tree
Showing 14 changed files with 216 additions and 10 deletions.
Binary file modified build/.doctrees/creating_service/index.doctree
Binary file not shown.
Binary file modified build/.doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file modified build/.doctrees/getting_started/installation.doctree
Binary file not shown.
Binary file modified build/.doctrees/index.doctree
Binary file not shown.
3 changes: 3 additions & 0 deletions build/_sources/getting_started/definitions.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. _definitions:


39 changes: 37 additions & 2 deletions build/_sources/getting_started/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,44 @@
Platform Installation
=====================

This page describes installing both the command-line nstack toolkit, and the nstack VM (which your services will live on.)

All releases can be found on the nstack's `release page <http://nstack.com/install>`_.
****
Introduction
****
nstack is comprised of two parts: your nstack machine, which lives as a virtual appliance on your local network or cloud provider, and the nstack toolkit.

The nstack machine is where your services are built, compiled, and executed, whilst the nstack toolkit is used to push services and administer the machine.

As the machine is an appliance, you can run it locally (using something like kvm or virtualbox), or it can be hosted on your cloud provider of choice. You are not limited to one machine: many users have a machine on their cloud provider for production services, and a local machine for testing or staging.

***
Installation
***

..Note: All releases can be found on nstack's `release page <http://nstack.com/install>`_.

To install the machine, browse to nstack's `release page <http://nstack.com/install>`_. We have helpers to let you install it to AWS, or you can download the .iso and host it where you please.

* :ref:`_aws_installation`
* :ref:`_manual_installation`

.. _aws_installation:

***
AWS Installation
***

**TODO**

nstack provides a CloudFormation template to install to your AWS vpc.

***
Manual Installation
***

**TODO**

nstack provides an .iso which you can host on your virtual machine of choice.



92 changes: 92 additions & 0 deletions build/getting_started/definitions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>&lt;no title&gt; &mdash; StackHut 0.1.x documentation</title>

<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1.x',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="StackHut 0.1.x documentation" href="../index.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

</head>
<body role="document">

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<span class="target" id="definitions"></span>

</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/getting_started/definitions.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2015, StackHut.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>

|
<a href="../_sources/getting_started/definitions.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
5 changes: 4 additions & 1 deletion build/getting_started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@
<p>In this section we describe how you can install the nstack toolkit, and use it in the <a class="reference internal" href="tutorial.html#getting-started-tutorial"><span>Tutorial</span></a> to create, deploy and call a simple service.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Platform Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Platform Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#introduction">Introduction</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#creating-a-service">Creating a Service</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial.html#initialise-a-project">Initialise a Project</a></li>
Expand Down
38 changes: 35 additions & 3 deletions build/getting_started/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,49 @@

<div class="section" id="platform-installation">
<span id="getting-started-installation"></span><h1>Platform Installation<a class="headerlink" href="#platform-installation" title="Permalink to this headline"></a></h1>
<p>This page describes installing both the command-line nstack toolkit, and the nstack VM (which your services will live on.)</p>
<p>All releases can be found on the nstack&#8217;s <a class="reference external" href="http://nstack.com/install">release page</a>.</p>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h2>
<p>nstack is comprised of two parts: your nstack machine, which lives as a virtual appliance on your local network or cloud provider, and the nstack toolkit.</p>
<p>The nstack machine is where your services are built, compiled, and executed, whilst the nstack toolkit is used to push services and administer the machine.</p>
<p>As the machine is an appliance, you can run it locally (using something like kvm or virtualbox), or it can be hosted on your cloud provider of choice. You are not limited to one machine: many users have a machine on their cloud provider for production services, and a local machine for testing or staging.</p>
<p><strong>*
Installation
*</strong></p>
<p>..Note: All releases can be found on nstack&#8217;s <a class="reference external" href="http://nstack.com/install">release page</a>.</p>
<p>To install the machine, browse to nstack&#8217;s <a class="reference external" href="http://nstack.com/install">release page</a>. We have helpers to let you install it to AWS, or you can download the .iso and host it where you please.</p>
<blockquote>
<div><ul class="simple">
<li><span class="xref std std-ref">_aws_installation</span></li>
<li><span class="xref std std-ref">_manual_installation</span></li>
</ul>
</div></blockquote>
<p><strong>*
AWS Installation
*</strong></p>
<p><strong>TODO</strong></p>
<p>nstack provides a CloudFormation template to install to your AWS vpc.</p>
<p><strong>*
Manual Installation
*</strong></p>
<p><strong>TODO</strong></p>
<p>nstack provides an .iso which you can host on your virtual machine of choice.</p>
</div>
</div>


</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Platform Installation</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
Expand Down
5 changes: 4 additions & 1 deletion build/objects.inv
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
# Project: StackHut
# Version: 0.1.x
# The remainder of this file is compressed using zlib.
xڭT�n�0 ��+"m�0�����&��;W!�JFҢ����� -,��Nu�����r Q�U���c�d� �\����<�����K5A}�x䒯̆nt�������JO��K�|�B�J��hq�������j�R�&]�� �ހ���jc�R.�����:Ð���ߺ8@1^Q:�����A�Ē��8nj���>���1����%5 �Rq-���q6�m�������.�Py��:l��/*��-��̭��G�]F�NZ��^/��r�Vs�6���_�;ǧH˽����B��6e�k��cє���&4V������Mcv��r�k�כ�ߘW[��5�N b�OkmA<K%_$t1ҩ��I].�iE�e���P*�R�������/ J��{J��%��8�t�)M��s����L���o�W��
xڭT�n�0 ��+lW��u�CW�$;��:Z%;����I��ȩ�CO�����'�p�<�1@z��������7!���y�'k��ѫE��C�����ے������g S��U�J�_�=�������{�_)]x��\���$79SmN`�g)��,:ؾ�ŵ��E:��o�Fd���}|{0�k��\�z�%����q�0�(��ǸW}5պ�A:���J���G�=�ъ����{łk�/���l��;y�ht�m錪˞9�i!�D���#��̓/���1w��\��$m�k��1a{K���s���}���4�a�-$��U�'�i>��n2�Ƅ�jZ�?x; H�h^51�T,N�[==
��1*�[n�A��$����~��Nn��Gp��ڤKg�0`�,�
�4F���>
S�i�a5W�x�u��I�8�"�T _��33W��˟�?�Q9�

0 comments on commit 2fe6674

Please sign in to comment.