wojons · wojons · Feb 22, 2013 · Mar 27, 2013 · Apr 15, 2013 · Apr 15, 2013
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,16 @@
+/app/etc/.cryptokey
+/app/etc/*.yml
+/app/etc/id
+/app/cache
+/.settings
+/.buildpath
+/.project
+/.idea
+/composer.phar
+/vendor
+/.pydevproject
+.DS_Store
+/nbproject
+/app/python/dist
+/app/python/build
+/app/python/src/ScalrPy.egg-info
diff --git a/CHANGELOG-5.10.md b/CHANGELOG-5.10.md
diff --git a/CHANGELOG-5.11.md b/CHANGELOG-5.11.md
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,8 @@
+Installation Instructions
+=========================
+
+Review the installation instructions in the installer repository:
+[https://github.com/scalr/installer-ng][10]
+
+
+  [10]: https://github.com/scalr/installer-ng
diff --git a/LICENSE b/LICENSE
@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2012 Scalr, Inc.
+   Copyright 2013 Scalr, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -187,4 +187,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.
diff --git a/NOTICE b/NOTICE
diff --git a/NOTICE.md b/NOTICE.md
@@ -0,0 +1,13 @@
+Scalr Cloud Management Software
+Copyright 2012 Scalr Corporation.
+
+This product is proud to use the following open source software:
+
+* ZeroMQ - LGPL - http://zeromq.org/
+* M2Crypto - BSD - http://freshmeat.net/projects/m2crypto/
+* Pexpect - MIT - http://www.noah.org/wiki/Pexpect#License
+* PySNMP - BSD - http://pysnmp.sourceforge.net/
+* ExtJS - GPL - http://www.sencha.com/products/license.php
+* Boto - MIT - http://code.google.com/p/boto/
+* log4php - APL - http://logging.apache.org/log4php/license.html
+* adodb - LGPL - http://adodb.sourceforge.net/
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,100 @@
+**Version**: 5.11
+
+What is Scalr?
+==============
+
+Scalr is an open-source Cloud Management Platform (CMP). It leverages the
+APIs exposed by compatible Cloud Platforms (including AWS, GCE, OpenStack,
+CloudStack, and more) to provide users with a high-level and productive
+interface to their organization's cloud resources.
+
+
+Mission Statement
+=================
+
+Multi-Cloud Support
+-------------------
+
+Scalr provides a single UI, API, and CLI to access resources across any Cloud
+Platform, public or private.
+
+Scalr strives to expose a common set of features across all clouds, but does
+not limit its users to a dumbed-down feature set (e.g. IAM Instance Profiles
+are available through Scalr for AWS, even if they have no equivalent in other
+clouds).
+
+
+High-Level Declarative Primitives rather than Low-Level Imperative Instructions
+-------------------------------------------------------------------------------
+
+Unlike a Cloud Platform's UI or API, Scalr intentionally does not expose the
+ability to imperatively provision resources  (e.g. there is no API call to
+"provision an instance" in Scalr).
+
+Instead, Scalr enables its end-users to declare the infrastructure they'd like
+to deploy through high-level primitives such as Farms, Roles, and Farm Roles
+(*"I'd like this application tier to be deployed in this cloud across 8 to 12
+hosts, each with one data volume"*). In turn, Scalr maintains that state by
+making the appropriate imperative API calls to the underlying Cloud Platforms
+that the user selected (e.g. AWS, OpenStack, ...).
+
+When unexpected conditions arise (e.g. a server crashes or is accidentally
+terminated), Scalr automatically reconciles the resulting infrastructure with
+the specification that was declared by the user (e.g. by provisioning and
+configuring a replacement instance).
+
+We believe (and so do Scalr users) that this encourages end-users to adopt
+cloud architecture best practices that work at scale ("cloud-native") — i.e.
+not to reason about individual resources, but about the overall desired state
+of their infrastructure (a design practice epitomized by the "cattle, not pets"
+motto).
+
+
+Usable by Both Developers and IT
+--------------------------------
+
+Scalr strives to reconcile the needs of both Developers and IT.
+
+At a high-level, developers need self-service, and IT needs control. While the
+two might seem incompatible they usually aren't: developers don't mind
+complying with IT policies; provided that doesn't slow them down.
+
+To that end, Scalr seeks to provide IT with the ability to prepare and
+automatically enforce policies that ensure that every piece of infrastructure
+that developers provision is made compliant with the organization's policies,
+without requiring additional effort on the part of developers.
+
+Using Scalr, this is be achieved through the enforcement of specific cloud
+configurations (e.g. VPC, with Governance), the definition of user-level
+restrictions (Role-Based Access Control), the execution of host-level
+compliance scripts (Global Orchestration), and integration with external
+systems (Webhooks and API).
+
+
+More Information
+----------------
+
+Learn more about Scalr on the [Scalr Website][10].
+
+
+Installation Instructions
+=========================
+
+[Installation instructions for Scalr][20] can be found on the Scalr Wiki.
+
+[Instructions to upgrade from an earlier Scalr version][21] can be found there
+too.
+
+
+-- The Scalr Team
+
+----
+
+*In memory of Alexey Kovalyov.
+Brilliant engineer, caring brother, and most excellent friend.
+This project is dedicated to you.*
+
+[10]: http://www.scalr.com/ "Scalr Product Overview"
+[20]: https://scalr-wiki.atlassian.net/wiki/x/XgQb "Installation Instructions"
+[21]: https://scalr-wiki.atlassian.net/wiki/x/FoAs "Upgrade Instructions"
+
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1,71 @@
+Scalr APIv2 Provisional Documentation
+=====================================
+
+This repository contains provisional documentation for the upcoming Scalr
+APIv2.
+
+**Note that this documentation as well as the API it describes are subject to
+change.**
+
+
+Using this Documentation
+------------------------
+
+### Endpoints ###
+
+The endpoints currently exposed in the API are available under the
+[`doc/autodoc/rest/api/user/v1beta0`](./doc/autodoc/rest/api/user/v1beta0), [`doc/autodoc/rest/api/account/v1beta0`](./doc/autodoc/rest/api/account/v1beta0) paths. Directories map to endpoints,
+and files map to methods.
+
+For example, [`doc/autodoc/rest/api/user/v1beta0/{envId}/events/GET.mkd`](./doc/autodoc/rest/api/user/v1beta0/{envId}/events/GET.mkd)
+is documentation for the `GET` method on the `/api/user/v1beta0/{envId}/events/`
+endpoint.
+
+### Definitions ###
+
+The [`definitions`](./doc/autodoc/definitions) folder includes documentation for the
+objects that are manipulated using the Scalr API.
+
+
+### Authentication ###
+
+If you'd like to write your own API Client, review the documentation under
+[`doc/authentication`](./doc/authentication).
+
+
+Getting Started
+---------------
+
+### Enable APIv2 ###
+
+To get started with APIv2, you should first enable APIv2 in your Scalr install.
+To do so, include the following in your `/etc/scalr-server/scalr-server.rb`
+file:
+
+    app[:configuration] = {
+      :scalr => {
+        :system => {
+          :api => {
+            :enabled => true
+          },
+        },
+      },
+    }
+
+Note that if you already have a `app[:configuration]`, you should instead
+merge this in.
+
+
+### Generate an API Key ###
+
+Login as the user you'd like to access the API as, and access the following
+URL:
+
+    http://your-scalr-host/#/core/api2
+
+Then, generate a new key.
+
+
+### Code Samples ###
+
+Get started with the code samples here: [`samples`](./samples).