diff --git a/CHANGELOG.md b/CHANGELOG.md index 88a9091d..75012c6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project 5.9.x per each release will be documented in The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) +## [v5.9.0.3] - 2020-03-12 + +### Changed +- Align Docker Compose resources with WSO2 Software License (WSL). +- Set Docker Compose resources to use WSO2 Private Docker Registry Docker images, by default. + ## [v5.9.0.2] - 2020-01-21 ### Fixed @@ -20,4 +26,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) For detailed information on the tasks carried out during this release, please see the GitHub milestone [v5.9.0.1](https://github.com/wso2/docker-is/milestone/8). -[v5.9.0.2]: https://github.com/wso2/docker-is/compare/v5.9.0.1...v5.9.0.2 +[v5.9.0.3]: https://github.com/wso2/docker-is/compare/v5.9.0.2...v5.9.0.3 diff --git a/README.md b/README.md index 3fbfaf21..9bef230b 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,4 @@ Docker Compose files have been created according to the most common IAM deployme to quickly evaluate product features along side their co-operate IAM requirements. The Compose files make use of per profile Docker images of WSO2 Identity Server and Analytics and MySQL. -**Change log** from previous v5.8.0.3 release: [View Here](CHANGELOG.md) +**Change log** from previous v5.9.0.2 release: [View Here](CHANGELOG.md) diff --git a/docker-compose/is-with-analytics/README.md b/docker-compose/is-with-analytics/README.md index 4c02b2a5..62fdc39d 100644 --- a/docker-compose/is-with-analytics/README.md +++ b/docker-compose/is-with-analytics/README.md @@ -6,45 +6,52 @@ * 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 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`.

+ * 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`.

-## How to deploy +## Quick Start Guide - 1. Clone WSO2 Identity Server Docker git repository. - ``` - git clone https://github.com/wso2/docker-is - ``` - > If you are to try out an already released zip of this repo, please ignore this 1st step. +1. Login to WSO2's Private Docker Registry via Docker client. When prompted, enter the username and password of your WSO2 Subscription. - 2. Switch to the `docker-compose/is-with-analytics` folder. - ``` - cd [docker-is]/docker-compose/is-with-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-is-/docker-compose/is-with-analytics` folder. - - > If you want to try out an already released tag, after executing 2nd step, checkout the relevant tag, - i.e. for example: git checkout tags/v5.9.0.1 and continue 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 - ``` + ``` + docker login docker.wso2.com + ``` + +2. Clone WSO2 API Management Docker and Docker Compose resource Git repository. + + ``` + git clone https://github.com/wso2/docker-is + ``` + + > If you are to try out an already released zip of this repo, please ignore this 2nd step. + +3. Switch to `docker-compose/is-with-analytics` folder. + + ``` + cd docker-is/docker-compose/is-with-analytics + ``` + > If you intend to try out an already released zip of this repository, extract the zip file and directly browse to + `docker-is-/docker-compose/is-with-analytics` folder. - 5. Access management console via a web browser. + > 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/v5.9.0.1`, switch to `docker-compose/is-with-analytics` folder and continue with below steps. + +4. Execute following Docker Compose command to start the deployment. + + ``` + docker-compose up + ``` + +5. Access the WSO2 Identity Server web UIs using the below URLs via a web browser. ``` For Identity Server - https://localhost:9443/carbon For Identity Server Analytics Portal - https://localhost:9643/portal/ ``` - - 6. When configuring an application with Identity Server, use the following properties - * IdPEntityId - wso2is + + Login to the web UIs using following credentials. + + * Username: admin
+ * Password: admin diff --git a/docker-compose/is-with-analytics/docker-compose.yml b/docker-compose/is-with-analytics/docker-compose.yml index 1ad221f1..d0c165cb 100644 --- a/docker-compose/is-with-analytics/docker-compose.yml +++ b/docker-compose/is-with-analytics/docker-compose.yml @@ -1,7 +1,7 @@ version: '2.3' services: mysql: - image: mysql:5.7.27 + image: mysql:5.7.28 ports: - 3306 environment: @@ -16,7 +16,7 @@ services: timeout: 60s retries: 5 identity-server-analytics-worker: - image: wso2/wso2is-analytics-worker:5.8.0 + image: docker.wso2.com/wso2is-analytics-worker:5.8.0 ports: - "9091:9091" - "9444:9444" @@ -32,7 +32,7 @@ services: volumes: - ./identity-server-analytics-worker:/home/wso2carbon/wso2-config-volume identity-server-analytics-dashboard: - image: wso2/wso2is-analytics-dashboard:5.8.0 + image: docker.wso2.com/wso2is-analytics-dashboard:5.8.0 ports: - "9643:9643" healthcheck: @@ -47,7 +47,7 @@ services: volumes: - ./identity-server-analytics-dashboard:/home/wso2carbon/wso2-config-volume identity-server: - image: wso2/wso2is:5.9.0 + image: docker.wso2.com/wso2is:5.9.0 ports: - "9763:9763" - "9443:9443" diff --git a/docker-compose/is-with-analytics/scripts/README.md b/docker-compose/is-with-analytics/scripts/README.md deleted file mode 100755 index 057de264..00000000 --- a/docker-compose/is-with-analytics/scripts/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# WSO2 Identity Server deployment with WSO2 Identity Server Analytics - -## 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 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`.

- -## How to deploy - - 1. Clone WSO2 Identity Server Docker git repository. - ``` - git clone https://github.com/wso2/docker-is - ``` - > If you are to try out an already released zip of this repo, please ignore this 1st step. - - 2. Switch to the `docker-compose/is-with-analytics` folder. - ``` - cd [docker-is]/docker-compose/is-with-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-is-/docker-compose/is-with-analytics` folder. - - > If you want to try out an already released tag, after executing 2nd step, checkout the relevant tag, - i.e. for example: git checkout tags/v5.8.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 Identity Server - https://localhost:9443/carbon - For Identity Server Analytics Portal - https://localhost:9643/portal/ - ``` - - 5. When configuring an application with Identity Server, use the following properties - * IdPEntityId - wso2is diff --git a/docker-compose/is-with-analytics/scripts/deploy.sh b/docker-compose/is-with-analytics/scripts/deploy.sh deleted file mode 100755 index 05c343b8..00000000 --- a/docker-compose/is-with-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 Identity Server, 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)."