Adding multi environment support for APK #1770

pubudu538 · 2023-09-26T06:35:35Z

Purpose

Adds the multi environment support for APK where single gateway can be shared among multiple environments. The following changes added.

Configuration called Environment is added to identify the environment of the data plane. This is used for onprem APK. When sending the analytics events, this environment is used.
Environment field is added to the API and TokenIssuer CRs.
Used environment field instead of the vhost for rate limiting.
Combination of Organization, Base Path and Environment is taken as the unique key for the API. Webhook validation is adjusted for this.
Environment is taken as the environmentID for Choreo Analytics.
Environment field is added to the APK-Conf.
Added a common config called dp.environment for the helm chart.
When the environment is given in the API CR, it is taken for the vhost that gets generated. For example, if the environment is dev, vhost will be orgid-dev.gw.wso2.com

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email [email protected] to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

codecov-commenter · 2023-09-26T06:39:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a8155ab) 26.00% compared to head (c3b9896) 25.66%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1770      +/-   ##
==========================================
- Coverage   26.00%   25.66%   -0.34%     
==========================================
  Files         250      130     -120     
  Lines       29536    14999   -14537     
  Branches     4894     2453    -2441     
==========================================
- Hits         7680     3850    -3830     
+ Misses      21594    11018   -10576     
+ Partials      262      131     -131

Flag	Coverage Δ
adapter	`25.44% <ø> (-0.12%)`	⬇️
common-controller	`1.12% <ø> (+<0.01%)`	⬆️
config-deployer-service	`28.38% <ø> (+0.03%)`	⬆️
idp-domain-service	`80.18% <ø> (ø)`
router	`∅ <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 170 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pubudu538 · 2023-10-11T09:39:45Z

adapter/internal/operator/controllers/dp/tokenissuer_controller.go

+
+func getTokenIssuerEnvironments(environments []string) []string {
+
+	resolvedEnvirenvironments := []string{}


This is fixed.

pubudu538 · 2023-10-11T09:45:37Z

...forcer/org.wso2.apk.enforcer/src/main/java/org/wso2/apk/enforcer/constants/APIConstants.java

@@ -45,6 +45,8 @@ public class APIConstants {
    public static final String AUTHORIZATION_BEARER = "Bearer ";
    public static final String API_KEY_TYPE_PRODUCTION = "PRODUCTION";
    public static final String API_KEY_TYPE_SANDBOX = "SANDBOX";
+    public static final String DEFAULT_ENVIRONMENT_NAME = "Default";
+    public static final String DEFAULT_ENVIRONMENT_ID = "Default-ID";


We can remove this. Not used in the new design.

Removed this.

pubudu538 · 2023-10-12T06:36:04Z

...ommons/src/main/java/org/wso2/apk/enforcer/commons/analytics/publishers/dto/ExtendedAPI.java

@@ -40,4 +40,12 @@ public String getApiContext() {
    public void setApiContext(String apiContext) {
        this.apiContext = apiContext;
    }
+
+    public String getEnvironment() {


Should change to EnvID.

pubudu538 force-pushed the apk-envs branch 2 times, most recently from 4c96d9b to decc78e Compare October 4, 2023 06:57

pubudu538 marked this pull request as ready for review October 6, 2023 13:18

pubudu538 force-pushed the apk-envs branch from 639c108 to 1363c8a Compare October 11, 2023 07:03

pubudu538 commented Oct 11, 2023

View reviewed changes

pubudu538 commented Oct 12, 2023

View reviewed changes

pubudu538 added 22 commits October 21, 2023 19:37

Resolving changes with the main branch

849498f

Adding the changed API crd

d085009

Passing environment field from Adapter to Enforcer

a7e3ba0

Adding environment ID for Choreo Analytics

52d92ad

Changing vhost to environment for rate limiting in the common controller

723ef7a

Updating Router configs for rate limiting

f41db36

Removing Environment data model

0a5c537

Adding environment field to APK Conf

75de949

Fixing compiler hints on Ballerina

1baf50a

Adding integration tests for multi environment feature

44f68f6

Changing to new schemas

6693597

Fixing multi-env test cases

8aab912

Adding missing vhosts

e45256a

Adding environment field for TokenIssuer

cac99a0

Adding test cases for token issuer with environments

2763091

Adding environment field to the helm chart

4052297

Moving environment as an object in the helm chart

5e8a896

Adding resource level rate limit support for sandbox routes

fe82a1c

Passing environment field to the interceptors

a626420

Adding v1alpha2 version for API Kind

6f0c652

Updating integration tests for multi-envs

f959e8a

Fixing build failures

8aa2784

pubudu538 force-pushed the apk-envs branch from 6229b90 to 8aa2784 Compare October 21, 2023 14:20

pubudu538 added 2 commits October 21, 2023 20:47

Fixing revive failure

bba085a

Adding TokenIssuer v1alpha2 version

c3b9896

Krishanx92 approved these changes Oct 23, 2023

View reviewed changes

Krishanx92 merged commit 1c472b0 into wso2:main Oct 23, 2023
14 of 15 checks passed

pubudu538 mentioned this pull request Jan 22, 2024

Multi Environment support for APK #1970

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding multi environment support for APK #1770

Adding multi environment support for APK #1770

pubudu538 commented Sep 26, 2023 •

edited

Loading

codecov-commenter commented Sep 26, 2023 •

edited

Loading

pubudu538 Oct 11, 2023

pubudu538 Oct 23, 2023

pubudu538 Oct 11, 2023

pubudu538 Oct 23, 2023

pubudu538 Oct 12, 2023

pubudu538 Oct 23, 2023


		func getTokenIssuerEnvironments(environments []string) []string {

		resolvedEnvirenvironments := []string{}

Adding multi environment support for APK #1770

Adding multi environment support for APK #1770

Conversation

pubudu538 commented Sep 26, 2023 • edited Loading

Purpose

Goals

Approach

User stories

Release note

Documentation

Training

Certification

Marketing

Automation tests

Security checks

Samples

Related PRs

Migrations (if applicable)

Test environment

Learning

codecov-commenter commented Sep 26, 2023 • edited Loading

Codecov Report

pubudu538 Oct 11, 2023

Choose a reason for hiding this comment

pubudu538 Oct 23, 2023

Choose a reason for hiding this comment

pubudu538 Oct 11, 2023

Choose a reason for hiding this comment

pubudu538 Oct 23, 2023

Choose a reason for hiding this comment

pubudu538 Oct 12, 2023

Choose a reason for hiding this comment

pubudu538 Oct 23, 2023

Choose a reason for hiding this comment

pubudu538 commented Sep 26, 2023 •

edited

Loading

codecov-commenter commented Sep 26, 2023 •

edited

Loading