Repository navigation
Conversation
PFYasu
force-pushed
the
RDoc-4121
branch
2 times, most recently
from
October 2, 2026 13:50
1873135 to
84201a6
Compare
PFYasu
force-pushed
the
RDoc-4121
branch
6 times, most recently
from
October 20, 2026 13:32
9bb5e65 to
a8a609a
Compare
PFYasu
marked this pull request as ready for review
October 21, 2026 06:13
hiddenshadow21
approved these changes
Oct 21, 2026
Document the user-facing changes in the October deployment window, validated against hr/test (acb355545, 2026-10-14). Section 6 and the prod fixes below describe prod as it is today; they ship with the rest of this PR. External SSO & User Management - New cloud-sso page, added to the Cloud sidebar. The portal's docs link already redirects to /cloud/cloud-sso, so no redirect entry is needed. - Availability, roles, management types, IdP requirements, the connect wizard, provider notes, SCIM, group to role mapping, signing in with the sso_* error messages, managing and disabling the connection. - The SCIM userName becomes the SSO user's email and must match the ID token's email claim; Okta and Entra ID notes on how to get there. SCIM PUT updates are applied, PATCH only activates or deactivates. The IdP asks for credentials at every sign-in; the email_verified and allowed-domain checks run at the first sign-in. Troubleshooting for 401, 403 and the userName mismatch. - Overview, Account, Portal, Users & Access, Security and Account tab pages point at it: the login path, the new role, the Account features view, Cloud vs SSO users, MFA for SSO users (a user who already had 2FA on keeps the switch to turn it off), and the group-mapping exception for Account with User Management. Profile redesign - MFA rewritten for the Security page: the Enable 2FA switch, the recovery phone step, recovery codes and their alerts, Forget this browser and the sign-in notice after disabling 2FA. Links point to /portal/profile/security. - Profile menu, sidebar collapse, a new Accepting an invitation section and the Terms of Use / Privacy Policy / Cookie settings links on the sign-in pages. Users & Access permissions panel - Search, Set all to, Existing products / New products, and Security admin as a switch inside each product's access-level menu. Edit Storage - Switching Standard and Premium keeps the capacity and restores the product's performance on switching back; a tier-only Azure change no longer stops the node. Serverless products cannot switch the storage type. Daily monitoring report - The email's suggestions come from that day's events only: High CPU >= 5%, High IO >= 3%, Low memory >= 2% of the day; Low CPU credits, Not responding and OOM restarts on any occurrence. A still-running event is marked as ongoing. CPU priority - No switching between Performance (PN) and Shared / Basic / Standard, in either direction; moving to Performance takes a new product and a data migration, and a PN product cannot change its instance type in the Portal. The CPU Priority slider offers only the priorities the product can switch to; the tier table lists Shared; PS10 is not a Performance tier. Wrong on prod, fixed on the way - "Continue with email" instead of "Send Magic Link"; drop the outdated single-operator note. - Account benefits: a fully used one-time credit is listed under Expired. - Pay Now example: the previous billing period ends on February 25. - Azure Standard disks: 100 MB/s, not 60. - Additional nodes are unavailable for PS and PN, Serverless and yearly contracts. - Cluster Health suggestions: Not responding with its thresholds; the OOM analysis compared the periods the wrong way round. - Billing: the Cost Details button is on the Current billing period costs widget; Billing history rows have Cost Details and See invoice buttons instead of being clickable. - Autoscaling: the grace period is a cooldown counted from the last finished resize, manual ones included, not a delay after a threshold is crossed; its range is 3-1440 minutes, not 3-60. Scaling up takes one signal on one node, scaling down all three signals on every node. Figures - Re-shot on hr/test: the login page (TEST-only captcha banner cut out), the Portal sidebar, both Users & Access permission panels, the Backups list, both marketplace thank-you pages, the MFA figures, Edit Tier, the three Billing widgets, the Cluster Health overview, chart and instance changes table, and Home. - Already out of date on prod, re-shot too: the Support plans (the 6 month plan is 40%, not 30%), the Nodes view with additional nodes, and both Azure Premium SSD v2 dialogs, which now carry the "Choosing Premium SSD v2 is permanent" warning. - The Successfully enabled! dialog and Home re-shot after their portal fixes reached TEST: the dialog no longer says the codes were reset, and Last logged in at shows MM/DD/YYYY HH:mm in local time. - New figures for the recovery-phone step and for Reset recovery codes. - Drop login-page-email.png: the login figure now shows the magic-link form too, so the Login section uses it once at the top. SSO follow-ups The fix for SSO members shown under their synthetic username reached hr/test (003ed205a, 2026-10-15). The widget now lists SSO users by their email address with an SSO badge, locks their rows in SCIM mode, and shows the server's reason when a save fails. The group-mapping lock sentence in cloud-sso now names the widget too. Checked again against hr/test (db5ffb925, 2026-10-19) and the SSO test runs of 2026-10-16 to 2026-10-19: - An account owner who tries SSO gets "You don't have access to this account yet.", not the access-denied message. The owner's login is local, so the sign-in finds no SSO login to match and never reaches the owner check. The access-denied row no longer names the owner, and the owner note says what the owner sees. - The SSO settings page shows its actions menu (Edit, Change management type, Reset identity links, Disable SSO) only to holders of External SSO & User Management. - An SSO user who still has RavenDB Cloud 2FA on is not asked for the code when signing in through SSO. Figures, shot on TEST (2026-10-20): - New: the External SSO & User Management card under Account features, the SSO settings page in Sign-in only mode, Users & Access with the Cloud users and SSO users tables, the Add SSO user panel, and the External sign-in page (in cloud-sso and in the Login section of the overview). - Re-shot: the Account page, which no longer has a Users section, and the product User Access widget with an SSO member and its SSO badge. Prod fixes found on the way Both describe the Portal as it is on PROD today; they ship with the rest of this PR. Billing - The Pay Now button is gone since the Billing & Costs redesign (August 2025): unpaid costs show a "We couldn't process your payment" banner with Retry payment, which opens a Confirm payment dialog (Confirm and pay). Both pages that described Pay Now now describe that flow; the #pay-now anchor is kept for existing links. - Re-shot: the Confirm payment dialog and the Current billing period costs and Account Benefits widgets. Backups - The restore dialog is now Restore Link: steps 1-7 instead of the lettered callouts, a 2-hour default validity that Token Expiration extends to 36 hours with Regenerate restore link, and a restore-time estimate. The Restore the Database section follows the dialog's step numbers. - The restore key covers standard backups and unencrypted databases; the database's own key is needed only for snapshot backups of encrypted databases. - Re-shot: the Restore Link dialog and the revealed restore key (a sample key; the link shown was revoked). Figures from Storybook (hr/test 6a8c7e77f), for views TEST cannot show - Re-shot: the six registration steps, both Marketplace landing pages (step numbers redrawn; AWS now shows Customer Identifier and AWS Account ID), the Customize step of the New Product wizard (only the 6.2 and 7.2 release channels, as on prod), Serverless product details and the Cluster Health suggestions. Sample data throughout: example.com addresses, the example domain, documentation IP ranges. - New: the connect wizard's Identity provider step, the SSO settings page in SCIM mode, Users & Access with SCIM-provisioned SSO users, the Security page of an SSO user, and the profile Invitations page. - Text that came with them: Redeem offer on the registration Summary step (promo codes, on prod since September 2025), what Customer Identifier and AWS Account ID are for, and the disabled actions of SSO users in SCIM mode.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the user-facing changes in the October 2026 deployment window (planned for 2026-10-22), validated against
hr/test(6a8c7e77f, 2026-10-20).Ticket: https://issues.ravendb.net/issue/RDoc-4121
Merge together with the production deployment (2026-10-22), not before. Most of this PR describes behaviour that is only on
hr/test. Two exceptions:cloud-sso.mdxmust go live the same day, because the portal already links to it.One commit; its message follows the same sections as this description.
External SSO & User Management (new page)
New
cloud/cloud-sso.mdx, added tosidebarsCloud.js. The portal'sssoDocsUrl(/docs/article-page/latest/csharp/cloud/cloud-sso) already 301s to/cloud/cloud-sso, so no redirect entry is needed.client_secret_post,email+subin the ID token,email_verified(checked at the first sign-in).userNamebecomes the SSO user's email and must match the ID token'semailclaim, or the first sign-in fails. Okta: Application username format = Email. Entra ID: mapmailtouserNamewhen principal names differ.PUTupdates are applied;PATCHcan only activate or deactivate a user.sso_*error messages, managing, resetting and disabling the connection.userNamemismatch.SSO in existing pages
cloud-overview.mdx: the External SSO login path. Google/GitHub/Microsoft sign-in is no longer called "single sign-on".cloud-account.mdx: the new External SSO & User Management role, and what Account with User Management can do once SSO is set up.cloud-portal.mdx: the Account features sidebar view and its role gate.cloud-portal-account-tab.mdx: pointer to Account features.cloud-portal-products-tab.mdx): SSO users listed by their email address with an SSO badge, their rows locked in SCIM mode, and the server's reason shown when a save fails.cloud-security.mdx: MFA for SSO users. An SSO user who already had 2FA on keeps the switch to turn it off, and is not asked for the code when signing in through SSO. Turning 2FA off works for SSO logins only with the SSOUserManagerfix, which is onhr/testsince 2026-10-19 and ships in the same deployment.Profile redesign
/portal/profile/security.Users & Access permissions panel
Search, Set all to, Existing products / New products. Security admin is now a switch inside each product's access-level menu (
cloud-account.mdx).Edit Storage
Daily monitoring report
The daily summary email's suggestions come from that day's events only (checked on TEST on 2026-10-16 against seeded events):
CPU priority (prod behaviour, documented now)
Wrong on prod, fixed on the way
#pay-nowanchor is kept;cloud-backup-and-restore.mdx): the dialog is now Restore Link, with steps 1-7 instead of lettered callouts, a 2-hour default validity that Token Expiration extends to 36 hours with Regenerate restore link, and a restore-time estimate. The restore key covers standard backups and unencrypted databases; the database's own key is needed only for snapshot backups of encrypted databases.cloud-overview.mdx): the Summary step's Redeem offer (promo codes, on prod since September 2025) was not documented.cloud-aws-marketplace.mdx): the landing page shows the Customer Identifier and AWS Account ID (on prod since January 2026); the docs now say they are only needed to convert an existing Cloud account, and the conversion section asks for both.cloud-features.mdx,cloud-instances.mdx): the grace period is a cooldown counted from the last finished resize, manual ones included, not a delay after a threshold is crossed, and its range is 3-1440 minutes, not 3-60. Added how the signals combine: scaling up takes any one signal on any node, scaling down all three signals on every node.Figures
hr/test:MM/DD/YYYY HH:mmlocal time;profile-enable-mfa-phone.png(the recovery-phone step) andprofile-reset-recovery-codes.png(Reset recovery codes).login-page-email.png: the login figure shows the magic-link form too, so the Login section uses it once at the top.hr/test(6a8c7e77f), for views the TEST accounts cannot show:example.okta.com, copyable URLs usecloud.ravendb.net, and test rows and names were hidden or replaced in the browser before the shot. The Storybook shots use the same kind of data (example.comaddresses, theexampledomain, documentation IP ranges), and the release channels show only 6.2 and 7.2, as on prod.Not verified on TEST yet
mailtouserNamemapping. Entra ID is set up on TEST, but its sign-in never reaches the app: the AWS WAF in front of TEST and PROD refuses the callback, whose query string is over its 2,048-byte limit. A Cloud bug is filed and linked to the deployment.email_verified: falserefusal and theclient_secret_basiclimitation come from the code: Okta neither assertsfalsenor enforcesclient_secret_basic, so neither could be reproduced.The cosmetic-only figures are listed in the ticket. Left as they are: the annotated product-list figures (only their copy icon changed) and Edit Storage with the Azure performance tier (no TEST product has that field).