Repository: stratos Updated Branches: refs/heads/master 10cf2da77 -> e99291b8d
Adding and fixing readme for the sample applications Project: http://git-wip-us.apache.org/repos/asf/stratos/repo Commit: http://git-wip-us.apache.org/repos/asf/stratos/commit/dbb0aaf3 Tree: http://git-wip-us.apache.org/repos/asf/stratos/tree/dbb0aaf3 Diff: http://git-wip-us.apache.org/repos/asf/stratos/diff/dbb0aaf3 Branch: refs/heads/master Commit: dbb0aaf34d1f798c23c2bc611bb2b7e58eb2f38a Parents: ac02c04 Author: Vishanth <[email protected]> Authored: Tue May 12 21:26:24 2015 +0530 Committer: Vishanth <[email protected]> Committed: Tue May 12 21:26:24 2015 +0530 ---------------------------------------------------------------------- .../README.md | 38 ++++++++++++++++--- .../complex/tomcat-single-signon/README.md | 32 ++++++++++------ .../complex/wordpress-app/README.md | 23 +++++++---- .../nested/complex-app-with-lb/README.md | 21 ++++++++++ .../README.md | 39 ++++++++++++------- .../five-levels-nested-groups-app/README.md | 40 ++++++++++++++++++++ .../single-level-nested-group-app/README.md | 19 +++++++++- .../single-level-nested-groups-app/README.md | 24 +++++++++++- .../scaling/app-bursting-pattern/README.md | 29 +++++++++++--- .../sample-cartridges/README.md | 16 +++++++- .../dependent-scaling/sample-groups/README.md | 18 ++++++++- .../group-scaling/group-scaling-app/README.md | 11 ++++++ .../group-scaling/group-scaling-v1/README.md | 8 ++++ .../single-group-group-scaling/README.md | 13 +++++++ .../simple/single-cartridge-app/README.md | 27 ++++++++++--- .../simple/single-group-app/README.md | 19 ++++++++-- 16 files changed, 318 insertions(+), 59 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/complex/php-tomcat-group-postgres-mysql-group-esb/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/complex/php-tomcat-group-postgres-mysql-group-esb/README.md b/samples/applications/complex/php-tomcat-group-postgres-mysql-group-esb/README.md index 6cb7cdc..732fd9b 100644 --- a/samples/applications/complex/php-tomcat-group-postgres-mysql-group-esb/README.md +++ b/samples/applications/complex/php-tomcat-group-postgres-mysql-group-esb/README.md @@ -1,10 +1,36 @@ -single_cartridge -================ -i) In this artifact sample you can find we have listed them as mock and openstack. +Composite Application +===================== +This sample can be used to test the startup order pattern. As defined, the application is using dbgroup(mysql, postgres), +app-group(tomcat, php) and esb. +In this case, appgroup and esb are depending on dbgroup. So, dbgroup should start first. +Other two can come up in parallel after dbgroup started. When starting of appgroup, tomcat depends on php. +In that case, tomcat will have to come up first and then php. +By running this sample, this particular scenario can be simulated. -ii) In this sample artifact, it deployes simple application with a php cartridge and start it. +Application View +---------------- +my-compositeapp (php-tomcat-group-postgres-mysql-group-esb) +-- my-compositeapp-1 +-- -- my-esb +-- -- my-dbgroup +-- -- -- my-postgres +-- -- -- my-mysql +-- -- my-appgroup +-- -- -- my-tomcat +-- -- -- my-php -iii) You can choose the IaaS and navigate to it and simply run the single_cartridge.sh file. It'll deploy the relevant artifacts and start the application. +Application folder structure +---------------------------- +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts +How to run +---------- +cd scripts/<iaas>/ +./deploy.sh -This sample can be used to test the startup order pattern. As defined, the application is using dbgroup(mysql, postgres), app-group(tomcat, php) and esb. In this case, appgroup and esb are depending on dbgroup. So, dbgroup should start first. Other two can come up in parallel after dbgroup started. When starting of appgroup, tomcat depends on php. In that case, tomcat will have to come up first and then php. By running this sample, this particular scenario can be simulated. +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/complex/tomcat-single-signon/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/complex/tomcat-single-signon/README.md b/samples/applications/complex/tomcat-single-signon/README.md index 5247a3f..20501dc 100644 --- a/samples/applications/complex/tomcat-single-signon/README.md +++ b/samples/applications/complex/tomcat-single-signon/README.md @@ -1,5 +1,5 @@ -#Tomcat Single Sign On Sample Application - +Tomcat Single Sign-on Application +======================================== This sample application demonstrate how Single Sign On (SAML2) configuration can be automated with Composite Application Model using Tomcat and WSO2 Identity Server. It includes a cartridge for Tomcat 7 and WSO2 Identity Server 5.0.0 and a set of cartridge agent plugins for handling the SSO configuration. @@ -16,15 +16,25 @@ https://github.com/apache/stratos/tree/master/tools/docker-images/cartridge-dock ###WSO2 Identity Server Cartridge Agent Plugins https://github.com/apache/stratos/tree/master/tools/docker-images/cartridge-docker-images/service-images/wso2is-saml-sso/packs/plugins -###Application folder structure -``` -artifacts/<iaas>/ IaaS specific artifacts -scripts/common/ Common scripts for all iaases -scripts/<iaas> IaaS specific scripts -``` +Application view +---------------- +tomcat-single-signon +-- tomcat-single-signon-1 +-- -- mytomcat3 +-- -- mywso2is + +Application folder structure +---------------------------- +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts -###How to run -``` +How to run +---------- cd scripts/<iaas>/ ./deploy.sh -``` \ No newline at end of file + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/complex/wordpress-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/complex/wordpress-app/README.md b/samples/applications/complex/wordpress-app/README.md index 9b61ca1..e5282f2 100644 --- a/samples/applications/complex/wordpress-app/README.md +++ b/samples/applications/complex/wordpress-app/README.md @@ -4,17 +4,26 @@ Wordpress application consists of a cartridge group which includes a MySQL cartr group defines a startup dependency to first start MySQL cluster and then the PHP cluster second once the MySQL cluster is active. Group scaling has been disabled in MySQL, PHP group. +Application View +---------------- +wordpress +-- wordpress-1 +-- -- mysql-php-group +-- -- -- my-php +-- -- -- my-mysql + Application folder structure ---------------------------- -``` -artifacts/<iaas>/ IaaS specific artifacts -scripts/common/ Common scripts for all iaases -scripts/<iaas> IaaS specific scripts -``` +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts How to run ---------- -``` cd scripts/<iaas>/ ./deploy.sh -``` + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/nested/complex-app-with-lb/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/nested/complex-app-with-lb/README.md b/samples/applications/nested/complex-app-with-lb/README.md index daaacc1..057f8de 100644 --- a/samples/applications/nested/complex-app-with-lb/README.md +++ b/samples/applications/nested/complex-app-with-lb/README.md @@ -1,5 +1,21 @@ Complex App with a Load Balancer ================================ +This is a complex application with a load balancer. + +Application View +---------------- +complex-app-with-lb +-- complex-app-with-lb-1 +-- -- my-tomcat +-- -- my-stratos-lb +-- -- my-group8 +-- -- -- my-tomcat2-group8 +-- -- -- my-group9 +-- -- -- -- my-tomcat1-group9 +-- -- my-group6 +-- -- -- my-tomcat2-group6 +-- -- -- my-group7 +-- -- -- -- my-tomcat1-group7 Application folder structure ---------------------------- @@ -11,3 +27,8 @@ How to run ---------- cd scripts/<iaas>/ ./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/nested/esb-php-nested-with-esb-php-nested-with-mysql-php-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/nested/esb-php-nested-with-esb-php-nested-with-mysql-php-app/README.md b/samples/applications/nested/esb-php-nested-with-esb-php-nested-with-mysql-php-app/README.md index af2349a..18fdb2a 100644 --- a/samples/applications/nested/esb-php-nested-with-esb-php-nested-with-mysql-php-app/README.md +++ b/samples/applications/nested/esb-php-nested-with-esb-php-nested-with-mysql-php-app/README.md @@ -1,23 +1,34 @@ -Wordpress Extended V2 Application -================================= -Wordpress extended v2 application consists of a cartridge group which includes a MySQL cartridge and PHP cartridge and -a Tomcat cartridge at the top level. The cartridge group defines a startup dependency to first start MySQL cluster and -then the PHP cluster once the MySQL cluster is active. Group scaling has been enabled in MySQL, PHP group and the -maximum number of group instances has been set to two. The application has defined a startup dependency to first start -the MySQL, PHP group clusters and then the Tomcat cluster. +Complex Nested Application +========================== +This is a complex nested application with three levels of groups and cartridge. +Application View +---------------- +my-esb-php-nested-with-esb-php-nested-with-mysql-php-app +-- esb +-- php +-- esb-php-nested-with-esb-php-nested-with-mysql-php +-- -- esb +-- -- php +-- -- esb-php-nested-with-mysql-php +-- -- -- esb +-- -- -- php +-- -- -- mysql-php +-- -- -- -- mysql +-- -- -- -- php Application folder structure ---------------------------- -``` -artifacts/<iaas>/ IaaS specific artifacts -scripts/common/ Common scripts for all iaases -scripts/<iaas> IaaS specific scripts -``` +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts How to run ---------- -``` cd scripts/<iaas>/ ./deploy.sh -``` + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/nested/five-levels-nested-groups-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/nested/five-levels-nested-groups-app/README.md b/samples/applications/nested/five-levels-nested-groups-app/README.md new file mode 100644 index 0000000..f61ca94 --- /dev/null +++ b/samples/applications/nested/five-levels-nested-groups-app/README.md @@ -0,0 +1,40 @@ +Five Level Nested Group Application +=================================== +This application consists of five levels of cartridge groups with tomcat and php cartridges. + +Application View +---------------- +n-level-nesting (five-levels-nested-groups-app) +-- n-level-nesting-1 +-- -- n-level-nesting-group +-- -- -- level-one-group +-- -- -- -- level-one-group-tomcat +-- -- -- -- level-one-group-esb +-- -- -- -- level-two-group +-- -- -- -- -- level-two-group-tomcat +-- -- -- -- -- level-two-group-esb +-- -- -- -- -- level-three-group +-- -- -- -- -- -- level-three-group-tomcat +-- -- -- -- -- -- level-three-group-esb +-- -- -- -- -- -- level-four-group +-- -- -- -- -- -- -- level-four-group-tomcat +-- -- -- -- -- -- -- level-four-group-esb +-- -- -- -- -- -- -- level-five-group +-- -- -- -- -- -- -- -- level-five-group-tomcat +-- -- -- -- -- -- -- -- level-five-group-esb + +Application folder structure +---------------------------- +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts + +How to run +---------- +cd scripts/<iaas>/ +./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/nested/single-level-nested-group-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/nested/single-level-nested-group-app/README.md b/samples/applications/nested/single-level-nested-group-app/README.md index 1acc75d..e148d97 100644 --- a/samples/applications/nested/single-level-nested-group-app/README.md +++ b/samples/applications/nested/single-level-nested-group-app/README.md @@ -1,5 +1,16 @@ -nested-group -============ +Nested Group Application +======================== +This application consists of a nested group which is a group inside a group. + +Application view +---------------- +nested-group-app (single-level-nested-group-app) +-- nested-group-app-1 +-- -- my-tomcat +-- -- my-group6 +-- -- -- my-tomcat2-group6 +-- -- -- my-group7 +-- -- -- -- my-tomcat1-group7 Application folder structure ---------------------------- @@ -12,3 +23,7 @@ How to run cd scripts/<iaas>/ ./deploy.sh +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/nested/single-level-nested-groups-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/nested/single-level-nested-groups-app/README.md b/samples/applications/nested/single-level-nested-groups-app/README.md index 47015bf..141a8a2 100644 --- a/samples/applications/nested/single-level-nested-groups-app/README.md +++ b/samples/applications/nested/single-level-nested-groups-app/README.md @@ -1,5 +1,20 @@ -Complex App -=========== +Nested Groups Application +========================= +This application consists of two nested groups in the same level. + +Application view +---------------- +complex-app (single-level-nested-groups-app) +-- complex-app-1 +-- -- mytomcat +-- -- my-group8 +-- -- -- my-tomcat2-group8 +-- -- -- my-group9 +-- -- -- -- my-tomcat1-group9 +-- -- my-group6 +-- -- -- my-tomcat2-group6 +-- -- -- my-group7 +-- -- -- -- my-tomcat1-group7 Application folder structure ---------------------------- @@ -11,3 +26,8 @@ How to run ---------- cd scripts/<iaas>/ ./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/scaling/app-bursting-pattern/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/scaling/app-bursting-pattern/README.md b/samples/applications/scaling/app-bursting-pattern/README.md index 8e18c5c..96237ff 100644 --- a/samples/applications/scaling/app-bursting-pattern/README.md +++ b/samples/applications/scaling/app-bursting-pattern/README.md @@ -1,8 +1,27 @@ -app-bursting-pattern -================ -i) In this artifact sample you can find we have listed them as mock and openstack. +App Bursting Pattern Application +================================ -ii) In this sample artifact, it deployed simple tomcat cartridge and start it. -iii) You can choose the IaaS and navigate to it and simply run the single_cartridge.sh file. It'll deploy the relevant artifacts and start the application. +Application view +---------------- +app-bursting-pattern-app +-- app-bursting-pattern-app-1 +-- -- my-php +-- app-bursting-pattern-app-2 +-- -- my-php +Application folder structure +---------------------------- +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts + +How to run +---------- +cd scripts/<iaas>/ +./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/scaling/dependent-scaling/sample-cartridges/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/scaling/dependent-scaling/sample-cartridges/README.md b/samples/applications/scaling/dependent-scaling/sample-cartridges/README.md index 34feba2..7100e99 100644 --- a/samples/applications/scaling/dependent-scaling/sample-cartridges/README.md +++ b/samples/applications/scaling/dependent-scaling/sample-cartridges/README.md @@ -1,5 +1,12 @@ -sample-cartridges -================= +Dependent Scaling With Cartridges Application +============================================= + +Application View +---------------- +dependency-scaling-cartridges-app (sample-cartridges) +-- dependency-scaling-cartridges-app1 +-- -- my-tomcat +-- -- my-php Application folder structure ---------------------------- @@ -11,3 +18,8 @@ How to run ---------- cd scripts/<iaas>/ ./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/scaling/dependent-scaling/sample-groups/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/scaling/dependent-scaling/sample-groups/README.md b/samples/applications/scaling/dependent-scaling/sample-groups/README.md index d1adf79..02f220c 100644 --- a/samples/applications/scaling/dependent-scaling/sample-groups/README.md +++ b/samples/applications/scaling/dependent-scaling/sample-groups/README.md @@ -1,5 +1,14 @@ -sample-groups -============= +Dependent Scaling With Groups Application +========================================= + +Application View +---------------- +dependency-scaling-groups-app (sample-groups) +-- dependency-scaling-groups-app-1 +-- -- my-tomcat +-- -- my-esb-php-group +-- -- -- my-esb +-- -- -- my-php Application folder structure ---------------------------- @@ -11,3 +20,8 @@ How to run ---------- cd scripts/<iaas>/ ./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/scaling/group-scaling/group-scaling-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/scaling/group-scaling/group-scaling-app/README.md b/samples/applications/scaling/group-scaling/group-scaling-app/README.md index 1443d02..331dad3 100644 --- a/samples/applications/scaling/group-scaling/group-scaling-app/README.md +++ b/samples/applications/scaling/group-scaling/group-scaling-app/README.md @@ -1,6 +1,17 @@ Group Scaling =========== +Application view +---------------- +group-scaling +-- group-scaling-1 +-- -- my-c4 +-- -- my-group1 +-- -- -- my-c1-group1 +-- -- -- my-group2 +-- -- -- -- my-c2-group2 +-- -- -- -- my-c3-group2 + Application folder structure ---------------------------- -- artifacts/<iaas>/ IaaS specific artifacts http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/scaling/group-scaling/group-scaling-v1/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/scaling/group-scaling/group-scaling-v1/README.md b/samples/applications/scaling/group-scaling/group-scaling-v1/README.md index 7b09b98..561514b 100644 --- a/samples/applications/scaling/group-scaling/group-scaling-v1/README.md +++ b/samples/applications/scaling/group-scaling/group-scaling-v1/README.md @@ -1,6 +1,14 @@ Group Scaling v1 ================ +Application view +---------------- +group-scaling-v1 +-- group-scaling-v1-1 +-- -- my-group2 +-- -- -- my-c3 +-- -- -- my-c2 + Application folder structure ---------------------------- -- artifacts/<iaas>/ IaaS specific artifacts http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/scaling/group-scaling/single-group-group-scaling/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/scaling/group-scaling/single-group-group-scaling/README.md b/samples/applications/scaling/group-scaling/single-group-group-scaling/README.md index 7ba069c..1177f4c 100644 --- a/samples/applications/scaling/group-scaling/single-group-group-scaling/README.md +++ b/samples/applications/scaling/group-scaling/single-group-group-scaling/README.md @@ -1,6 +1,14 @@ single-group-group-scaling ========================== + +Application view +---------------- +single-group-group-scaling +-- single-group-group-scaling-1 +-- -- my-group6 +-- -- -- my-tomcat + Application folder structure ---------------------------- -- artifacts/<iaas>/ IaaS specific artifacts @@ -11,3 +19,8 @@ How to run ---------- cd scripts/<iaas>/ ./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/simple/single-cartridge-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/simple/single-cartridge-app/README.md b/samples/applications/simple/single-cartridge-app/README.md index 4c13b2c..2fbbb1e 100644 --- a/samples/applications/simple/single-cartridge-app/README.md +++ b/samples/applications/simple/single-cartridge-app/README.md @@ -1,8 +1,25 @@ -single_cartridge -================ -i) In this artifact sample you can find we have listed them as mock and openstack. +Single Cartridge Application +============================ +A simple application with a php cartridge. -ii) In this sample artifact, it deployes simple application with a php cartridge and start it. +Application view +---------------- +single-cartridge-app +-- single-cartridge-app-1 +-- -- my-php -iii) You can choose the IaaS and navigate to it and simply run the single_cartridge.sh file. It'll deploy the relevant artifacts and start the application. +Application folder structure +---------------------------- +-- artifacts/<iaas>/ IaaS specific artifacts +-- scripts/common/ Common scripts for all iaases +-- scripts/<iaas> IaaS specific scripts +How to run +---------- +cd scripts/<iaas>/ +./deploy.sh + +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh \ No newline at end of file http://git-wip-us.apache.org/repos/asf/stratos/blob/dbb0aaf3/samples/applications/simple/single-group-app/README.md ---------------------------------------------------------------------- diff --git a/samples/applications/simple/single-group-app/README.md b/samples/applications/simple/single-group-app/README.md index 294a1a2..a618174 100644 --- a/samples/applications/simple/single-group-app/README.md +++ b/samples/applications/simple/single-group-app/README.md @@ -1,5 +1,15 @@ -single_group_v1 -============== +Single Group Application +======================== +An application with a tomcat cartridge and a cartridge group which consists of esb and php cartridges. + +Application view +---------------- +single-group-app +-- cartridge-group-app-1 +-- -- my-tomcat +-- -- my-esb-php-group +-- -- -- my-esb +-- -- -- my-php Application folder structure ---------------------------- @@ -12,4 +22,7 @@ How to run cd scripts/<iaas>/ ./deploy.sh - +How to undeploy +--------------- +cd scripts/<iaas>/ +./undeploy.sh
