Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarification Needed on Migrating from APIM and IS-KM to APIM 4.3.0 and IS 7.0.0 #8339

Open
Abshan opened this issue Aug 21, 2024 · 0 comments

Comments

@Abshan
Copy link

Abshan commented Aug 21, 2024

Hi Team,

The current migration documentation does not provide guidance on migrating an older APIM and IS-KM setup to the latest versions, specifically APIM 4.3.0 and IS 7.0.0.

Given that IS 7.0.0 no longer shares database schemas with APIM as IS-KM did, IS 7.0.0 must be configured as a third-party Key Manager. Simply configuring IS 7.0.0 as a third-party Key Manager after migration is insufficient. Additional steps are required to correctly map the existing keys to the newly created Key Manager; otherwise, the migrated application keys will incorrectly appear as keys from the Resident Key Manager.

Post-Migration Steps:

  1. Retrieve the UUID of the WSO2-IS7 Key Manager from the AM_KEY_MANAGER table in the AM_DB:
    SELECT UUID, NAME, TYPE FROM AM_KEY_MANAGER WHERE TYPE='WSO2-IS-7';
  2. Similarly, retrieve the UUID of the default WSO2-IS Key Manager from the same table:
    SELECT UUID, NAME, TYPE FROM AM_KEY_MANAGER WHERE TYPE='WSO2-IS';
  3. Update the KEY_MANAGER column of the AM_APPLICATION_KEY_MAPPING table using the UUID of WSO2-IS7 obtained in the first step. Ensure that you only update the KEY_MANAGER value for records where the current KEY_MANAGER value matches the UUID of WSO2-IS 6.1.0:
    UPDATE AM_APPLICATION_KEY_MAPPING SET KEY_MANAGER = '<UUID_WSO2-IS-7>' WHERE KEY_MANAGER = '<UUID_WSO2-IS>';
    This will correctly associate the consumer keys and secrets with the migrated applications.
  4. Additionally, remove the following configuration from the deployment.toml file of APIM, which was added prior to the migration:
[apim.key_manager]
service_url = "https://localhost:9444/services/"
type = "WSO2-IS"

These steps should be included in the migration documentation as post-migration actions required to correctly configure IS 7.0.0 as the Key Manager.

Thanks,
Abshan

Affected Product Version:
APIM-4.3.0 and IS-7.0.0

Related Issues:
[1] https://github.com/wso2-enterprise/wso2-apim-internal/issues/7097

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant