From 2e8471f2a3632c51be7b248892b2ef2b1d6183a1 Mon Sep 17 00:00:00 2001 From: Chiranga Alwis Date: Fri, 13 Mar 2020 00:27:40 +0530 Subject: [PATCH] Align Docker Compose resources with WSO2 Software License --- docker-compose/integrator-analytics/README.md | 82 ++++++++++--------- .../integrator-analytics/docker-compose.yml | 8 +- .../integrator-analytics/scripts/README.md | 43 ---------- .../integrator-analytics/scripts/deploy.sh | 71 ---------------- .../integrator-broker-analytics/README.md | 68 ++++++++------- .../docker-compose.yml | 10 +-- .../scripts/README.md | 44 ---------- .../scripts/deploy.sh | 72 ---------------- 8 files changed, 91 insertions(+), 307 deletions(-) delete mode 100755 docker-compose/integrator-analytics/scripts/README.md delete mode 100755 docker-compose/integrator-analytics/scripts/deploy.sh delete mode 100755 docker-compose/integrator-broker-analytics/scripts/README.md delete mode 100755 docker-compose/integrator-broker-analytics/scripts/deploy.sh diff --git a/docker-compose/integrator-analytics/README.md b/docker-compose/integrator-analytics/README.md index 949a26f2..c5946c8e 100755 --- a/docker-compose/integrator-analytics/README.md +++ b/docker-compose/integrator-analytics/README.md @@ -4,51 +4,55 @@ ## Prerequisites - * Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Docker](https://www.docker.com/get-docker) and - [Docker Compose](https://docs.docker.com/compose/install/#install-compose) + * Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Docker](https://www.docker.com/get-docker) and [Docker Compose](https://docs.docker.com/compose/install/#install-compose) in order to run the steps provided in following Quick start guide.

- * In order to use Docker images with WSO2 updates, you need an active WSO2 subscription. If you do not possess an active WSO2 - subscription, you can sign up for a WSO2 Free Trial Subscription from [here](https://wso2.com/free-trial-subscription). - Otherwise, you can proceed with Docker images which are created using GA releases.

- * If you wish to run the Docker Compose configuration using Docker images built locally, build the Enterprise Integrator's Integrator, Analytics Dashboard and Analytics Worker - images using [EI Dockerfiles](../../dockerfiles) and remove the `docker.wso2.com/` prefix from the `image` name in the `docker-compose.yml`. - For example, change the line `image: docker.wso2.com/wso2ei-integrator:6.6.0` to
`image: wso2ei-integrator:6.6.0`.

- -## How to Run - - - 1. Clone WSO2 Enterprise Integrator Docker git repository. - - ``` - git clone https://github.com/wso2/docker-ei - ``` - > If you are to try out an already released zip of this repo, please ignore this 1st step. + * In order to use Docker images with WSO2 updates, you need an active WSO2 subscription. + Otherwise, you can proceed with Docker images available at [DockerHub](https://hub.docker.com/u/wso2/), which are created using GA releases.

+ * If you wish to run the Docker Compose setup using Docker images built locally, build Docker images using Docker resources available from [here](../../dockerfiles/) and + remove the `docker.wso2.com/` prefix from the `image` name in the `docker-compose.yml`.

- 2. Switch to the `docker-compose/integrator-analytics` folder. - - ``` - cd docker-ei/docker-compose/integrator-analytics - ``` - > If you are to try out an already released zip of this repo, please ignore this 2nd step also. - Instead, extract the zip file and directly browse to `docker-ei-/docker-compose/integrator-analytics` folder. +## Quick Start Guide + +1. Login to WSO2's Private Docker Registry via Docker client. When prompted, enter the username and password of your WSO2 Subscription. + + ``` + docker login docker.wso2.com + ``` + +2. Clone WSO2 API Management Docker and Docker Compose resource Git repository. + + ``` + git clone https://github.com/wso2/docker-ei + ``` + + > If you are to try out an already released zip of this repo, please ignore this 2nd step. + +3. Switch to `docker-compose/integrator-analytics` folder. + + ``` + cd docker-ei/docker-compose/integrator-analytics + ``` + + > If you intend to try out an already released zip of this repository, extract the zip file and directly browse to + `docker-ei-/docker-compose/integrator-analytics` folder. - > If you are to try out an already released tag, after executing 2nd step, checkout the relevant tag, - i.e. for example:
git checkout tags/v6.6.0.1 and continue below steps. + > If you intend to try out an already released tag, after executing 2nd step, checkout the relevant tag, + i.e. for example: `git checkout tags/v6.6.0.1`, switch to `docker-compose/integrator-analytics` folder and continue with below steps. - 3. [Optional] If you are using WSO2 product Docker images with WSO2 updates, replace the WSO2 product Docker image names - (relevant `image` attribute under each WSO2 product profile service) in the Docker Compose deployment definition. - - **Note**: By default, each product profile service is configured to use WSO2 product Docker images with GA releases. +4. Execute following Docker Compose command to start the deployment. + + ``` + docker-compose up + ``` + +5. Access the WSO2 Enterprise Integrator web UIs using the below URLs via a web browser. - 4. Execute following Docker Compose command to start the deployment. - - ``` - docker-compose up - ``` - - 5. Access management console via a web browser. - ``` For Integrator - https://localhost:9443/carbon For Analytics - https://localhost:9643/portal ``` + + Login to the web UIs using following credentials. + + * Username: admin
+ * Password: admin diff --git a/docker-compose/integrator-analytics/docker-compose.yml b/docker-compose/integrator-analytics/docker-compose.yml index 8c8cd9f0..fa23d40b 100755 --- a/docker-compose/integrator-analytics/docker-compose.yml +++ b/docker-compose/integrator-analytics/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.3' services: mysql: - image: mysql:5.7.20 + image: mysql:5.7.28 container_name: wso2ei-mysql ports: - 3306 @@ -14,7 +14,7 @@ services: timeout: 60s retries: 5 wso2ei-analytics-worker: - image: wso2/wso2ei-analytics-worker:6.6.0 + image: docker.wso2.com/wso2ei-analytics-worker:6.6.0 container_name: wso2ei-analytics-worker ports: - 9091:9091 @@ -32,7 +32,7 @@ services: mysql: condition: service_healthy wso2ei-analytics-dashboard: - image: wso2/wso2ei-analytics-dashboard:6.6.0 + image: docker.wso2.com/wso2ei-analytics-dashboard:6.6.0 container_name: wso2ei-analytics-dashboard ports: - 9643:9643 @@ -48,7 +48,7 @@ services: volumes: - ./dashboard:/home/wso2carbon/wso2-config-volume wso2ei-integrator: - image: wso2/wso2ei-integrator:6.6.0 + image: docker.wso2.com/wso2ei-integrator:6.6.0 container_name: wso2ei-integrator ports: - 9443:9443 diff --git a/docker-compose/integrator-analytics/scripts/README.md b/docker-compose/integrator-analytics/scripts/README.md deleted file mode 100755 index dca29aae..00000000 --- a/docker-compose/integrator-analytics/scripts/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# WSO2 Enterprise Integrator
For Integration Use-cases With Analytics Support - -## Prerequisites - - * Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Docker](https://www.docker.com/get-docker) and - [Docker Compose](https://docs.docker.com/compose/install/#install-compose) - in order to run the steps provided in following Quick start guide.

- * In order to use Docker images with WSO2 updates, you need an active WSO2 subscription. If you do not possess an active WSO2 - subscription, you can sign up for a WSO2 Free Trial Subscription from [here](https://wso2.com/free-trial-subscription). - Otherwise, you can proceed with Docker images which are created using GA releases.

- * If you wish to run the Docker Compose configuration using Docker images built locally, build the Enterprise Integrator's Integrator, Analytics Dashboard and Analytics Worker - images using [EI Dockerfiles](../../../dockerfiles) and remove the `docker.wso2.com/` prefix from the `image` name in the `docker-compose.yml`. - For example, change the line `image: docker.wso2.com/wso2ei-integrator:6.6.0` to
`image: wso2ei-integrator:6.6.0`.

- -## How to Run - - - 1. Clone WSO2 Enterprise Integrator Docker git repository. - ``` - git clone https://github.com/wso2/docker-ei - ``` - > If you are to try out an already released zip of this repo, please ignore this 1st step. - - 2. Switch to the `docker-compose/integrator-analytics/scripts` folder. - ``` - cd docker-ei/docker-compose/integrator-analytics/scripts - ``` - > If you are to try out an already released zip of this repo, please ignore this 2nd step also. - Instead, extract the zip file and directly browse to `docker-ei-/docker-compose/integrator-analytics` folder. - - > If you are to try out an already released tag, after executing 2nd step, checkout the relevant tag, - i.e. for example:
git checkout tags/v6.6.0.1 and continue below steps. - - 3. Execute the `deploy.sh` script to start the deployment. - ``` - ./deploy.sh - ``` - - 4. Access management console via a web browser. - ``` - For Integrator - https://localhost:9443/carbon - For Analytics - https://localhost:9643/portal - ``` diff --git a/docker-compose/integrator-analytics/scripts/deploy.sh b/docker-compose/integrator-analytics/scripts/deploy.sh deleted file mode 100755 index 8b4e6110..00000000 --- a/docker-compose/integrator-analytics/scripts/deploy.sh +++ /dev/null @@ -1,71 +0,0 @@ -#!/bin/bash - -# ------------------------------------------------------------------------ -# Copyright 2019 WSO2, Inc. (http://wso2.com) -# -# 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 -# ------------------------------------------------------------------------ - -set -e - -ECHO=`which echo` -GREP=`which grep` -DOCKER_CLIENT=`which docker` -DOCKER_COMPOSE_CLIENT=`which docker-compose` -SED=`which sed` -TEST=`which test` - -# methods -function echoBold () { - ${ECHO} -e $'\e[1m'"${1}"$'\e[0m' -} - -read -p "Do you have a WSO2 Subscription? (Y/n)" -n 1 -r -${ECHO} - -if [[ ${REPLY} =~ ^[Yy]$ ]]; then - read -p "Enter Your WSO2 Username: " WSO2_SUBSCRIPTION_USERNAME - ${ECHO} - read -s -p "Enter Your WSO2 Password: " WSO2_SUBSCRIPTION_PASSWORD - ${ECHO} - - echoBold "Logging into WSO2 Private Docker Registry (docker.wso2.com)" - ${DOCKER_CLIENT} login --username ${WSO2_SUBSCRIPTION_USERNAME} --password ${WSO2_SUBSCRIPTION_PASSWORD} docker.wso2.com - - if ! ${SED} -i.bak -e 's|wso2/|docker.wso2.com/|' ../docker-compose.yml; then - echoBold "Could not configure to use the Docker image available at WSO2 Private Docker Registry (docker.wso2.com)" - exit 1 - fi -elif [[ ${REPLY} =~ ^[Nn]$ || -z "${REPLY}" ]]; then - if ! ${SED} -i.bak -e 's|docker.wso2.com/|wso2/|' ../docker-compose.yml; then - echoBold "Could not configure to use the WSO2 Docker image available at DockerHub" - exit 1 - fi -else - echoBold "You have entered an invalid option." - exit 1 -fi - -# remove backed up files -${TEST} -f ../*.bak && rm ../*.bak - -cd .. - -${DOCKER_COMPOSE_CLIENT} up -d - -echoBold " -To access the Management Console of WSO2 Enterprise Integrator's Integrator profile, use https://localhost:9443/carbon. -To access the Portal of WSO2 Analytics Dashboard, use https://localhost:9643/portal. - -To list the created WSO2 product server containers, use \`docker ps\` Docker client command. -For instructions to delete the created WSO2 product server setup, please see the Docker Compose FAQ (https://wso2.com/products/install/faq/#iDocker)." diff --git a/docker-compose/integrator-broker-analytics/README.md b/docker-compose/integrator-broker-analytics/README.md index 6e5953f1..8803ab83 100644 --- a/docker-compose/integrator-broker-analytics/README.md +++ b/docker-compose/integrator-broker-analytics/README.md @@ -6,44 +6,54 @@ * Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Docker](https://www.docker.com/get-docker) and [Docker Compose](https://docs.docker.com/compose/install/#install-compose) in order to run the steps provided in following Quick start guide.

- * In order to use Docker images with WSO2 updates, you need an active WSO2 subscription. If you do not possess an active WSO2 - subscription, you can sign up for a WSO2 Free Trial Subscription from [here](https://wso2.com/free-trial-subscription). - Otherwise, you can proceed with Docker images which are created using GA releases.

- * If you wish to run the Docker Compose configuration using Docker images built locally, build the Enterprise Integrator's Integrator, Message Broker, Analytics Dashboard and Analytics Worker - images using [EI Dockerfiles](../../dockerfiles) and remove the `docker.wso2.com/` prefix from the `image` name in the `docker-compose.yml`. - For example, change the line `image: docker.wso2.com/wso2ei-integrator:6.6.0` to
`image: wso2ei-integrator:6.6.0`.

+ * In order to use Docker images with WSO2 updates, you need an active WSO2 subscription. + Otherwise, you can proceed with Docker images available at [DockerHub](https://hub.docker.com/u/wso2/), which are created using GA releases.

+ * If you wish to run the Docker Compose setup using Docker images built locally, build Docker images using Docker resources available from [here](../../dockerfiles/) and + remove the `docker.wso2.com/` prefix from the `image` name in the `docker-compose.yml`.

+ +## Quick Start Guide + +1. Login to WSO2's Private Docker Registry via Docker client. When prompted, enter the username and password of your WSO2 Subscription. + + ``` + docker login docker.wso2.com + ``` + +2. Clone WSO2 API Management Docker and Docker Compose resource Git repository. + + ``` + git clone https://github.com/wso2/docker-ei + ``` -## How to Run + > If you are to try out an already released zip of this repo, please ignore this 2nd step. - 1. Clone WSO2 Enterprise Integrator Docker git repository. - ``` - git clone https://github.com/wso2/docker-ei - ``` - > If you are to try out an already released zip of this repo, please ignore this 1st step. +3. Switch to `docker-compose/integrator-broker-analytics` folder. - 2. Switch to `docker-compose/integrator-broker-analytics` folder. - ``` - cd [docker-ei]/docker-compose/integrator-broker-analytics - ``` - > If you are to try out an already released zip of this repo, please ignore this 2nd step also. - Instead, extract the zip file and directly browse to `docker-ei-/docker-compose/integrator-broker-analytics` folder. + ``` + cd docker-ei/docker-compose/integrator-broker-analytics + ``` + + > If you intend to try out an already released zip of this repository, extract the zip file and directly browse to + `docker-ei-/docker-compose/integrator-broker-analytics` folder. - > If you are to try out an already released tag, after executing 2nd step, checkout the relevant tag, - i.e. for example:
git checkout tags/v6.6.0.1 and continue below steps. + > If you intend to try out an already released tag, after executing 2nd step, checkout the relevant tag, + i.e. for example: `git checkout tags/v6.6.0.1`, switch to `docker-compose/integrator-broker-analytics` folder and continue with below steps. - 3. [Optional] If you are using WSO2 product Docker images with WSO2 updates, replace the WSO2 product Docker image names - (relevant `image` attribute under each WSO2 product profile service) in the Docker Compose deployment definition. - - **Note**: By default, each product profile service is configured to use WSO2 product Docker images with GA releases. +4. Execute following Docker Compose command to start the deployment. - 4. Execute following Docker Compose command to start the deployment. - ``` - docker-compose up - ``` + ``` + docker-compose up + ``` + +5. Access the WSO2 Enterprise Integrator web UIs using the below URLs via a web browser. - 4. Access management console via a web browser. ``` For Integrator - https://localhost:9443/carbon For Analytics - https://localhost:9643/portal For Broker - https://localhost:9446/carbon ``` + + Login to the web UIs using following credentials. + + * Username: admin
+ * Password: admin diff --git a/docker-compose/integrator-broker-analytics/docker-compose.yml b/docker-compose/integrator-broker-analytics/docker-compose.yml index 3a12f9b1..b1e1a0a6 100755 --- a/docker-compose/integrator-broker-analytics/docker-compose.yml +++ b/docker-compose/integrator-broker-analytics/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.3' services: mysql: - image: mysql:5.7.20 + image: mysql:5.7.28 container_name: wso2ei-mysql ports: - 3306 @@ -19,7 +19,7 @@ services: retries: 5 start_period: 80s wso2ei-analytics-worker: - image: wso2/wso2ei-analytics-worker:6.6.0 + image: docker.wso2.com/wso2ei-analytics-worker:6.6.0 container_name: wso2ei-analytics-worker ports: - 9091:9091 @@ -37,7 +37,7 @@ services: mysql: condition: service_healthy wso2ei-analytics-dashboard: - image: wso2/wso2ei-analytics-dashboard:6.6.0 + image: docker.wso2.com/wso2ei-analytics-dashboard:6.6.0 container_name: wso2ei-analytics-dashboard ports: - 9643:9643 @@ -53,7 +53,7 @@ services: volumes: - ./dashboard:/home/wso2carbon/wso2-config-volume wso2ei-broker: - image: wso2/wso2ei-broker:6.6.0 + image: docker.wso2.com/wso2ei-broker:6.6.0 container_name: wso2ei-broker ports: - 9446:9446 @@ -79,7 +79,7 @@ services: wso2ei-analytics-dashboard: condition: service_healthy wso2ei-integrator: - image: wso2/wso2ei-integrator:6.6.0 + image: docker.wso2.com/wso2ei-integrator:6.6.0 container_name: wso2ei-integrator ports: - 9443:9443 diff --git a/docker-compose/integrator-broker-analytics/scripts/README.md b/docker-compose/integrator-broker-analytics/scripts/README.md deleted file mode 100755 index aa8ba08c..00000000 --- a/docker-compose/integrator-broker-analytics/scripts/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# WSO2 Enterprise Integrator
For Integration and Broker Use-cases
With Analytics Support - -![alt tag](deployment-diagram.png) - -## Prerequisites - - * Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Docker](https://www.docker.com/get-docker) and [Docker Compose](https://docs.docker.com/compose/install/#install-compose) - in order to run the steps provided in following Quick start guide.

- * In order to use Docker images with WSO2 updates, you need an active WSO2 subscription. If you do not possess an active WSO2 - subscription, you can sign up for a WSO2 Free Trial Subscription from [here](https://wso2.com/free-trial-subscription). - Otherwise, you can proceed with Docker images which are created using GA releases.

- * If you wish to run the Docker Compose configuration using Docker images built locally, build the Enterprise Integrator's Integrator, Message Broker, Analytics Dashboard and Analytics Worker - images using [EI Dockerfiles](../../../dockerfiles) and remove the `docker.wso2.com/` prefix from the `image` name in the `docker-compose.yml`. - For example, change the line `image: docker.wso2.com/wso2ei-integrator:6.6.0` to
`image: wso2ei-integrator:6.6.0`.

- -## How to Run - - 1. Clone WSO2 Enterprise Integrator Docker git repository. - ``` - git clone https://github.com/wso2/docker-ei - ``` - > If you are to try out an already released zip of this repo, please ignore this 1st step. - - 2. Switch to `docker-compose/integrator-broker-analytics` folder. - ``` - cd [docker-ei]/docker-compose/integrator-broker-analytics - ``` - > If you are to try out an already released zip of this repo, please ignore this 2nd step also. - Instead, extract the zip file and directly browse to `docker-ei-/docker-compose/integrator-broker-analytics` folder. - - > If you are to try out an already released tag, after executing 2nd step, checkout the relevant tag, - i.e. for example:
git checkout tags/v6.6.0.1 and continue below steps. - - 3. Execute the `deploy.sh` script to start the deployment. - ``` - ./deploy.sh - ``` - - 4. Access management console via a web browser. - ``` - For Integrator - https://localhost:9443/carbon - For Analytics - https://localhost:9643/portal - For Broker - https://localhost:9446/carbon - ``` diff --git a/docker-compose/integrator-broker-analytics/scripts/deploy.sh b/docker-compose/integrator-broker-analytics/scripts/deploy.sh deleted file mode 100755 index 4c3af7c8..00000000 --- a/docker-compose/integrator-broker-analytics/scripts/deploy.sh +++ /dev/null @@ -1,72 +0,0 @@ -#!/bin/bash - -# ------------------------------------------------------------------------ -# Copyright 2019 WSO2, Inc. (http://wso2.com) -# -# 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 -# ------------------------------------------------------------------------ - -set -e - -ECHO=`which echo` -GREP=`which grep` -DOCKER_CLIENT=`which docker` -DOCKER_COMPOSE_CLIENT=`which docker-compose` -SED=`which sed` -TEST=`which test` - -# methods -function echoBold () { - ${ECHO} -e $'\e[1m'"${1}"$'\e[0m' -} - -read -p "Do you have a WSO2 Subscription? (Y/n)" -n 1 -r -${ECHO} - -if [[ ${REPLY} =~ ^[Yy]$ ]]; then - read -p "Enter Your WSO2 Username: " WSO2_SUBSCRIPTION_USERNAME - ${ECHO} - read -s -p "Enter Your WSO2 Password: " WSO2_SUBSCRIPTION_PASSWORD - ${ECHO} - - echoBold "Logging into WSO2 Private Docker Registry (docker.wso2.com)" - ${DOCKER_CLIENT} login --username ${WSO2_SUBSCRIPTION_USERNAME} --password ${WSO2_SUBSCRIPTION_PASSWORD} docker.wso2.com - - if ! ${SED} -i.bak -e 's|wso2/|docker.wso2.com/|' ../docker-compose.yml; then - echoBold "Could not configure to use the Docker image available at WSO2 Private Docker Registry (docker.wso2.com)" - exit 1 - fi -elif [[ ${REPLY} =~ ^[Nn]$ || -z "${REPLY}" ]]; then - if ! ${SED} -i.bak -e 's|docker.wso2.com/|wso2/|' ../docker-compose.yml; then - echoBold "Could not configure to use the WSO2 Docker image available at DockerHub" - exit 1 - fi -else - echoBold "You have entered an invalid option." - exit 1 -fi - -# remove backed up files -${TEST} -f ../*.bak && rm ../*.bak - -cd .. - -${DOCKER_COMPOSE_CLIENT} up -d - -echoBold " -To access the Management Console of WSO2 Enterprise Integrator's Integrator profile, use https://localhost:9443/carbon. -To access the Portal of WSO2 Analytics Dashboard, use https://localhost:9643/portal. -To access the Management Console of WSO2 Enterprise Integrator's Broker profile, use https://localhost:9446/carbon. - -To list the created WSO2 product server containers, use \`docker ps\` Docker client command. -For instructions to delete the created WSO2 product server setup, please see the Docker Compose FAQ (https://wso2.com/products/install/faq/#iDocker)."