# Introducing the Apigee Migration Assessment Tool: Your roadmap to a smooth transition **URL:** \ **Category:** Knowledge Hub\ **Tags:** apigee, api-management\ **Created:** [January 25, 2025, 9:28pm UTC](https://discuss.google.dev/t/introducing-the-apigee-migration-assessment-tool-your-roadmap-to-a-smooth-transition/178771 "2025-01-25T21:28:45Z")\ **Posts on this page:** 1\ **Page:** 1
**Author:** ![ashwinknaik](https://d3byx8b92xw3lq.cloudfront.net/user_avatar/discuss.google.dev/ashwinknaik/32/121503_2.png) [@ashwinknaik](https://discuss.google.dev/u/ashwinknaik)\ **Post date:** [January 25, 2025, 9:28pm UTC](https://discuss.google.dev/t/introducing-the-apigee-migration-assessment-tool-your-roadmap-to-a-smooth-transition/178771/1 "2025-01-25T21:28:45Z")
# Apigee Migration Assessment Tool Migrating from Apigee Edge (OPDK or SaaS) to Apigee X or Hybrid? Our Apigee Migration Assessment Tool is here to make your journey as seamless as possible. This powerful tool dives deep into your existing Apigee Edge environment, leaving no stone unturned. It then generates a **comprehensive report** packed with **valuable insights** and **actionable recommendations** tailored to your specific setup. By leveraging these insights, you can **streamline your migration process** , **anticipate potential roadblocks** , and **minimize disruptions** to your operations. The Apigee Migration Assessment Tool empowers you to plan with confidence and execute your migration with precision. ## Prerequisites You can run this tool locally or using Docker. - **Local** : Requires installing Python libraries and dependencies. - **Docker** : You can build the image yourself. #### Local Setup 1. Install Graphviz: Follow the instructions at [https://graphviz.org/download/](https://graphviz.org/download/) 2. Install Python venv: ```bash python3 -m pip install virtualenv==20.24.4 ``` 1. Create and activate a virtual environment & Install Python dependencies: ```bash python3 -m venv dev source dev/bin/activate pip install -r requirements.txt ``` #### Docker Setup ##### Use a pre-built Docker image: Pull the docker image using docker pull ```bash docker pull ghcr.io/apigee/apigee-migration-assessment-tool/apigee-migration-assessment-tool:latest ``` OR ##### Build the Docker image: Use docker build and docker push to build and push the docker image to local registry. ```bash docker build -t : . docker push : ``` ## Apigee Permissions ### Apigee Edge SAAS/OPDK The tool requires permissions to export all objects from Apigee Egde. Hence assign the following permission to the relevant user. - Read-only Organization Administrator Refer: [edge-built-roles](https://docs.apigee.com/api-platform/system-administration/edge-built-roles) ### Apigee X/Hybrid The tool requires readonly permissions to org, env & env objects. The tool also requires permissions to validate apis. Hence assign the below permissions to relevant user or service account. - A built-in role roles/apigee.readOnlyAdmin - A custom role with **apigee.proxies.create** permission ```bash gcloud iam roles create ApigeeAPIValidator --project= \ --title="Apigee API Validator" \ --description="Apigee API Import validator" \ --permissions="apigee.proxies.create" --stage=Alpha ``` Refer: [apigee-roles](https://cloud.google.com/iam/docs/understanding-roles#apigee-roles) ## Tool Usage ### Complete Assessment To assess all Apigee objects: ```bash python3 main.py --resources all ``` ### Selective Assessment To assess specific Apigee objects, use the --resources flag followed by a comma-separated list: ```bash python3 main.py --resources ,,... ``` Available resources: - **Environment Level:** targetservers, keyvaluemaps, references, resourcefiles, keystores, flowhooks - **Organization Level** : org\_keyvaluemaps, developers, apiproducts, apis, apps, sharedflows Examples ```bash python3 main.py --resources targetservers,keyvaluemaps python3 main.py --resources keystores,apps ``` ## Running the Tool ### Prepare input.properties Create an input.properties file in the same directory as the Python scripts. Please find sample inputs in the sample/inputs folder - [sample opdk input](https://github.com/apigee/apigee-migration-assessment-tool/blob/main/sample/inputs/opdk.input.properties) - [sample saas input](https://github.com/apigee/apigee-migration-assessment-tool/blob/main/sample/inputs/saas.input.properties) Refer the below table to set the required inputs in the input section of input.properties file. | **Section** | **Input** | **Description** | | --- | --- | --- | | input | SOURCE\_URL | Apigee OPDK/Edge Management URL | | input | SOURCE\_ORG | Apigee OPDK/Edge Organization | | input | SOURCE\_AUTH\_TYPE | Apigee OPDK/Edge auth type , basic OR oauth | | input | SOURCE\_UI\_URL | Apigee OPDK/Edge UI URL, use default | | input | SOURCE\_APIGEE\_VERSION | APIGEE Flavor OPDK OR SAAS OR X OR HYBRID | | input | GCP\_PROJECT\_ID | GCP Project ID running Apigee X/Hybrd. Trial orgs are supported | | input | API\_URL | Apigee API url, use default | | input | GCP\_ENV\_TYPE | Apigee X/Hybrid desired environment type | | input | TARGET\_DIR | Name of directory to export apigee objects | | input | SSL\_VERIFICATION | Set to false , to ignore SSL verification else set it to true | ## Generate Apigee Edge SAAS/OPDK Auth Tokens: ### Basic Auth: ```bash export SOURCE_AUTH_TOKEN=`echo -n ':' | base64` ``` ### OAuth2/SAML: Refer to the [Apigee documentation](https://docs.apigee.com/api-platform/system-administration/management-api-overview) for generating OAuth2 tokens. ```bash export SSO_LOGIN_URL=https://login.apigee.com # Example export SOURCE_AUTH_TOKEN=$(get_token -u : -m xxxx) # Example using a helper script ``` ### Generate Apigee X/Hybrid Auth Tokens: ```bash export APIGEE_ACCESS_TOKEN=$(gcloud auth print-access-token) ``` ## Run the Tool: ### Local Run: ```bash python3 main.py --resources ``` **Example** : ```bash python3 main.py --resources all ``` ### Docker Run: ```bash mkdir output sudo chmod 777 output export DOCKER_IMAGE=":" docker run --rm -v "$(pwd)/output:/app/target" \ -v "$(pwd)/input.properties:/app/input.properties" \ -e SOURCE_AUTH_TOKEN=$SOURCE_AUTH_TOKEN \ -e APIGEE_ACCESS_TOKEN=$APIGEE_ACCESS_TOKEN \ $DOCKER_IMAGE --resources all ``` **Note:** sudo chmod 777 output _is required for ensuring the non-root user running the python code inside the docker image gets write privileges to your local machine as the volume is mounted to you local machine._ **Example** : ```bash mkdir output sudo chmod 777 output export DOCKER_IMAGE="ghcr.io/apigee/apigee-migration-assessment-tool/apigee-migration-assessment-tool:latest" docker run --rm -v "$(pwd)/output:/app/target" \ -v "$(pwd)/input.properties:/app/input.properties" \ -e SOURCE_AUTH_TOKEN=$SOURCE_AUTH_TOKEN \ -e APIGEE_ACCESS_TOKEN=$APIGEE_ACCESS_TOKEN \ $DOCKER_IMAGE --resources all ``` ## Accessing the Report and Visualization - **Assessment Report:** qualification\_report.xlsx in the TARGET\_DIR (specified in input.properties). Please find [sample assessment](https://github.com/apigee/apigee-migration-assessment-tool/blob/main/sample/outputs/sample_qualification_report.xlsx) in the [sample/outputs](https://github.com/apigee/apigee-migration-assessment-tool/blob/main/sample/outputs) folder - **Visualization:** visualization.html in the TARGET\_DIR. Open this file in a web browser. Refer the sample visualization ## Video recording This video provides a step-by-step guide on how to use tooling. Whether you’re a beginner or an experienced user, this video will equip you with the knowledge you need to make the most of this tool. [![](https://d2yds90mtvelsl.cloudfront.net/original/3X/5/c/5c3df8d5749eace3c850d0343d7cef5cd4a5114a.jpeg "Apigee Migration Assessment Tool") ](https://www.youtube.com/watch?v=LPw-zQ5PtlQ) ## Contributing Open-source tools thrive on community involvement, and GitHub is the perfect platform for collaboration. Whether you’ve encountered a [bug](https://github.com/apigee/apigee-migration-assessment-tool/issues/new?template=bug_report.md), have a suggestion for a [new feature](https://github.com/apigee/apigee-migration-assessment-tool/issues/new?template=feature_request.md), or simply want to share your thoughts on how the tool could be improved, creating an [issue](https://github.com/apigee/apigee-migration-assessment-tool/issues/new?template=bug_report.md) on the repository is the best way to do it. By clearly outlining the problem or idea, including steps to reproduce it if applicable, and labeling it appropriately, you’ll be contributing directly to the tool’s development and helping make it better for everyone. Don’t hesitate to open an issue, no matter how small or large you think it might be – your input is valuable! [Speak with a Google Cloud Sales Expert](https://goo.gle/3FyfV6y)