Skip to content

fix(docs): mark --public-key-remote and --public-keys as deprecated in kas-registry docs #791

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

Open
marythought wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): mark --public-key-remote and --public-keys as deprecated in kas-registry docs #791

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/man/policy/kas-registry/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ command:
default: ''
---

:::warning Deprecated flags
`--public-keys` and `--public-key-remote` are deprecated and will be removed in an upcoming release.
Use `otdfctl policy kas-registry key create` to manage KAS keys instead.
:::

## Examples

```shell
Expand Down
15 changes: 10 additions & 5 deletions docs/man/policy/kas-registry/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ command:
description: URI of the Key Access Server
- name: public-keys
shorthand: c
description: One or more 'cached' public keys saved for the KAS
description: "(Deprecated: Use otdfctl policy kas-registry key) One or more 'cached' public keys saved for the KAS"
- name: public-key-remote
shorthand: r
description: URI of the 'remote' public key of the Key Access Server
description: "(Deprecated: Use otdfctl policy kas-registry key) URI of the 'remote' public key of the Key Access Server"
- name: name
shorthand: n
description: Optional name of the registered KAS (must be unique within Policy)
Expand All @@ -30,7 +30,12 @@ command:
default: false
---

Update the `uri`, `metadata`, or key material (remote/cached) for a KAS registered to the platform.
Update the `uri`, `metadata`, or name for a KAS registered to the platform.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Apr 3, 2026

Choose a reason for hiding this comment

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

medium

For consistency with the warning block added below and to follow standard documentation practices for technical terms (flags and parameters), the terms uri, metadata, and name should be wrapped in backticks.

Suggested change
Update the `uri`, `metadata`, or name for a KAS registered to the platform.
Update the `uri`, `metadata`, or `name` for a KAS registered to the platform.


:::warning Deprecated flags
`--public-keys` and `--public-key-remote` are deprecated and will be removed in an upcoming release.
Use `otdfctl policy kas-registry key` commands to manage KAS keys instead.
:::

If resource data has been TDFd utilizing key splits from the registered KAS, deletion from
the registry (and therefore any associated grants) may prevent decryption depending on the
Expand All @@ -40,8 +45,8 @@ Make sure you know what you are doing.

For more information about registration of Key Access Servers, see the manual for `kas-registry`.

## Example
## Example

```shell
otdfctl policy kas-registry update --id 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --name example-kas2-newname --public-key-remote "https://example.com/kas2/new_public_key"
otdfctl policy kas-registry update --id 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --name example-kas2-newname
```
Loading