Legacy portal deprecation

mikebudzynski commented 5 years ago

If you have questions, comments, or concerns related to deprecation of the old developer portal, please post them here.

Aggregate:

Concerns around a possibility of breaking existing DevOps pipelines
Disabling the old portal in API Management service
VNET configuration changes

dcbrown16 commented 5 years ago

Is there a timeline for deprecation, i.e. months or a year after GA?

mikebudzynski commented 5 years ago

@dcbrown16 - not at this moment. Any concerns whether it's for example 6 months vs 1 year?

dcbrown16 commented 5 years ago

@mikebudzynski I'm checking in for a customer in Japan through support. They don't have any particular requests regarding the period, as long as it is announced clearly. Thanks!

dcbrown16 commented 5 years ago

We have some additional detailed questions:

Are there any changes in the network configuration required for API Management instances in virtual networks (internal or external) when switching from the old to new portal?
Do we specifically know what notifications will be provided to users when deprecation is determined/approaching? Documents/Portal notifications/emails (to whom)?

mikebudzynski commented 5 years ago

@dcbrown16 Thanks, good points. Just to clarify - there won't be an automatic switch to the new version. It's a manual process to configure the new portal in a similar manner to the old one, as indicated here: https://docs.microsoft.com/azure/api-management/api-management-howto-developer-portal#faq

Yes, VNET configuration needs to be modified. We're working on clear documentation on this subject.
API Management updates are posted here: http://aka.ms/apimupdates We'll consider sending emails as well.

jstallm commented 5 years ago

Once the new developer portal is GA, how do we disable the legacy developer portal explicitly if we wanted to? Say for instance that we wanted to avoid having 2 locations for documentation, and instead simply migrate exclusively to the new portal. Im wondering if this is an option.

mikebudzynski commented 5 years ago

This will be possible after GA - probably a few months after the release.

A workaround in the meantime would be to use the Application Gateway with API Management in VNET and not expose the old developer portal to the public.

jstallm commented 5 years ago

thank you @mikebudzynski , Im happy to hear this will be supported after GA. Thank you as well for the secondary idea for isolating the old developer portal from public.

DonatasMaz commented 5 years ago

Hello, Currently, we are building our new API Product which will be released at the end of 2019. Here, we do have a dilemma.:

Having in mind that MS plans to launch the GA version at the end of the year and we plan to launch our API platform at the same time, what your general advice would be for customizing/and preparing dev portal? Should we develop our Dev Portal based on New Dev Portal or should we go with both?

Many thanks, Donatas

mikebudzynski commented 5 years ago

@DonatasMaz

Having in mind that MS plans to launch the GA version at the end of the year and we plan to launch our API platform at the same time, what your general advice would be for customizing/and preparing dev portal? Should we develop our Dev Portal based on New Dev Portal or should we go with both?

We plan to have a production-ready version of the portal in mid-November and the new version will include significant changes to the widgets (some are already there) and default content and structure. If this timeline works for you, I suggest that you hold off until then and go with the new developer portal - especially because there won't be an automated migration between the old and the new portals.

rholloran commented 5 years ago

Any idea on timing of the old portal deprecation? It would be good to know for planning purposes. We would prefer at least 8 months notice - 12 months preferred.

mikebudzynski commented 5 years ago

The deprecation plans are not finalized yet. Any deprecation will be announced at least 6 month in advance

ryangs1 commented 4 years ago

What are the migration steps to convert an existing APIM instance to use the new dev portal? Or does a new APIM instance have to be created at this time as a replacement?

mikebudzynski commented 4 years ago

What are the migration steps to convert an existing APIM instance to use the new dev portal? Or does a new APIM instance have to be created at this time as a replacement?

https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal#how-can-i-migrate-from-the-old-developer-portal-to-the-new-developer-portal No need to recreate API Management service.

ilyabelkin commented 4 years ago

Hi Mike, thanks for all the work on the new Developer Portal! Do you have a timeline for enabling social login providers for sign-up and sign-in? I've noticed you have a card titled "[Later] Sign in/up with online identity providers", is it planned in the short-term? We came to rely on Google for sign in since AD is not supported in some tiers of the API Management.

