Skip to content

Commit

Permalink
docs: v1.7 versioned docs (#796)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Weiße <dw@edgeless.systems>
  • Loading branch information
daniel-weisse authored Feb 4, 2025
1 parent e4864f9 commit 387eb1c
Show file tree
Hide file tree
Showing 50 changed files with 5,708 additions and 4 deletions.
4 changes: 2 additions & 2 deletions cli/internal/cmd/recover.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ func NewRecoverCmd() *cobra.Command {
Use: "recover <recovery_key_file> <IP:PORT>",
Short: "Recover the MarbleRun Coordinator from a sealed state",
Long: "Recover the MarbleRun Coordinator from a sealed state.\n" +
"<recovery_key_file> may be either a decrypted recovery secret, or an encrypted recovery secret,\n" +
"`recovery_key_file` may be either a decrypted recovery secret, or an encrypted recovery secret,\n" +
"in which case the private key is used to decrypt the secret.",
Example: "marblerun recover recovery_key_decrypted $MARBLERUN",
Example: "marblerun recover recovery_key_file $MARBLERUN",
Args: cobra.ExactArgs(2),
RunE: runRecover,
}
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@ Recover the MarbleRun Coordinator from a sealed state
### Synopsis

Recover the MarbleRun Coordinator from a sealed state.
<recovery_key_file> may be either a decrypted recovery secret, or an encrypted recovery secret,
`recovery_key_file` may be either a decrypted recovery secret, or an encrypted recovery secret,
in which case the private key is used to decrypt the secret.

```
Expand All @@ -943,7 +943,7 @@ marblerun recover <recovery_key_file> <IP:PORT> [flags]
### Examples

```
marblerun recover recovery_key_decrypted $MARBLERUN
marblerun recover recovery_key_file $MARBLERUN
```

### Options
Expand Down
3 changes: 3 additions & 0 deletions docs/versioned_docs/version-1.7/_media/cert-chain.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions docs/versioned_docs/version-1.7/_media/coordinator_deployment.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/versioned_docs/version-1.7/_media/enc-state-single.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 387eb1c

Please sign in to comment.