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

Commit

Permalink
Changes to be releasable
Browse files Browse the repository at this point in the history
  • Loading branch information
Leo Anthias committed Feb 19, 2017
1 parent fa528b8 commit e779e71
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 20 deletions.
5 changes: 2 additions & 3 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
nstack Documentation
NStack Documentation
====================================

Contents:
Welcome to the NStack Documentation!

.. toctree::
:maxdepth: 2
Expand All @@ -16,7 +16,6 @@ Contents:
installation
quick_start/index
architecture
examples/index
reference/index


40 changes: 35 additions & 5 deletions installation.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,38 @@
Installation
Installation & Upgrading
************

.. _what_is_nstack:
**Where does NStack live?**
.. _installation:

Installation
===========

NStack can run out of the box, either on:
- your cloud provider of choice
- your internal cloud
- locally using VirtualBox, VMWare, or your operating system's native virtualisation

For Proof of Concepts, NStack offers a hosted solution. If this is required, please `get in touch <help@nstack.com>`_.

.. note:: For more information on NStack's architecture, see :ref:`Architectural Overview<_architecture>`

The virtual appliance can be found on the NStack's `GitHub Releases page <http://github.com/nstackcom/nstack-releases/releases>`_, where is is provided as a ``raw`` or ``qcow2`` image.

The `NStack Server` is configured using ``cloud-init``, which is supported by major cloud providers.

Upgrading
========

The `NStack Server` can be update atomically using `rpm-ostree`. To upgrade to a new release, you can simply run:

.. code:: bash
> sudo rpm-ostree upgrade
Following the upgrade, you should reboot your machine with:

.. code:: bash
> sudo reboot
NStack releases follow a monthly cadence.

**Productionise Code**
**Build Workflows**
4 changes: 1 addition & 3 deletions overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@
Why NStack?
===============

Productionise your data-driven code without an engineering team or complex infrastructure.

Deploy workloads as safe, reusable, and reliable modules. Integrate with your existing data stores and event sources. Combine and compose powerful workflows quickly and effortlessly.
Productionise data-driven code without an engineering team or complex infrastructure. Deploy workloads as reusable, reliable modules and effortlessly compose workflows to integrate them with your existing data stores and event sources.
5 changes: 2 additions & 3 deletions quick_start/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
Quick Start
******************

In this section, we're going to see how to build up a simple NStack module, deploy it to the cloud, and connect it to a source and a sink.
In this section, we're going to see how to build up a simple NStack module, deploy it to the cloud, and use it in a workflow by connecting it to a `source` and a `sink`.

::note To learn more about modules, sources, and sinks, read :ref:`Concepts<_concepts>`
.. note:: To learn more about modules, sources, and sinks, read :doc:`Concepts<_concepts>`

Make sure you have :doc:`installed NStack </installation>` and let's get going.

.. toctree::

module
workflow
starting
12 changes: 6 additions & 6 deletions quick_start/module.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _module:

Writing your module
Writing your Module
=========================

:ref:`NStack modules <module>` contain the methods that can be used on the NStack platform. They are the building blocks which can be used to build workflows and applications.
Expand All @@ -17,7 +17,7 @@ We want to create a new Python module.

Create a directory called ``demo`` where you would like to build your module (NStack uses the name of the directory as the default name of the module) and ``cd`` into that directory using your terminal.

To do so, type ``nstack init python`` in the terminal.
To create a new module, run ``nstack init python``.
You should see the following output confirming that this operation was successful.

.. code:: bash
Expand All @@ -37,17 +37,17 @@ A successful ``init`` will have created some files in the directory.
> ls
nstack.yaml requirements.txt service.py setup.py
This is the skeleton of an NStack module. Modules comprise a configuration file -- `nstack.yaml` -- and your business logic, e.g. some Python code.
This is the skeleton of an NStack module. Modules comprise of a configuration file -- `nstack.yaml` -- and your business logic, e.g. some Python code.

.. When we `build` a module, NStack deploys the code to the cloud and expose the functions in your business-logic which you specified in your configuration.
.. ``ls`` shows us:
We're going to be concerned with ``nstack.yaml`` and ``service.py``.
(For a more in-depth look at all these files, refer to :doc:`Module Structure </reference/module_structure>`)
For a more in-depth look at all these files, refer to :doc:`Module Structure </reference/module_structure>`

``service.py`` is where the business logic of your Python module lives. This is just Python as you would normally write it, with a ``Service`` class that contains methods we want to call. NStack prefills it with a sample method, ``numChars``, that counts the number of characters in some text.
``service.py`` is where the business logic of your Python module lives. This is just Python as you would normally write it, with a ``Service`` class that contains the methods we want to call. NStack prefills it with a sample method, ``numChars``, that counts the number of characters in some text.

.. code:: python
Expand Down Expand Up @@ -119,5 +119,5 @@ We can check that our ``numChars`` method is live by running the suggested ``nst
~/demo> nstack list methods
demo.numChars : Text -> Integer
Now that our method is live on NStack, we can attach it to a event *source* and an event *sink* using NStack's Workflow Language.
Now that our ``numChars`` method is live on NStack, we can attach it to a event *source* and an event *sink* using NStack's Workflow Language.

0 comments on commit e779e71

Please sign in to comment.