Skip to content

Commit

Permalink
Merge pull request #176 from wso2/2.6.x
Browse files Browse the repository at this point in the history
Merge 2.6.x into master
  • Loading branch information
msmshariq authored Oct 9, 2018
2 parents cf20c6a + 86bf053 commit bd833ac
Show file tree
Hide file tree
Showing 84 changed files with 4,562 additions and 2,487 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,9 @@ hs_err_pid*
*.iml

rat.txt

# exclude everything
**/files/*

# exception to the rule
!**/files/.gitkeep
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog
All notable changes to this project 2.6.x per each release will be documented in this file.

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

## [Unreleased]

### Added
- WSO2 API Manager v2.6.x Docker resources for Alpine, CentOS, Ubuntu
- WSO2 API Manager Analytics v2.6.x Docker resources for Alpine, CentOS, Ubuntu
- WSO2 API Manager Identity Server as Key Manager v5.7.x Docker resources for Alpine, CentOS, Ubuntu
- Docker Compose resources for WSO2 API Management
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# Docker Resources for WSO2 API Manager
# Docker Resources for WSO2 API Management

This repository contains following Docker artifacts, for trying out WSO2 API Manager on plain Docker:
- WSO2 API Manager Dockerfile
- WSO2 API Manager Analytics Dockerfile
- WSO2 API Manager Docker Compose Templates
This repository contains following Docker resources:

The WSO2 API Manager and API Manager Analytics Dockerfiles build generic Docker images <br>
for deploying API Manager and API Manager Analytics in containerized environments. They<br>
include the JDK, product distributions and a collection of utility libraries. Configurations, JDBC<br>
driver, extensions and other deployable artifacts are designed to be provided via volume mounts.
- WSO2 API Manager Dockerfile for Ubuntu
- WSO2 API Manager Analytics Dockerfile for Ubuntu
- WSO2 API Manager Identity Server as Key Manager Dockerfile for Ubuntu
- Docker Compose files to evaluate most common deployment profiles

The Docker Compose templates have been created according to standard API Manager deployment patterns
for allowing users to evaluate the product and understand the deployment architecture in depth.
Docker resources for WSO2 API Manager, WSO2 API Manager Analytics and WSO2 API Manager Identity Server as Key Manager
help you build generic Docker images for deploying the corresponding product servers in containerized environments.
Each Docker image includes the JDK, the relevant product distribution and a collection of utility libraries.Configurations, custom JDBC
drivers other than the default MySQL JDBC driver provided, extensions and other deployable artifacts are designed to be
provided via volume mounts to the containers spawned.

## Note
For running a containerized WSO2 API Manager deployment in production, its recommended to use a<br>
container cluster manager such as Kubernetes/Openshift. Please refer [APIM Kubernetes Artifacts](https://github.com/wso2/kubernetes-apim/) repository.
Docker Compose files have been created according to the most common API Manager deployment profiles available for allowing users to quickly evaluate
product features along side their co-operate API management requirements. The Compose files make use of
Docker images of WSO2 API Manager, WSO2 API Manager Analytics, WSO2 API Manager Identity Server as Key Manager and MySQL.

**Change log** from previous v2.6.0.1 release: [View Here](CHANGELOG.md)
52 changes: 27 additions & 25 deletions docker-compose/apim-is-as-km-with-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,52 +5,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. <br><br>
* In order to run this Docker Compose setup, you will need an active subscription from WSO2 since the referring Docker images hosted at docker.wso2.com contains the latest updates and fixes for WSO2 API Manager <br>and
API Manager Analytics 2.5.0 and WSO2 Identity Server as KM 5.6.0. You can sign up for a Free Trial Subscription [here](https://wso2.com/free-trial-subscription). <br><br>
* If you wish to run the Docker Compose setup using Docker images built locally, build Docker images using <br> [WSO2 API Manager Dockerfile](../../dockerfiles/apim/README.md), [API Manager Analytics Dockerfile](../../dockerfiles/apim-analytics/README.md) and
[WSO2 Identity Server as KM Dockerfile](../../dockerfiles/is-as-km/README.md) and remove the `docker.wso2.com/` prefix
from the `image` name In the `docker-compose.yml`. For example, change the line <br> `image: docker.wso2.com/wso2am:2.5.0` to `image: wso2am:2.5.0` . <br><br>
* In order to run this Docker Compose setup, you will need an active subscription from WSO2 since the referring Docker images hosted at docker.wso2.com contains the latest updates and fixes for WSO2 API Manager and
API Manager Analytics 2.6.0 and WSO2 Identity Server as KM 5.7.0. You can sign up for a Free Trial Subscription [here](https://wso2.com/free-trial-subscription). <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.

```
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 the `docker-compose/APIM-ISasKM-with-Analytics` folder.
2. Switch to the `docker-compose/apim-is-as-km-with-analytics` folder.

```
cd docker-apim/docker-compose/APIM-ISasKM-with-Analytics
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-ISasKM-with-Analytics` folder.
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/v2.5.0.1 and continue below steps.
i.e. for example: git checkout tags/v2.6.0.1 and continue below steps.

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

```
docker-compose up
```

4. Once the deployment is started, try to access the web UIs via following URLs and default credentials <br>
on your favorite web browser.
4. 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/admin
https://localhost:9443/carbon
```
Access the servers 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
```

WSO2 API Manager will use WSO2 Identity Server to generate OAuth2 tokens and validate those tokens <br> during API invocations.
```

Access the servers 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
```

WSO2 API Manager will use WSO2 Identity Server to generate OAuth2 tokens and validate those tokens <br> during API invocations.
Loading

0 comments on commit bd833ac

Please sign in to comment.