Add Pivotal Cloud Foundry source for creating Usergrid Tile ( CF deployment + bosh release )
Project: http://git-wip-us.apache.org/repos/asf/usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/usergrid/commit/29c287b2 Tree: http://git-wip-us.apache.org/repos/asf/usergrid/tree/29c287b2 Diff: http://git-wip-us.apache.org/repos/asf/usergrid/diff/29c287b2 Branch: refs/heads/usergrid-1268-akka-211 Commit: 29c287b22c030164faef4d57e2e7fa51fbaaf2f1 Parents: 8814a14 Author: Michael Russo <[email protected]> Authored: Wed Jun 15 09:21:40 2016 -0700 Committer: Michael Russo <[email protected]> Committed: Wed Jun 15 09:21:40 2016 -0700 ---------------------------------------------------------------------- deployment/pcf/LICENSE | 201 ++++++++ deployment/pcf/README.md | 44 ++ deployment/pcf/addBlobs.sh | 25 + deployment/pcf/apache-usergrid-tile-1.6.yml | 510 +++++++++++++++++++ deployment/pcf/config/blobs.yml | 19 + deployment/pcf/config/final.yml | 24 + deployment/pcf/content_migrations.yml | 53 ++ deployment/pcf/createRelease.sh | 24 + deployment/pcf/createTile.sh | 32 ++ deployment/pcf/jobs/delete-all/monit | 17 + deployment/pcf/jobs/delete-all/spec | 44 ++ .../jobs/delete-all/templates/delete-all.sh.erb | 131 +++++ deployment/pcf/jobs/deploy-all/monit | 18 + deployment/pcf/jobs/deploy-all/spec | 145 ++++++ .../jobs/deploy-all/templates/deploy-all.sh.erb | 384 ++++++++++++++ .../pcf/jobs/docker-bosh-cassandra_docker/monit | 23 + .../pcf/jobs/docker-bosh-cassandra_docker/spec | 26 + .../docker-bosh-cassandra_docker.sh.erb | 69 +++ .../jobs/docker-bosh-elasticsearch_docker/monit | 23 + .../jobs/docker-bosh-elasticsearch_docker/spec | 26 + .../docker-bosh-elasticsearch_docker.sh.erb | 69 +++ .../pcf/packages/cassandra_docker/packaging | 26 + deployment/pcf/packages/cassandra_docker/spec | 26 + deployment/pcf/packages/cf_cli/packaging | 26 + deployment/pcf/packages/cf_cli/spec | 25 + deployment/pcf/packages/common/packaging | 23 + deployment/pcf/packages/common/spec | 25 + .../pcf/packages/elasticsearch_docker/packaging | 26 + .../pcf/packages/elasticsearch_docker/spec | 26 + deployment/pcf/packages/usergrid_app/packaging | 27 + deployment/pcf/packages/usergrid_app/spec | 27 + deployment/pcf/run.sh | 25 + deployment/pcf/src/common/utils.sh | 107 ++++ deployment/pcf/src/templates/all_open.json | 6 + deployment/pcf/src/usergrid_app/manifest.yml | 22 + 35 files changed, 2324 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/usergrid/blob/29c287b2/deployment/pcf/LICENSE ---------------------------------------------------------------------- diff --git a/deployment/pcf/LICENSE b/deployment/pcf/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/deployment/pcf/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + 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. http://git-wip-us.apache.org/repos/asf/usergrid/blob/29c287b2/deployment/pcf/README.md ---------------------------------------------------------------------- diff --git a/deployment/pcf/README.md b/deployment/pcf/README.md new file mode 100644 index 0000000..0a002ed --- /dev/null +++ b/deployment/pcf/README.md @@ -0,0 +1,44 @@ +# Bosh Release + PCF Tile for Apache Usergrid + +This is a bosh release for the apache usergrid. The scripts provided can help create the bosh release and tile for Apache Usergrid. +A version of the tile is available here: https://s3.amazonaws.com/usergrid-v2-public/usergrid_v2.pivotal + +# Components Dependency +* Apache usergrid warfile + Grab the code from: https://github.com/apache/usergrid + Build the war file and save it as ROOT.war +* CF CLI Linux binary + Download the CF CLI linux binary (64 bit) from: https://github.com/cloudfoundry/cli/releases +* ElasticSearch and Cassandra. + Apache Usergrid requires ElasticSearch and Cassandra to search and manage data. + The Bosh release uses dockerized images to run both ElasticSearch and Cassandra. + Create docker images for both elastic search (v1.7) and cassandra (v2.1) and save them locally as tarballs +* Docker Bosh Release + To run docker images within Bosh, we need the docker bosh release. + Download v23 from: http://bosh.io/releases/github.com/cf-platform-eng/docker-boshrelease?all=1 + +# Building Bosh release +* Ensure following files are available at the root of the apache-usergrid-release directory +``` +cf-linux-amd64.tgz # downloaded from CF cli github repo +ROOT.war # built from usergrid repo +cassandra-2.1.tgz # Saved Cassandra 2.1 docker image +elasticsearch-1.7.tgz # Saved ElasticSearch 1.7 docker image +docker-boshrelease-23.tgz # Docker Bosh release v23 +``` +* Run addBlobs.sh + Important to ensure the above blobs filenames match the entries inside the addBlobs.sh (& each of the packages/*/packaging file) +* Run ./createRelease.sh + Edit the version as required inside the script +# Building Tile +* Edit the apache-usergrid-tile-1.6.yml to refer to the correct version of release tarball (for docker bosh release and usergrid) +* Run ./createTile.sh + Edit the file names or versions as needed. + The docker-boshrelease-23.tgz file should be present in the directory to create a valid working tile + The script should create the usergrid.pivotal tile file. + +# Notes +* Ensure the usergrid war file is named ROOT.war (or rename all references of ROOT.war with different file name) before running addBlobs.sh +* If newer versions are being used, please check and replace the associated versions inside packages/<package-name>/spec & packages/<packagge-name>/packaging file to deal with correct files. +* Update the tile metadata file if newer release versions are used +* Update the content_migrations.yml if new tile version is being published http://git-wip-us.apache.org/repos/asf/usergrid/blob/29c287b2/deployment/pcf/addBlobs.sh ---------------------------------------------------------------------- diff --git a/deployment/pcf/addBlobs.sh b/deployment/pcf/addBlobs.sh new file mode 100755 index 0000000..35cdbca --- /dev/null +++ b/deployment/pcf/addBlobs.sh @@ -0,0 +1,25 @@ +#!/bin/bash + +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. The ASF licenses this file to You +# under the Apache License, Version 2.0 (the "License"); you may not +# use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# 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. For additional information regarding +# copyright in this work, please see the NOTICE file in the top level +# directory of this distribution. +# + +bosh add blob ROOT.war usergrid_app +bosh add blob cassandra-2.1.tgz cassandra_docker +bosh add blob elasticsearch-1.7.tgz elasticsearch_docker +bosh add blob cf-linux-amd64.tgz cf_cli +bosh upload blobs
