Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updating the documentation to reflect release suggestions

  • Loading branch information...
commit ae63545f369b15eeef27bacfed03a512334afc50 1 parent e52b916
@buzztroll buzztroll authored
View
2  phantom/arch.rst
@@ -2,7 +2,7 @@
Architecture
===========
-Those interested in how the Nimbus Auto-scale service works under
+Those interested in how the Nimbus Phantom service works under
the hood will find this page helpful. Here we will provide a quick
introduction to how the service works.
View
19 phantom/faq.rst
@@ -1,15 +1,16 @@
===========================================
-Nimbus Auto-scale Frequently Asked Questions
+Nimbus Phantom Frequently Asked Questions
===========================================
.. contents::
:local:
-What is the Auto-scale Service?
-==============================
+What is the Nimbus Phantom Service?
+===================================
-The Auto-scaling service is software-as-a-service for the scientific community.
+The Nimbus Phantom service is software-as-a-service for the
+scientific community.
The goal of this service is to make it easier to use the cloud for scientific
applications. Virtualization adds amazing elastic scaling
possibilities that scientific applications can leverage. However, in the
@@ -96,16 +97,6 @@ How can I get a FutureGrid account?
You can apply for a `FutureGrid <http://www.futuregrid.org>`_ account
`here <https://portal.futuregrid.org/user/register>`_.
-Can I automatically scale my VMs based on a policy?
-===================================================
-
-This is definitely possible and is the ultimate goal of Phantom. In
-the 0.1 release of Phantom the user must run their own policy engine.
-The user is responsible for having their own software running and monitoring
-their workload. When that workload is too heavy or too light that software
-can tell Phantom to make the needed adjustment. In future releases we
-plan to have software that will help the user create such policies.
-
What are the planned future features?
=====================================
View
19 phantom/index.rst
@@ -1,24 +1,25 @@
-================
-Nimbus Auto-scale
-================
+==============
+Nimbus Phantom
+==============
-This guide contains configuration information about the Nimbus Auto-scale
+Provisioning new resources to counteract failures or cater to increasing
+demand requires constant attention and is a repetitive task that
+can be automated.
+Nimbus Phantom monitors the health and happiness of your resources and
+automatically provisions and configures new ones based on demand.
+
+This guide contains configuration information about the Nimbus Phantom
service. This service dynamically scales and preserves VMs for users.
It currently is running and available on
`FutureGrid <http://www.futuregrid.org/>`_ allowing users to scale
VMs that are running on the many clouds of FutureGrid.
-This service is similar to the Amazon Auto-scaling Service. However there
-are some minor differences. This service only implements a subset of
-the AWS functionality. Details can be found here.
-
.. toctree::
:maxdepth: 1
quickstart
webapp
protocol
- arch
scripting
faq
View
10 phantom/protocol.rst
@@ -1,8 +1,8 @@
=========================
-Nimbus Auto-scale protocol
+Nimbus Phantom protocol
=========================
-The Nimbus Auto-scale service implements a subset of the
+The Nimbus Phantom service implements a subset of the
`AWS Auto Scaling service <http://aws.amazon.com/autoscaling/>`_.
It is a REST API that allows users to interact with a service which
will monitor the health of VMs and preserve N VMs at one time on
@@ -11,13 +11,13 @@ various different clouds.
REST API
========
-The AWS protocol on which the Nimbus Auto-scale service is based is
+The AWS protocol on which the Nimbus Phantom service is based is
well documented
`here <http://docs.amazonwebservices.com/AutoScaling/latest/APIReference/>`_.
Understanding how the AWS service works is not necessary to understand
the Nimbus service; however, since the two services are wire protocol
compatible, it is helpful to understand the subset of commands
-which have been implemented by the Nimbus Auto-scaling service:
+which have been implemented by the Nimbus Phantom service:
* ``CreateLaunchConfiguration``. This API call allows a user to
@@ -26,7 +26,7 @@ which have been implemented by the Nimbus Auto-scaling service:
key. It describes the details of every VM instance
that will be launched in a group. An important difference between
the Nimbus system and the AWS protocol is the name given to a launch
- configuration. On Nimbus Auto-scale you must use the following naming convention:
+ configuration. On Nimbus Phantom you must use the following naming convention:
<unique user selected name>@<target cloud name>. The
user selected name can be anything the user wishes, but it must be
unique. The cloud name must be one of the Nimbus Futuregrid clouds:
View
2  phantom/webapp.rst
@@ -2,7 +2,7 @@
Web Application
===============
-The best way to get familiar with the Nimbus Auto-scale service is to
+The best way to get familiar with the Nimbus Phantom service is to
check out the web application
`here <https://svc.uc.futuregrid.org:8440/phantom>`_.
Please sign in to comment.
Something went wrong with that request. Please try again.