Skip to content

docs: explain RecoveryThreshold config option #900

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.

Sign up for GitHub

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

Merged
daniel-weisse merged 1 commit into from
Dec 19, 2025
Merged

docs: explain RecoveryThreshold config option #900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/docs/workflows/define-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,7 @@
{
"SealMode": "ProductKey",
"UpdateThreshold": 5,
"RecoveryThreshold": 3,
"FeatureGates": []
}
//...
Expand All @@ -545,6 +546,10 @@
If not set, or set to zero, all users with roles that have the `UpdateManifest` action need to acknowledge the update.
The user submitting the update implicitly acknowledges it as well, meaning an `UpdateThreshold` of `1` requires no further acknowledgements from other users.

`RecoveryThreshold` specifies the number of recovery secrets required for [multi-party recovery](../features/recovery.md#multi-party-recovery).
If set, must be at least `2` and at most the number of defined recovery keys.
If not set, or set to zero, all recovery keys defined in the manifest are required for recovery.

Check warning on line 551 in docs/docs/workflows/define-manifest.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'are required' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'are required' looks like passive voice.", "location": {"path": "docs/docs/workflows/define-manifest.md", "range": {"start": {"line": 551, "column": 71}}}, "severity": "INFO"}

`FeatureGates` allows you to opt-in to additional features that may be useful for certain use cases. The following features are available:

* `SignQuoteEndpoint`: enables the [sign-quote endpoint](../reference/coordinator.md#verify-and-sign-an-sgx-quote)
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/workflows/recover-coordinator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ After recovery, you can scale the Coordinator back to the desired number of inst

:::

:::tip

Use the [`RecoveryThreshold` manifest option](./define-manifest.md#config) to set the number of secrets required to recover the Coordinator.

:::

### Example

The following gives an example of a multi-party recovery workflow.
Expand Down