diff --git a/.gitignore b/.gitignore index a480e8525..b9d310b77 100644 --- a/.gitignore +++ b/.gitignore @@ -151,4 +151,9 @@ website/versions-repo /electron/out /electron/dev-ssl /electron/jetstream -/electron/version \ No newline at end of file +/electron/version + +# Packager +/stratos-ui/ +/stratos-ui-packaged.zip + diff --git a/LICENSE b/LICENSE index dd5b3a58a..c100a7a7a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,174 +1,21 @@ - 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. +The MIT License (MIT) + +Copyright (c) 2023 Cloud Foundry Community + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to +deal in the Software without restriction, including without limitation the +rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software.. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +IN THE SOFTWARE. diff --git a/README.md b/README.md index ac285a9c4..6ada21968 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Stratos -  - - -[![GitHub release](https://img.shields.io/github/release/cloudfoundry/stratos.svg)](https://github.com/cloudfoundry/stratos/releases/latest) -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/stratos/blob/master/LICENSE) +  + + +[![GitHub release](https://img.shields.io/github/release/cloudfoundry-community/stratos.svg)](https://github.com/cloudfoundry-community/stratos/releases/latest) +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/cloudfoundry-community/stratos/blob/master/LICENSE) [![slack.cloudfoundry.org](https://slack.cloudfoundry.org/badge.svg)](https://cloudfoundry.slack.com/messages/C80EP4Y57/) Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks. @@ -29,7 +29,64 @@ Tested with Browserstack Browserstack +# Stratos UI pre-packager + + +This feature helps in pre-building the +[Stratos](https://github.com/cloudfoundry-community/stratos) web application +so that it can be deployed faster in Cloud Foundry, or be run offline. + +You can find pre-built versions of Stratos UI in the +[releases](https://github.com/cloudfoundry-community/stratos/releases) +of this repository. + +To run those `.zip` packages inside Cloud Foundry, unzip it, write a manifest, +and `cf push` it. + +You are not required to have +[stratos-buildpack](https://github.com/SUSE/stratos-buildpack), you can use +binary buildpack. + +Here is an example app manifest that worked for us: +```yaml +applications: + - name: console + memory: 128M + disk_quota: 192M + host: console + timeout: 180 + buildpack: binary_buildpack + health-check-type: port +``` + +For best results rather than pushing manually instead use within the (Genesis CF Kit)[https://github.com/genesis-community/cf-genesis-kit] like so: +``` +genesis do stratos sgs +``` +Note: `sgs` creates security groups the first time, upgrades do not use `sgs`. + +## Packaging + +Golang is required, and version 1.12 is recommended as this is the version used by the Stratos build system. + +When you want to build the `4.1.2` tag in +[Stratos UI releases](https://github.com/cloudfoundry-community/stratos/releases), +run this command: + +```bash +./bin/package +``` +OR to package a specific tag +```bash +TAG="4.1.2" ./bin/package +``` + +### NOTE +The original code for this feature can be found in the +[Orange Cloud foundry Github Repository](https://github.com/orange-cloudfoundry/stratos-ui-cf-packager/). +Many thanks to Benjamin & Arthur, we appreciate you both! + ## License -The work done has been licensed under Apache License 2.0. The license file can be found [here](LICENSE). +The work done has been re-licensed under MIT License. The license file can be found [here](LICENSE). diff --git a/bin/package b/bin/package new file mode 100755 index 000000000..6947df69d --- /dev/null +++ b/bin/package @@ -0,0 +1,105 @@ +#!/usr/bin/env bash + +set -euo pipefail + +node::install() { + local download_file + download_file="${TMP_DIR}/node${NODE_VERSION}.tar.gz" + + export node_install_dir="/tmp/node${NODE_VERSION}" + export node_dir="${node_install_dir}/node-v${NODE_VERSION}-linux-x64" + + mkdir -p "${node_install_dir}" + + if [[ ! -f "${node_install_dir}/go/bin/go" ]]; then + NODE_MD5="5bda713bd4aa39394536fc48c744854b" + URL=https://buildpacks.cloudfoundry.org/dependencies/node/node-${NODE_VERSION}-linux-x64-40e8e080.tgz + + echo "-----> Download Nodejs ${NODE_VERSION}" + curl -s -L --retry 15 --retry-delay 2 $URL -o ${download_file} + + DOWNLOAD_MD5=$(md5sum ${download_file} | cut -d ' ' -f 1) + + if [[ ${DOWNLOAD_MD5} != ${NODE_MD5} ]]; then + echo " **ERROR** MD5 mismatch: got $DOWNLOAD_MD5 expected $NODE_MD5" + exit 1 + fi + + tar xzf "${download_file}" -C "${node_install_dir}" + rm "${download_file}" + fi + + if [[ ! -f "${node_dir}/bin/node" ]]; then + echo " **ERROR** Could not download nodejs" + exit 1 + fi + + export NODE_HOME="${node_dir}" +} + +declare git_url git_tag work_dir +declare -x TAG NODE_VERSION TMP_DIR + +git_url="https://github.com/cloudfoundry-community/stratos.git" +git_tag="${TAG:-master}}" +work_dir="${PWD}" +NODE_VERSION="${NODE_VERISON:-8.11.2}" +TMP_DIR=/tmp + +git clone "${git_url}" stratos-ui || true + +if [[ -n ${git_tag} ]]; then + pushd stratos-ui + git checkout "${git_tag}" + export stratos_version="${git_tag}" + popd +fi + +function exit_trap() { + # See: install_nodejs.sh + NODE_VERSION="8.11.2" + rm -rf "/tmp/node${NODE_VERSION}.tar.gz" "/tmp/node${NODE_VERSION}" +} +trap exit_trap EXIT + +if ! which npm > /dev/null; then + node::install + export PATH="${NODE_HOME}/bin:$PATH" +else + npm_location="$(which npm)" + export NODE_HOME="${npm_location%%/bin/npm}" +fi + +mkdir -p cache +build_dir="${work_dir}/stratos-ui" + +# Fix the "authenticity of host can't be established" error during build +ssh-keyscan "bitbucket.org" >> ~/.ssh/known_hosts + +# prebuild ui +cd stratos-ui +npm install +npm run prebuild-ui +rm -Rf ./dist + +# Actually build Stratos +bash -x deploy/cloud-foundry/build.sh "${build_dir}" "${work_dir}/cache" +cd "${work_dir}" + +# Remove build artifacts (node_modules & bower_components) +if [[ -d "${build_dir}/node_modules" ]]; then + rm -rf "${build_dir}/node_modules" +fi + +if [[ -d "${build_dir}/bower_components" ]]; then + rm -rf "${build_dir}/bower_components" +fi + +echo "web: ./deploy/cloud-foundry/start.sh" > "${build_dir}/Procfile" + +ls -lah "${build_dir}" +cd "${build_dir}" +zip -r "${work_dir}}/stratos-ui-packaged.zip" ./* +cd "${work_dir}" + +exit 0