├── .ydocker.conf ├── Dockerfile ├── LICENSE ├── README.md └── ydocker /.ydocker.conf: -------------------------------------------------------------------------------- 1 | DOCKER_IMAGE_NAME=sap-hybris-commerce-suite 2 | COMMERCE_SUITE_VERSION=latest 3 | ARTIFACT_TYPE=release 4 | RECIPE=b2c_acc 5 | HOST_PORT=9002 6 | CONTAINER_PORT=9002 7 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:14.04 2 | MAINTAINER pwittchen 3 | USER root 4 | 5 | # input arguments required to access artifactory 6 | ARG SAP_USERNAME 7 | ARG SAP_PASSWORD 8 | ARG COMMERCE_SUITE_DOWNLOAD_URL 9 | ARG RECIPE 10 | 11 | # install java 12 | RUN apt-get update 13 | RUN apt-get install software-properties-common -y 14 | RUN add-apt-repository ppa:webupd8team/java -y 15 | RUN apt-get update 16 | RUN echo debconf shared/accepted-oracle-license-v1-1 select true | debconf-set-selections 17 | RUN apt-get install oracle-java8-installer -y 18 | RUN apt-get install oracle-java8-set-default 19 | ENV JAVA_HOME=/usr/lib/jvm/java-8-oracle 20 | 21 | # install tools 22 | RUN apt-get install -y wget ant maven gradle 23 | 24 | # set variable for hybris directory 25 | ENV yHYBRIS_DIR="/home/sap-hybris-commerce-suite" 26 | 27 | # download and extract hybris commerce suite 28 | RUN mkdir -p $yHYBRIS_DIR 29 | RUN wget --http-user=${SAP_USERNAME} --http-password=${SAP_PASSWORD} ${COMMERCE_SUITE_DOWNLOAD_URL} 30 | RUN unzip *.zip -d $yHYBRIS_DIR 31 | RUN rm *.zip 32 | 33 | # install hybris recipe 34 | RUN $yHYBRIS_DIR/installer/install.sh -r ${RECIPE} 35 | 36 | # build and initialize the platform 37 | RUN cd $yHYBRIS_DIR/hybris/bin/platform 38 | RUN ant -f $yHYBRIS_DIR/hybris/bin/platform/build.xml clean all 39 | RUN ant -f $yHYBRIS_DIR/hybris/bin/platform/build.xml initialize 40 | 41 | # expose server port 42 | EXPOSE 9002 43 | 44 | # start the hybris platform 45 | CMD cd $yHYBRIS_DIR/hybris/bin/platform/ && ./hybrisserver.sh 46 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ydocker 2 | ======= 3 | 4 | get, build, initialize and run [SAP Hybris Commerce Suite](https://www.hybris.com/en/commerce) inside [Docker](https://www.docker.com/) container 5 | 6 | **It's unofficial PoC for experimental purposes! It's not supported by SAP Hybris! Do NOT use it in production!** 7 | 8 | Read [a blog post about dockerizing Hybris](http://wittchen.io/2016/07/27/dockerizing-hybris/). 9 | 10 | **Please note**: Since version 6.3 Hybris has built-in recipes with Docker support and it's recommended solution. This repository contains only unofficial Proof of Concept with development setup. 11 | 12 | Contents 13 | -------- 14 | - [Quick start](#quick-start) 15 | - [Usage](#usage) 16 | - [Installing Docker](#installing-docker) 17 | - [Ubuntu](#ubuntu) 18 | - [macOS](#macos) 19 | - [Resolving problems with Docker](#resolving-problems-with-docker) 20 | - [Server endpoints](#server-endpoints) 21 | - [Platform build version](#platform-build-version) 22 | - [Remarks](#remarks) 23 | - [Testing](#testing) 24 | - [References](#references) 25 | - [General links](#general-links) 26 | - [Similar projects](#similar-projects) 27 | - [License](#license) 28 | 29 | Quick start 30 | ----------- 31 | 32 | If you have already [installed Docker](#installing-docker) and Git, just open the terminal and do the following things: 33 | 34 | ```shell 35 | git clone https://github.com/pwittchen/ydocker.git 36 | cd ydocker/ 37 | ./ydocker -b 38 | ``` 39 | 40 | Provide your credentials and wait while container is being created. It may take about 30 minutes or more. 41 | 42 | When it's done, run the server with the following command: 43 | 44 | ```shell 45 | ./ydocker -r 46 | ``` 47 | 48 | Wait a while, let the server to start up and then check if everything works by visitng the following URL: 49 | 50 | ``` 51 | https://localhost:9002/backoffice 52 | ``` 53 | 54 | That's it! 55 | 56 | Usage 57 | ----- 58 | 59 | If you haven't installed Docker yet, go to the section about [installing Docker](#installing-docker) first. 60 | 61 | You can use helper shell script called `ydocker` with the following parameters: 62 | 63 | ``` 64 | -b building Docker container 65 | -r running Hybris Server in Docker container 66 | -c running Docker container with CLI 67 | -i showing info about Docker container 68 | -u showing Commerce Suite Download Url 69 | -d deleting Docker container 70 | -h showing help 71 | ``` 72 | 73 | Inside `.ydocker.conf` file you can view or customize the following parameters: 74 | - Docker image name 75 | - Commerce Suite version (set `latest` to keep your software fresh - you can also set specific version like `6.2`; in the latest releases versioning style was changed, so `latest` may not refer to the latest version - it's recommended to specify the concrete version - e.g. `18.08`) 76 | - Artifact type (`snapshot` or `release`) 77 | - Recipe 78 | - Host port 79 | - Container port 80 | 81 | Please remember that you need to have your own SAP e-mail and password 82 | in order to be able to download SAP Hybris Commerce Suite from Hybris repository inside Docker container. 83 | 84 | Installing Docker 85 | ----------------- 86 | 87 | If you haven't installed Docker yet, follow instructions below. 88 | 89 | ### Ubuntu 90 | 91 | If you are using Ubuntu Linux and want to install Docker, follow official instructions for [Installation on Ubuntu](https://docs.docker.com/engine/installation/linux/ubuntulinux/) from the Docker website. 92 | 93 | ### macOS 94 | 95 | If you are using macOS and want to install Docker, get [**Docker for Mac**](https://docs.docker.com/docker-for-mac/) from the official Docker website. 96 | 97 | Resolving problems with Docker 98 | ------------------------------ 99 | 100 | When you get the following message: `cannot connect to docker daemon`: 101 | - Make sure that Docker daemon is running by typing: `sudo service docker status` 102 | - If Docker daemon is stopped, type: `sudo service docker start` 103 | - Type `sudo` before **every** Docker command (works on Ubuntu Linux) 104 | 105 | When you get the following message: `port is already allocated`: 106 | - Restart Docker daemon by typing: `sudo service docker restart` and run container again (works on Ubuntu Linux) 107 | 108 | Server endpoints 109 | ---------------- 110 | - Hybris Administration Console (HAC): `https://localhost:9002/` 111 | - Backoffice: `https://localhost:9002/backoffice` 112 | - B2C accelerator: `https://localhost:9002/yacceleratorstorefront/en/?site=apparel-uk&clear=true` 113 | 114 | Platform build version 115 | ---------------------- 116 | 117 | To get information about build and version of the platform inside created container, use the following commands: 118 | 119 | ``` 120 | ./ydocker -c 121 | cat /home/sap-hybris-commerce-suite/hybris/bin/platform/build.number 122 | ``` 123 | 124 | Remarks 125 | ------- 126 | 127 | This repository does not contain any source code or libraries of SAP Hybris Commerce Suite. 128 | It just downloads them, if you provide valid credentials to the shell script. 129 | You should have such credentials if you're company employee or partner. 130 | You'll need a lot of space on disk (probably about 12 GB, but I think 15 GB is safe number), because Commerce Suite is huge project. Size of built container is 6.8 GB. 131 | Moreover, **it's not official company's repository**. 132 | It's just proof of concept and may be not fully functional and stable. 133 | 134 | Testing 135 | ------- 136 | 137 | This solution was tested on the following systems: 138 | - Ubuntu Linux 14.04 LTS 139 | - OS X El Capitan 10.11.6 140 | 141 | Building container and running the application went fine. Docker was installed according to the official instructions. 142 | 143 | References 144 | ---------- 145 | 146 | ### General links 147 | - https://github.com/pwittchen/learning-docker 148 | - https://github.com/wsargent/docker-cheat-sheet 149 | - http://wittchen.io/2016/07/27/dockerizing-hybris/ 150 | - https://github.com/pwittchen/ydownloader 151 | 152 | ### Similar projects 153 | - https://github.com/stefanleh/hybris-base-image 154 | - https://github.com/stefanleh/hybris-mysql 155 | - https://github.com/stefanleh/hybris-datahub-mysql 156 | - https://github.com/debianmaster/docker-hybris 157 | - https://github.com/prelegalwonder/hybris-docker 158 | - https://github.com/mlong168/hybris-docker 159 | - https://github.com/mcastellin/docker-hybris 160 | 161 | License 162 | ------- 163 | 164 | Copyright 2016 Piotr Wittchen 165 | 166 | Licensed under the Apache License, Version 2.0 (the "License"); 167 | you may not use this file except in compliance with the License. 168 | You may obtain a copy of the License at 169 | 170 | http://www.apache.org/licenses/LICENSE-2.0 171 | 172 | Unless required by applicable law or agreed to in writing, software 173 | distributed under the License is distributed on an "AS IS" BASIS, 174 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 175 | See the License for the specific language governing permissions and 176 | limitations under the License. 177 | -------------------------------------------------------------------------------- /ydocker: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -e # automatically exit script on error 4 | 5 | source .ydocker.conf # load configuration 6 | 7 | function showHelp() { 8 | echo " 9 | ydocker is a script responsible 10 | for building and running SAP Hybris Commerce Suite 11 | in a Docker container 12 | 13 | Usage: 14 | -b building Docker container 15 | -r running Hybris Server in Docker container 16 | -c running Docker container with CLI 17 | -i showing info about Docker container 18 | -u showing Commerce Suite Download Url 19 | -d deleting Docker container 20 | -h showing help 21 | " 22 | } 23 | 24 | function setCommerceSuiteVersionIfNecessary() { 25 | if [ "$COMMERCE_SUITE_VERSION" == "latest" ] 26 | then 27 | COMMERCE_SUITE_VERSION="" # when we leave this variable empty, we'll get the latest suite 28 | fi 29 | } 30 | 31 | function setUsernameAndPassword() { 32 | echo -n "SAP username (e-mail): " 33 | read username 34 | echo -n "SAP password: " 35 | read -s password 36 | } 37 | 38 | function setCommerceSuiteDownloadUrl { 39 | setCommerceSuiteVersionIfNecessary 40 | setUsernameAndPassword 41 | 42 | echo $'\ngetting Commerce Suite download url from Artifactory...' 43 | 44 | # get first endpoint for downloading Commerce Suite through Artifactory REST API 45 | COMMERCE_SUITE_DOWNLOAD_URL_PREPARATION=`curl -s -u $username:$password \ 46 | https://repository.hybris.com/api/search/artifact\?name\=commerce-suite-$COMMERCE_SUITE_VERSION\&repos\=hybris-$ARTIFACT_TYPE \ 47 | | python -mjson.tool | grep zip | tail -1 | awk '{print $2}' | sed -e 's/^"//' -e 's/"$//'` 48 | 49 | # get exact url of Commerce Suite from previously extracted endpoint 50 | COMMERCE_SUITE_DOWNLOAD_URL=`curl -s -u $username:$password $COMMERCE_SUITE_DOWNLOAD_URL_PREPARATION \ 51 | | python -mjson.tool | grep downloadUri | tail -1 | awk '{print $2}' | sed -e 's/^"//' -e 's/"$//' | rev | cut -c 3- | rev` 52 | } 53 | 54 | function showCommerceSuiteDownloadUrl() { 55 | setCommerceSuiteDownloadUrl 56 | echo $COMMERCE_SUITE_DOWNLOAD_URL 57 | } 58 | 59 | function buildDockerImage() { 60 | setCommerceSuiteDownloadUrl 61 | 62 | sudo docker build --build-arg SAP_USERNAME="$username" \ 63 | --build-arg SAP_PASSWORD="$password" \ 64 | --build-arg COMMERCE_SUITE_DOWNLOAD_URL="$COMMERCE_SUITE_DOWNLOAD_URL" \ 65 | --build-arg RECIPE="$RECIPE" \ 66 | -t "$DOCKER_IMAGE_NAME" . 67 | } 68 | 69 | function runDockerImageServer() { 70 | sudo docker run -p 127.0.0.1:"$HOST_PORT":"$CONTAINER_PORT" -t "$DOCKER_IMAGE_NAME" 71 | } 72 | 73 | function runDockerImageCli() { 74 | sudo docker run -i -t "$DOCKER_IMAGE_NAME" /bin/bash 75 | } 76 | 77 | function showDockerImageInfo() { 78 | sudo docker images | grep "$DOCKER_IMAGE_NAME" 79 | } 80 | 81 | function deleteDockerImage() { 82 | sudo docker rmi -f "$DOCKER_IMAGE_NAME" 83 | } 84 | 85 | OPTIND=1 # Reset in case getopts has been used previously in the shell. 86 | 87 | while getopts "hbrciud" opt; do 88 | case "$opt" in 89 | h) 90 | showHelp 91 | exit 0 92 | ;; 93 | b) buildDockerImage 94 | ;; 95 | r) runDockerImageServer 96 | ;; 97 | c) runDockerImageCli 98 | ;; 99 | i) showDockerImageInfo 100 | ;; 101 | u) showCommerceSuiteDownloadUrl 102 | ;; 103 | d) deleteDockerImage 104 | ;; 105 | esac 106 | done 107 | 108 | shift $((OPTIND-1)) 109 | 110 | [ "$1" = "--" ] && shift 111 | --------------------------------------------------------------------------------