mikebudzynski commented 4 years ago

@ilyabelkin That's valuable feedback, thanks for sharing it. We don't have a timeline yet, but we'll prioritize this work item; I'll update you once we know more. Realistically, we can aim at January/February.

ilyabelkin commented 4 years ago

Thank you Mike, please don't deprecate the old portal before you implement this!

mikebudzynski commented 4 years ago

We're not deprecating the old portal yet and any deprecation will be announced more than 6 months in advance.

seekingtheoptimal commented 4 years ago

In the new portal, the "Try it" functionality seems more limited compared to the "legacy" portal: I couldn't find a way to test authorization for example.

Another problem I've found, related to authorization also on the legacy portal, but couldn't find any place to report it: when doing the authorization once I select my configured Oauth2 from the dropdown, in the token I get in the end, the aud (audience) value gets prepended with the domain of the AAD. My WebApi is configured with the ApplicationID as Audience, and checks are made against this one. When authorizing with the developer portal, the Audience value is https://tenant.onmicrosoft.com/ApplicationID and this causes the token validation to fail.

So, are there any plans to match the capabilities of the new portal with the old one and have ability to test authorization also? And where can I report the issue with the authorization token audience value in the legacy portal? (and if it is an issue?)

mikebudzynski commented 4 years ago

In the new portal, the "Try it" functionality seems more limited compared to the "legacy" portal: I couldn't find a way to test authorization for example.

If you mean OAuth - it's a duplicate of #208

And where can I report the issue with the authorization token audience value in the legacy portal?

Please open a separate issue here and we'll triage it accordingly.

ngobw commented 4 years ago

Will samples be still available in the new API Details page?

azaslonov commented 4 years ago

@ngobw, representation and code samples are there already. You need to click on the "Try it" button. Is there anything in particular that's missing?

Sacratees commented 4 years ago

@mikebudzynski, Any idea on by when we should switch to new developer portal to avoid service interruption?
We may need at least 12 months from now to customize and roll out to new developer portal to our customers.

mikebudzynski commented 4 years ago

@mikebudzynski, Any idea on by when we should switch to new developer portal to avoid service interruption? We may need at least 12 months from now to customize and roll out to new developer portal to our customers.

We haven't announced the legacy portal deprecation and after we announce it, you'll have at least one year to migrate to the new portal. Please, monitor this thread or aka.ms/apimupdates for updates.

However, be aware that the legacy portal won't be receiving new features. We recommend using the new portal, especially if you'd like to benefit from its extended capabilities.

kmurari029 commented 4 years ago

Hi @mikebudzynski, Hope you are doing well! Do we have any latest update till when the Developer porta(legacy) will be supported from the mS azure side? Also, I have a simple web application hosted on legacy one currently. I want it to migrate it to new Developer portal entirely. How to achieve this?. Do we have some configuration changes to be done for the new one?. Also since I am only the developer, and am not even knowing where the current legacy application backend/db part is managed, Please suggest how to handle this. Any documentation/support aprreciated.The application is developed in HTML, CSS, VueJS, Templates, JavaScript. Thanks in advance.

mikebudzynski commented 4 years ago

No updates on the deprecation timeline.
I have a simple web application hosted on legacy one currently

Sorry, I don't understand this part. Your APIs are managed through API Management, so whatever they are, they will also be displayed in the new portal. You need to redo all customizations in the new portal manually. I suggest that you contact Azure support for assistance.

kmurari029 commented 4 years ago

I have a simple web application hosted on legacy one currently

Sorry, I don't understand this part. Your APIs are managed through API Management, so whatever they are, they will also be displayed in the new portal. You need to redo all customizations in the new portal manually. I suggest that you contact Azure support for assistance.

Thank you @mikebudzynski for your answer. Do we have any specific documentation that helps in migration of the existing legacy version application to developer potal latest version end to end?

mikebudzynski commented 4 years ago

Thank you @mikebudzynski for your answer. Do we have any specific documentation that helps in migration of the existing legacy version application to developer potal latest version end to end?

You need to redo the customizations and content in the new portal - there's no workarounds. You can learn how to do it by following this tutorial: https://aka.ms/apimdocs/customizeportal The new portal will automatically have the same users accounts, APIs, Products etc. as the legacy portal.

