Skip to content

Create Plan your upgrade rollout doc#6211

Open
janugeethakumari-okta wants to merge 5 commits into
masterfrom
jg-OKTA-1192952-plan-upgrade-rollout-doc
Open

Create Plan your upgrade rollout doc#6211
janugeethakumari-okta wants to merge 5 commits into
masterfrom
jg-OKTA-1192952-plan-upgrade-rollout-doc

Conversation

@janugeethakumari-okta

@janugeethakumari-okta janugeethakumari-okta commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Description

  • What's changed?
    Adds a new developer guide, Plan your upgrade rollout, for the "Prepare to Upgrade to Okta Identity Engine" journey.
    The guide walks developers and admins through sequencing org upgrades (preview → sandbox → production), rolling out Identity Engine flows gradually to user segments using code-based routing, load balancing, or incremental scaling, and replacing deprecated features — Integrated Windows Authentication, Device Trust, and Okta Mobile — before the upgrade.

This update also adds five new sections sourced from gaps identified against the admin-facing help.okta.com content:

  • Upgrade your Sign-In Widget
  • Update event hook endpoints
  • Prepare Terraform for the upgrade
  • Build a test plan
  • Plan for rollback

Files changed:

  • Add docs/guides/oie-upgrade-rollout-plan/ (index.md + main/index.md)
  • Register the guide in docs/guides/index.md
  • Add the guide to the Okta Identity Engine upgrade section in navbar.const.js

Is this PR related to a Monolith release?
No. Targeting the July monthly developer docs release (code freeze June 26, 2026.07.0).

Resolves

Netlify preview link

Preview link

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/main/index.md 78 66 100 59

Successfully checked 3 of 3 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/main/index.md 79 66 100 62

Successfully checked 3 of 3 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/main/index.md 81 76 100 67

Successfully checked 3 of 3 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/main/index.md 80 77 89 67

Successfully checked 3 of 3 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-rollout-plan/main/index.md 81 80 92 66

Successfully checked 3 of 3 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@grahamsmith-okta grahamsmith-okta left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few comments


#### What you need

* Access to the Admin Console for each org you plan to upgrade

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Access to the Admin Console for each org you plan to upgrade
* Access to the Admin Console for each org that you plan to upgrade

Whichever strategy you choose, follow this sequence:

1. Start with internal users or a small test group.
2. Validate sign-in, registration, MFA enrollment, and password recovery end-to-end.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Validate sign-in, registration, MFA enrollment, and password recovery end-to-end.
2. Validate sign-in, registration, MFA enrollment, and password recovery flows end to end.


## Upgrade your Sign-In Widget

If your app uses an embedded Sign-In Widget, verify that it runs version 5.11.0 or later before you schedule the org upgrade. Earlier versions don't support Identity Engine flows. If you haven't already upgraded the widget, do it now as part of your rollout prep, not at the same time as the org upgrade.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If your app uses an embedded Sign-In Widget, verify that it runs version 5.11.0 or later before you schedule the org upgrade. Earlier versions don't support Identity Engine flows. If you haven't already upgraded the widget, do it now as part of your rollout prep, not at the same time as the org upgrade.
If your app uses an embedded Sign-In Widget, verify that it runs version 5.11.0 or later before you schedule the org upgrade. Earlier versions don't support Identity Engine flows. If you haven't already upgraded the widget, do it now as part of your rollout prep.


## Replace Integrated Windows Authentication

Integrated Windows Authentication (IWA) routing rules needs to be removed before you can upgrade. The Identity Engine Upgrade Hub blocks the upgrade if any IWA routing rules exist in your org.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Integrated Windows Authentication (IWA) routing rules needs to be removed before you can upgrade. The Identity Engine Upgrade Hub blocks the upgrade if any IWA routing rules exist in your org.
Remove Integrated Windows Authentication (IWA) routing rules before you upgrade. The Identity Engine Upgrade Hub blocks the upgrade if any IWA routing rules exist in your org.


Integrated Windows Authentication (IWA) routing rules needs to be removed before you can upgrade. The Identity Engine Upgrade Hub blocks the upgrade if any IWA routing rules exist in your org.

To prepare:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To prepare:
To prepare, complete the following steps:


Classic Engine Device Trust isn't supported in Identity Engine. The replacement is Okta Verify with managed certificates and Okta FastPass.

Start by identifying whether your org uses Device Trust for Desktop, mobile, or both, then plan the migration path for each.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Start by identifying whether your org uses Device Trust for Desktop, mobile, or both, then plan the migration path for each.
Start by identifying whether your org uses Device Trust for Desktop, mobile, or both, and then plan the migration path for each.


## Replace Okta Mobile

Okta Mobile is deprecated and unavailable after the Identity Engine upgrade. Before upgrading, make sure that all affected users are enrolled in Okta Verify.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Okta Mobile is deprecated and unavailable after the Identity Engine upgrade. Before upgrading, make sure that all affected users are enrolled in Okta Verify.
Okta Mobile is unavailable in Identity Engine. Before upgrading, make sure that all affected users are enrolled in Okta Verify.

Okta Mobile is deprecated and unavailable after the Identity Engine upgrade. Before upgrading, make sure that all affected users are enrolled in Okta Verify.

* Identify which users currently rely on Okta Mobile.
* Communicate the deprecation timeline to those users.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the phrase "deprecation timeline" accurate? Okay if so, but I don't think we call other features that are Classic-only "deprecated in OIE"

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

Successfully merging this pull request may close these issues.

2 participants