.. raw:: html

  <ul class="breadcrumb">
      <li><a href="../../index.html">Home</a></li>
      <li><a href="../quickstart.html">QuickStarts</a></li>
      <li>Containers</li>
  </ul>

Quick-start - CloudFormation
============================

*****

StorageFabric can be set up using `AWS CloudFormation <https://aws.amazon.com/cloudformation/>`_,
creating cloud instances of a :ref:`glossary-configuration-manager` and :ref:`glossary-proxy`.
CloudFormation can be used to quickly and cost-effectively deploy StorageFabric remotely.

Setting Up StorageFabric CloudFormation
---------------------------------------

Prerequisites
*************


- You must have access to StorageFabric AMIs and CloudFormation template. For more information, see :doc:`../tutorials/getting-access-to-amis`
- You must have an AWS account with sufficient permissions to create StorageFabric EC2 instances. Required permissions are described in the :download:`AMI User Policy JSON <../../_static/ami-user-policy.json>`.
- SSH public key must be added to AWS to access created instances via SSH

Instructions
************

#. Go to the `AWS Management Console <https://aws.amazon.com/cloudformation/>`_ and navigate to CloudFormation.
#. Click the "Create stack" button and select the "new resources" option.
#. Upload the ``cloudformation.yaml`` file provided and click "next".
#. Fill in the stack details page. Refer to the help text in the parameters section for information about each parameter.
#. Optional: specify stack options on the next page, or leave settings with default values.
#. Review settings and create stack. This process will take several minutes.

Troubleshooting information for CloudFormation can be found
in the `AWS Documentation <https://docs.aws.amazon.com/cloudformation/>`_.


Using StorageFabric CloudFormation Instances
------------------------------------------------

Find StorageFabric instance information (IP Address, Public IPv4 DNS, etc.) under the EC2 section of the AWS Console.

Configuration Manager Web/REST API
**********************************

The Configuration Manager Web Interface and API are reachable through the Configuration Manager's public IP address at port 5600. E.g:

``http://123.456.789.012:5600/``

Where ``123.456.789.012`` is the public IPv4 address of the Configuration Manager instance.

For more information on the Configuration Manager REST API, see :doc:`../tutorials/using-the-configuration-rest-api`.

.. note::

  By default EC2 instances do not use SSL (HTTPS) for connections.
  To configure SSL, see :doc:`../tutorials/setting-up-configuration-manager-web-interface-ssl`.


SSH
***

To SSH into the Gateway or Configuration Manager, log in using the ``centos`` user and the Public IPv4 DNS address of the instance.

Below is an example command to SSH into an EC2 instance:

.. parsed-literal::

  ssh centos@ec2-12-345-678-901.compute-1.amazonaws.com

After logging in as the ``centos`` user, you can switch to the ``root`` or ``StorageFabric`` users to further configure StorageFabric.

.. note::
  You muse use the SSL keypair specified during CloudFormation creation to connect. AWS also has additional requirements
  for keys used to connect.

  For further SSH instructions,
  see `EC2 SSH documentation <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html>`_

File Browser
************

The StorageFabric file browser is reachable at the Gateway's public IP address, at port 8000, for example:

``http://123.456.789.012:8000/browser``

For more information on the file browser, see :doc:`../tutorials/using-storagefabric-browser`

System Web/REST API
*******************

To use the System/Setup API and Web Interface, SSH to the Configuration Manager as described above and create a user:

.. parsed-literal::

  sudo -u storagefabric storagefabric-config-users add -u admin -p password

You can use this user to authenticate to the System API and Web Interface. The Web Interface is located at:

``http://123.456.789.012:5600/setup``

For more information on System Web/API, see :doc:`../tutorials/setting-up-system-web-interface`