Skip to content

Commit

Permalink
Align Docker Compose resources with WSO2 Software License
Browse files Browse the repository at this point in the history
  • Loading branch information
chirangaalwis authored and DilanUA committed Mar 12, 2020
1 parent 230bf95 commit 2386587
Show file tree
Hide file tree
Showing 10 changed files with 88 additions and 326 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ All notable changes to this project 3.0.x per each release will be documented in

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [v3.0.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.

## [v3.0.0.2] - 2020-01-21

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Docker Compose files have been created according to the most common API Manageme
to quickly evaluate product features along side their co-operate API Management requirements. The Compose files make use of per profile
Docker images of WSO2 API Manager, API Manager Analytics and WSO2 Identity Server as Key Manager, as well as MySQL.

**Change log** from previous v3.0.0.1 release: [View Here](CHANGELOG.md)
**Change log** from previous v3.0.0.2 release: [View Here](CHANGELOG.md)
86 changes: 47 additions & 39 deletions docker-compose/apim-is-as-km-with-analytics/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,40 @@
# WSO2 API Manager with Identity Server as Key Manager

# WSO2 API Manager with Identity Server as Key Manager and API Manager 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. <br><br>
* 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.<br><br>
* 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`. <br><br>
* 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.<br><br>
* 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`. <br><br>

## Quick Start Guide

1. Clone WSO2 API Manager Docker git repository.
1. Login to WSO2's Private Docker Registry via Docker client. When prompted, enter the username and password of your WSO2 Subscription.

```
git clone https://github.com/wso2/docker-apim
```
> If you are to try out an already released zip of this repo, please ignore this 1st step.
```
docker login docker.wso2.com
```

2. Switch to the `docker-compose/apim-is-as-km-with-analytics` folder.
2. Clone WSO2 API Management Docker and Docker Compose resource Git repository.

```
cd docker-apim/docker-compose/apim-is-as-km-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-apim-<released-version-here>docker-compose/apim-is-as-km-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/v3.0.0.1 and continue below steps.
```
git clone https://github.com/wso2/docker-apim
```

> If you are to try out an already released zip of this repo, please ignore this 2nd step.
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.
3. Switch to `docker-compose/apim-is-as-km-with-analytics` folder.

```
cd docker-apim/docker-compose/apim-is-as-km-with-analytics
```
> If you intend to try out an already released zip of this repository, extract the zip file and directly browse to
`docker-apim-<released-version-here>/docker-compose/apim-is-as-km-with-analytics` folder.
> 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/v3.0.0.1`, switch to `docker-compose/apim-is-as-km-with-analytics` folder and continue with below steps.

4. Execute following Docker Compose command to start the deployment.

Expand All @@ -43,23 +44,30 @@

5. Access the WSO2 API Manager web UIs using the below URLs via a web browser.

```
```
https://localhost:9443/publisher
https://localhost:9443/store
https://localhost:9443/devportal
https://localhost:9443/admin
https://localhost:9443/carbon
```
Access the servers using following credentials.
```
Login to the web UIs using following credentials.

* Username: admin <br>
* Password: admin

Please note that API Gateway will be available on following ports.
```
https://localhost:8243
https://localhost:8280
```
Access the WSO2 API Manager Analytics web UIs using the below URL via a web browser.

```
https://localhost:9643/analytics-dashboard
```
Login to the web UIs using following credentials.

* Username: admin <br>
* Password: admin
Please note that API Gateway will be available on following ports.
```
https://localhost:8243
https://localhost:8280
```
* Username: admin <br>
* Password: admin

WSO2 API Manager will use WSO2 Identity Server to generate OAuth2 tokens and validate those tokens <br> during API invocations.
WSO2 API Manager will use WSO2 Identity Server to generate OAuth2 tokens and validate those tokens <br> during API invocations.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ services:
retries: 5
start_period: 80s
am-analytics-worker:
image: wso2/wso2am-analytics-worker:3.0.0
image: docker.wso2.com/wso2am-analytics-worker:3.0.0
ports:
- "9091:9091"
- "9444:9444"
Expand All @@ -50,7 +50,7 @@ services:
volumes:
- ./apim-analytics-worker:/home/wso2carbon/wso2-config-volume
is-as-km:
image: wso2/wso2is-km:5.9.0
image: docker.wso2.com/wso2is-km:5.9.0
healthcheck:
test: ["CMD", "nc", "-z","localhost", "9443"]
interval: 10s
Expand All @@ -66,7 +66,7 @@ services:
- "9765:9763"
- "9445:9443"
api-manager:
image: wso2/wso2am:3.0.0
image: docker.wso2.com/wso2am:3.0.0
healthcheck:
test: ["CMD", "nc", "-z","localhost", "9443"]
interval: 10s
Expand All @@ -88,7 +88,7 @@ services:
- "8280:8280"
- "8243:8243"
am-analytics-dashboard:
image: wso2/wso2am-analytics-dashboard:3.0.0
image: docker.wso2.com/wso2am-analytics-dashboard:3.0.0
ports:
- "9643:9643"
healthcheck:
Expand Down
61 changes: 0 additions & 61 deletions docker-compose/apim-is-as-km-with-analytics/scripts/README.md

This file was deleted.

72 changes: 0 additions & 72 deletions docker-compose/apim-is-as-km-with-analytics/scripts/deploy.sh

This file was deleted.

44 changes: 27 additions & 17 deletions docker-compose/apim-with-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,38 @@

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

<br>

## Quick Start Guide

1. Clone WSO2 API Manager Docker git repository.
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-apim
```
> If you are to try out an already released zip of this repo, please ignore this 1st step.

2. Switch to `docker-compose/apim-with-analytics` folder.
> If you are to try out an already released zip of this repo, please ignore this 2nd step.
3. Switch to `docker-compose/apim-with-analytics` folder.

```
cd docker-apim/docker-compose/apim-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-apim-<released-version-here>/docker-compose/apim-with-analytics` folder.
> If you intend to try out an already released zip of this repository, extract the zip file and directly browse to
`docker-apim-<released-version-here>/docker-compose/apim-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/v3.0.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.
> 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/v3.0.0.1`, switch to `docker-compose/apim-with-analytics` folder and continue with below steps.

4. Execute following Docker Compose command to start the deployment.

Expand All @@ -46,11 +47,11 @@

```
https://localhost:9443/publisher
https://localhost:9443/store
https://localhost:9443/devportal
https://localhost:9443/admin
https://localhost:9443/carbon
```
Access the servers using following credentials.
Login to the web UIs using following credentials.

* Username: admin <br>
* Password: admin
Expand All @@ -60,3 +61,12 @@
https://localhost:8243
https://localhost:8280
```
Access the WSO2 API Manager Analytics web UIs using the below URL via a web browser.

```
https://localhost:9643/analytics-dashboard
```
Login to the web UIs using following credentials.

* Username: admin <br>
* Password: admin
Loading

0 comments on commit 2386587

Please sign in to comment.