Merge pull request #404 from RakhithaRR/master-4.0.0.1-release

Prepare for Release 4.0.0.1

CHANGELOG.md

@@ -1,48 +1,21 @@
 # Changelog
 
-All notable changes to Docker and Docker Compose resources for WSO2 API Management version `3.2.x` in each resource release, will be documented in this file.
+All notable changes to Docker and Docker Compose resources for WSO2 API Management version `4.0.x` in each resource release, will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
-
-## [v3.2.0.2] - 2020-11-20
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+## [v4.0.0.1] - 2021-04-28
 
 ### Added
-- Add git release tag as a label (refer to [issue](https://github.com/wso2/docker-apim/issues/338))
-
-### Changed
-- Upgrade AdoptOpenJDK 11 version to the latest version - `11.0.9_11-jdk` (refer to [issue](https://github.com/wso2/docker-apim/issues/377))
-- Enable SSL verification when retrieving remote resources using wget (refer to [issue](https://github.com/wso2/docker-apim/issues/345))
-- Update source label key
-
-For detailed information on the tasks carried out during this release, please see the GitHub milestone
-[v3.2.0.2](https://github.com/wso2/docker-apim/milestone/21).
-
-## [v3.2.0.1] - 2020-08-26
-
-### Environments
 
-- Successful evaluation using Docker Engine Community version `19.03.5` (both client and server)
-- Successful evaluation using Docker Compose version `1.23.1, build b02f1306`
-
-### Added
-
-- Alpine, CentOS and Ubuntu based Docker resources for WSO2 API Manager, API Manager Analytics Dashboard and Worker version `3.2.0` (refer to [issue](https://github.com/wso2/docker-apim/issues/313))
-- Docker Compose resources for the deployment of WSO2 API Manager with Analytics support version `3.2.0` (refer to [issue](https://github.com/wso2/docker-apim/issues/314))
-- Docker Compose resources for the deployment of WSO2 API Manager with Identity Server as Key Manager and Analytics support version `3.2.0` (refer to [issue](https://github.com/wso2/docker-apim/issues/314))
+- Alpine, CentOS, and Ubuntu based Docker resources for WSO2 API Manager version `4.0.0`.
+- Docker Compose resources for the deployment of WSO2 API Manager `4.0.0` with Choreo Analytics support.
+- Docker Compose resources for the deployment of WSO2 API Manager `4.0.0` with Identity Server `5.11.0` as Key Manager and Choreo Analytics support.
+- Docker Compose resources for the deployment of WSO2 API Manager `4.0.0` with Micro Integrator `4.0.0`.
 
 ### Changed
 
-- Upgrade AdoptOpenJDK 11 version to the latest version - `11.0.8_10-jdk` (refer to [issue](https://github.com/wso2/docker-apim/issues/336))
-- Upgrade Docker Compose version from `2.3` to `2.4` (refer to [issue](https://github.com/wso2/docker-apim/issues/323))
-- Upgrade MySQL version used in Docker Compose resources - `5.7.31` (refer to [issue](https://github.com/wso2/docker-apim/issues/322))
+- Upgrade MySQL version used in Docker Compose resources - `5.7.34`.
 
 ### Removed
 
-- Avoid packaging MySQL JDBC Driver in API Manager Docker images (refer to [issue](https://github.com/wso2/docker-apim/issues/321))
-- Remove unnecessary patch volume mount option (refer to [issue](https://github.com/wso2/docker-apim/issues/317))
-
-For detailed information on the tasks carried out during this release, please see the GitHub milestone
-[v3.2.0.1](https://github.com/wso2/docker-apim/milestone/17).
-
-[v3.2.0.1]: https://github.com/wso2/docker-apim/compare/v3.1.0.3...v3.2.0.1
-[v3.2.0.2]: https://github.com/wso2/docker-apim/compare/v3.2.0.1...v3.2.0.2
+- WSO2 API Manager Analytics Dashboard and Worker related Docker Compose resources.

CONTRIBUTING.md

@@ -23,21 +23,21 @@ The issues page on GitHub is for tracking bugs and feature requests. When posing
 
 If you like to contribute with a bug fix or a new feature, start by posting an issue and discussing the best way to implement it.
 
-Unlike most projects, development for this repository is carried out on the `3.2.x` branch. This is because the `master` branch contains the latest stable release of the project.
-The code in `3.2.x` is merged to the `master` branch after a final review and a round of testing.
+Unlike most projects, development for this repository is carried out on the `4.0.x` branch. This is because the `master` branch contains the latest stable release of the project.
+The code in `4.0.x` is merged to the `master` branch after a final review and a round of testing.
 
 Please follow these guidelines when contributing to the code:
 
 1. Fork the current repository.
-2. Create a topic branch from the `3.2.x` branch.
+2. Create a topic branch from the `4.0.x` branch.
 3. Make commits in logical units.
 4. Before you send out the pull request, sync your forked repository with a remote repository. This makes your pull request simple and clear.
 
 ```bash
 git clone https://github.com/<user>/docker-apim.git
 git remote add upstream https://github.com/wso2/docker-apim.git
 git fetch upstream
-git checkout -b <topic-branch> upstream/3.2.x
+git checkout -b <topic-branch> upstream/4.0.x
 
 # add some work
 

README.md

@@ -2,12 +2,12 @@
 
 This repository contains following Docker resources:
 
-- Alpine, CentOS and Ubuntu based Docker resources for WSO2 API Manager, API Manager Analytics Dashboard and Worker and
-Identity Server as Key Manager profiles
+- Alpine, CentOS and Ubuntu based Docker resources for WSO2 API Manager, Identity Server as Key Manager, and 
+Micro Integrator profiles.
 
 - Docker Compose resources for the most common WSO2 API Management deployment patterns
 
-Docker resources for WSO2 API Manager, API Manager Analytics and WSO2 Identity Server as Key Manager
+Docker resources for WSO2 API Manager, WSO2 Identity Server as Key Manager, and WSO2 Micro Integrator
 help you build generic Docker images for deploying the corresponding product servers in containerized environments.
 
 Each Docker image includes the Java Development Kit, the relevant product distribution and a collection of utility libraries.
@@ -17,6 +17,6 @@ volume mounts to the containers spawned.
 
 Docker Compose files have been created according to the most common API Management deployment patterns available for allowing users
 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.
+Docker images of WSO2 API Manager, WSO2 Identity Server as Key Manager, and Micro Integrator as well as MySQL.
 
-**Change log** from previous v3.1.0.3 release: [View Here](CHANGELOG.md)
+**Change log** from previous v3.2.0.3 release: [View Here](https://github.com/wso2/docker-apim/blob/3.2.x/CHANGELOG.md)

docker-compose/apim-is-as-km-with-analytics/README.md

@@ -1,4 +1,4 @@
-# WSO2 API Manager with Identity Server as Key Manager and API Manager Analytics Support
+# WSO2 API Manager with Identity Server as Key Manager and Analytics Support
 
 ## Prerequisites
 
@@ -33,7 +33,7 @@
    `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.2.0.1`, switch to `docker-compose/apim-is-as-km-with-analytics` folder and continue with below steps.
+    i.e. for example: `git checkout tags/v4.0.0.1`, switch to `docker-compose/apim-is-as-km-with-analytics` folder and continue with below steps.
 
 4. [Optional] Replace the existing IS extensions with the latest.
 
@@ -43,13 +43,24 @@
 
    You may replace the web app in `docker-compose/apim-is-as-km-with-analytics/dockerfiles/is-as-km/webapps` as defined in step 5.
 
-5. Execute following Docker Compose command to start the deployment.
+5. WSO2 no longer provides an on-premise Analytics solution. In order to connect WSO2 API Manager to [Choreo Analytics](https://analytics.choreo.dev/), obtain an `on-prem-key` by following the steps in the [documentation](https://apim.docs.wso2.com/en/4.0.0/observe/api-manager-analytics/configure-analytics/register-for-analytics/).
+
+6. Update the analytics configurations in [deployment.toml](./conf/apim/repository/conf/deployment.toml) with the `on-prem key` obtained.
+
+    ```toml
+    [apim.analytics]
+    enable = true
+    config_endpoint = "https://analytics-event-auth.choreo.dev/auth/v1"
+    auth_token = "<on-prem-key>"
+    ```
+
+7. Execute following Docker Compose command to start the deployment.
 
    ```
    docker-compose up --build
    ```
 
-6. Access the WSO2 API Manager web UIs using the below URLs via a web browser.
+8. Access the WSO2 API Manager web UIs using the below URLs via a web browser.
 
    ```
    https://localhost:9443/publisher
@@ -67,12 +78,5 @@
    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
+
+9. To see analytics data, log in to [Choreo Analytics](https://analytics.choreo.dev/).