ilspiert commented 4 years ago

to be honest, I like the new developer portal style and love the on-page designer, but so far it nearly covers 50% of the functionality of the current aka legacy one. And there are some bug which does not allow production use and as well there are some important features missing.

azaslonov commented 4 years ago

Hi @fsettele, do you mind listing all the features you specifically need from the legacy portal?

ilspiert commented 4 years ago

@azaslonov: yes sure. here are some thoughts:

At the moment the new portal feels not very stable, so I expect, to fix all P1 and P0 bugs
Implement issue #533
Better communication about which version is deployed on managed environment
Having a Roadmap, to know which feature or fix is available
More control on the default widgets, like in the old one, to decide which contol will be shown or what information displayed, e.g. in the search widget, I what to hide the "Group by tag" option
The default design of the widgets shoud be improced. The legacy one was more clear. E.g. the reports widget had a taprow, and now its a loooooong list
Allow to setup/define diffrent languages (like the parent project supports https://demo.paperbits.io/) as well with a language switcher (widget) for the customer

Happy to hear your feedback.

mikebudzynski commented 4 years ago

@fsettele,

At the moment the new portal feels not very stable, so I expect, to fix all P1 and P0 bugs

All P0 bugs will soon be resolved. We're waiting on API Management service release roll outs, before we roll out fixes in the developer portal.

Implement issue #533 Better communication about which version is deployed on managed environment Allow to setup/define diffrent languages (like the parent project supports https://demo.paperbits.io/) as well with a language switcher (widget) for the customer

All are on our roadmap. The legacy developer portal didn't have those features, so we don't consider them in terms of feature parity gap.

Having a Roadmap, to know which feature or fix is available

We use Issues and release notes in the Release section for this purpose. We did have Projects milestones, but we didn't find them informative, since we are mostly working on the reported issues. When we resume working on new features, we'll reconsider the Projects section.

More control on the default widgets, like in the old one, to decide which contol will be shown or what information displayed, e.g. in the search widget, I what to hide the "Group by tag" option

Can you please open separate Issues for each of those feature requests? It would help us track and prioritize them.

kwb25 commented 4 years ago

See the developer portal buttons are starting to be disabled in the APIM management UI of the Azure portal. Starting to feel like the end is near..

ilspiert commented 4 years ago

On the "Portal Overview" page its luckily still visible. The question is how long ...

langstonj commented 4 years ago

Help!

Checking today on my production API Management Service I see that Developer portal (legacy) is now greyed out and non-selectable. Developer portal is selectable.

Does this represent the legacy portal deprecation announcement?

mikebudzynski commented 4 years ago

We'll be removing the legacy portal buttons from the "Overview" section of your API Management services; you can still access it from the "Portal overview" section. What you're now seeing is just an intermediary state to visually communicate the change and give you time to adjust, if you're still using the legacy portal.

Does this represent the legacy portal deprecation announcement?

No.

langstonj commented 4 years ago

I guess I'm a little slow on this one but how does one enable the disabled Developer portal (legacy) option under API Management Services?

mikebudzynski commented 4 years ago

See my comment above. If you hover over the disabled button, you'll also see an explanation.

langstonj commented 4 years ago

Thanks for your patience on this….

From: Mike Budzynski notifications@github.com Sent: Tuesday, August 11, 2020 1:00 PM To: Azure/api-management-developer-portal api-management-developer-portal@noreply.github.com Cc: John Langston john.langston@elynxtech.com; Comment comment@noreply.github.com Subject: Re: [Azure/api-management-developer-portal] Community: old portal deprecation (#121)

Warning: This email was sent from a source external to eLynx Technologies. Please use caution when opening attachments or clicking links.

See my comment above. If you hover over the disabled button, you'll also see an explanation.

— You are receiving this because you commented. Reply to this email directly, view it on GitHubhttps://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fapi-management-developer-portal%2Fissues%2F121%23issuecomment-672142831&data=02%7C01%7Cjohn.langston%40elynxtech.com%7Ca157517cdcdf43f51add08d83e206e4c%7C891867d4a39248edac164bd398b62ec9%7C0%7C0%7C637327656330095853&sdata=5S3YPd3Wplk5q%2B6uotPmTWv9h9tUgm8E19o6Bt7V0pc%3D&reserved=0, or unsubscribehttps://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAKQHJAQBKZ5XPX2YHHWWP3TSAGBLXANCNFSM4IHWE5UQ&data=02%7C01%7Cjohn.langston%40elynxtech.com%7Ca157517cdcdf43f51add08d83e206e4c%7C891867d4a39248edac164bd398b62ec9%7C0%7C0%7C637327656330105852&sdata=vzvQwgHv0GRFE1EQsxk%2FAm80x5Q7QBxlshdRu42tNqI%3D&reserved=0.

ilspiert commented 4 years ago

@mikebudzynski : I found an nother missing feature as our backend is secured with OAuth2. There is a restriction on the interactive Console in compartion to the legacy portal:

OAuth 2.0 authorization is not yet available in the interactive console of the new developer portal.

Found that on https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2.

kmurari029 commented 4 years ago

@mikebudzynski : We have an application error on the page- "https://ericssondeveloperapi.portal.azure-api.net/products" Its giving error on the product page- Liquid error: Could not load file or assembly 'System.ValueTuple, Version=4.0.1.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference. (Exception from HRESULT: 0x80131040) Liquid error: Could not load file or assembly 'System.ValueTuple, Version=4.0.1.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference. (Exception from HRESULT: 0x80131040) We haven't made any code changes to it but can see this now coming since past 2 days only. It is happening in all API'S we have this functionality. I suspect some backend/azure upgrade or config change must have happened which is showing this error. Any pointers will be appreciated. Thank you.

mikebudzynski commented 4 years ago

OAuth 2.0 authorization is not yet available in the interactive console of the new developer portal.

Found that on https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2.

OAuth 2.0 is already available in the developer portal, the documentation is outdated - we will fix it.

@kmurari029, thanks for bringing this up, we will investigate this issue.

franktomlinson commented 4 years ago

Can we publish the new developer portal and run it in parrallell with the legacy portal for some time?

mikebudzynski commented 4 years ago

Can we publish the new developer portal and run it in parrallell with the legacy portal for some time?

Yes.

mikebudzynski commented 4 years ago

Legacy developer portal is now deprecated and will retire on October 31, 2023. See this post in API Management's announcements repository for more details and migration instructions.

kmurari029 commented 4 years ago

@mikebudzynski - I am getting this intermittent error on hit of the APIM url (https://momodeveloper.mtn.com/ )- "Something is not right. It could be a temporary glitch or a bug. Please, try again ". The issue is not consistent, it works for some time and some time not. The project is deployed on Legacy portal and is in production. We haven't done any changes of late. However, for some other APIM it's not coming this issue. What could be the issue? Thanks in advance.

mikebudzynski commented 4 years ago

@kmurari029 Please, contact Azure Support - they will be able to assist you with the problem in a timely manner.

vinoth12988 commented 3 years ago

@mikebudzynski Looks like publisher portal (Legacy) option is missing in portal overview. How do we make changes to developer portal (Legacy). We don't see any communication about this change.

kmurari029 commented 3 years ago

@mikebudzynski Looks like publisher portal (Legacy) option is missing in portal overview. How do we make changes to developer portal (Legacy). We don't see any communication about this change.

@mikebudzynski Yes, we now don't see the option- publisher portal(legacy) . How do we do edits to the custom pages created in the existing legacy portal now??

kmurari029 commented 3 years ago

@mikebudzynski Looks like publisher portal (Legacy) option is missing in portal overview. How do we make changes to developer portal (Legacy). We don't see any communication about this change.

@mikebudzynski Yes, we now don't see the option- publisher portal(legacy) . How do we do edits to the custom pages created in the existing legacy portal now??

@vinoth12988 I found it. Click on the Deprecated developer portal link from the Overview portal. It will open your application in admin mode. In the application top right corner, you have Administrator section. Click on it. Then click Manage option. here you get all custom pages created what we had in publisher portal(legacy)

Azure / api-management-developer-portal

Legacy portal deprecation #121