diff --git a/doc/source/draft/index.rst b/doc/source/draft/index.rst index 45b8056cd..0db0a1ae5 100644 --- a/doc/source/draft/index.rst +++ b/doc/source/draft/index.rst @@ -7,17 +7,37 @@ Welcome to Murano Documentation =============================== -.. TODO add Abstract (OG) +**Murano** is an open source OpenStack project that +combines an application catalog with versatile +tooling to simplify and accelerate packaging and +deployment. It can be used with almost any application +and service in OpenStack, and is extensible to +other clouds. +This documentation guides application developers +through the process of composing an application +package to get it ready for uploading to Murano. -Introduction -~~~~~~~~~~~~ +Besides the deployment rules and requirements, +it contains information on how to manage images, +categories, and repositories using the murano client that +will surely be helpful for cloud administrators. + +It also explains to end users how they can use the catalog +directly from the dashboard. These include guidance on how +to manage applications and environments. + +And of course, it provides information on how to contribute +to the project. + +Introduction to Murano +~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 - intro/whats_murano intro/key_features + intro/target_users intro/architecture intro/use_cases intro/user_stories diff --git a/doc/source/draft/intro/key_features.rst b/doc/source/draft/intro/key_features.rst index 9921a698e..c0642a1fc 100644 --- a/doc/source/draft/intro/key_features.rst +++ b/doc/source/draft/intro/key_features.rst @@ -6,3 +6,91 @@ ============ Key features ============ + +Murano has a number of features designed to +interact with the application catalog, for instance +managing what’s in the catalog, and determining +how apps in the catalog are deployed. + +Application catalog +~~~~~~~~~~~~~~~~~~~ + +#. Easy browsing: + + * Icons display applications for point-and-click + and drag-and-drop selection and deployment. + + * Each application provides configuration information + required for deploying it to a cloud. + + * An application topology of your environment is available + in a separate tab, and shows the number of instances + spawned by each application. + + * The presence of the :guilabel:`Quick Deploy` button + on the applications page saves the time. + +#. Quick filtering by: + + * Tags and words included in application name and description. + * Recent activity. + * Predefined category. + +#. Dependency tracking: + + * Automatic detection of dependent applications that minimizes + the possibility of an application deployment with incorrect + configuration. + + * No underlying IaaS configuration knowledge is required. + + +Application catalog management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Easy application uploading using UI or CLI from: + + * Local zip file. + * URL. + * Package name, using an application repository. + +#. Managing applications include: + + * Application organization in categories or transfer between them. + * Application name, description and tags update. + * Predefined application categories list setting. + +#. Deployment tracking includes the availability of: + + * Logs for deployments via UI. + * Deployment modification history to track the recent changes. + + +Application lifecycle management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Simplified configuration and integration: + + * It is up to an application developer to decide what their application + will be able to do. + + * Dependencies between applications are easily configured. + + * New applications can be connected with already existing ones. + + * Well specified application actions are available. + +#. HA-mode and auto-scaling: + + * Application authors can set up any available monitoring system to track + application events and call corresponding actions, such as + failover, starting additional instances, and others. + +#. Isolation: + + * Applications in the same environments can easily interact with + each other, though applications between different tenants are isolated. + + + + diff --git a/doc/source/draft/intro/target_users.rst b/doc/source/draft/intro/target_users.rst new file mode 100644 index 000000000..d6b19551f --- /dev/null +++ b/doc/source/draft/intro/target_users.rst @@ -0,0 +1,54 @@ +.. _target_users: + +============ +Target Users +============ + +Cloud end users want to simply use applications as +opposed to installing and managing them. Cloud administrators, +in turn, would like to offer a well tested set of on demand +self-service applications to dramatically reduce their support burden. + +Murano solves the problems of both constituents. +It enables cloud administrators to publish cloud-ready +applications in an online catalog. Cloud end users can use +the catalog to deploy these on demand applications, reliably +and consistently, with a button click. + + +Cloud administrators +~~~~~~~~~~~~~~~~~~~~ + +For cloud administrators Murano provides UI and +API to easily compose, deploy, run applications, and manage +their lifecycle. + +Designed to be operating system independent, it can handle apps on all +manner of the environments in the cloud, either Windows +or Linux/Unix-based operating systems. + +It can be used to pre-configure and deploy anything that can +run in the cloud, +from low-level networking services to end-user applications. +By automating these ongoing cloud application management +activities, Murano speeds up the deployment, even for complex +distributed applications, without sacrificing simplicity +of use. + + + +Cloud end users +~~~~~~~~~~~~~~~ + +Murano catalog lets cloud end users choose +from the available applications and services, and compose +reliable distributed environments with an intuitive UI. +Even users unfamiliar with cloud environments can easily +deploy cloud-aware applications. + +Murano masks cloud-infrastructure specifics from end +users, letting them reliably compose and deploy +applications in the cloud for the widest range of +workloads and use cases without touching IaaS internals. + + diff --git a/doc/source/draft/intro/whats_murano.rst b/doc/source/draft/intro/whats_murano.rst deleted file mode 100644 index aa6b4efd9..000000000 --- a/doc/source/draft/intro/whats_murano.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _whats-murano: - -=============== -What is Murano? -===============