Skip to content
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.

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

Added documentation for Introspection API #17753

Merged
merged 13 commits into from
Nov 11, 2022
Merged

Added documentation for Introspection API #17753

merged 13 commits into from
Nov 11, 2022

Conversation

divyaac
Copy link
Contributor

@divyaac divyaac commented Oct 31, 2022

No description provided.

website/content/api-docs/system/inspect/index.mdx Outdated Show resolved Hide resolved
@@ -0,0 +1,17 @@
---
layout: api
page_title: /sys/internal/inspect - HTTP API
Copy link
Contributor

Choose a reason for hiding this comment

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

The RFC mentions that because this would expose information at a similar sensitivity to sys/raw, there would be more required to enable the endpoint. We should document somewhere how to enable and disable the feature. sys/raw config is documented here https://developer.hashicorp.com/vault/docs/configuration#parameters and the API docs (https://developer.hashicorp.com/vault/api-docs/system/raw) link to that page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes - added this as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding the link, but I think we also should document what they need to change in the configuration to enable this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Spoke to Josh about this - it seems that sys/raw is off by default because it's a dangerous endpoint that if used incorrectly has the capacity to change storage.

Since this endpoint is a read only endpoint, we think it's probably not necessary to have it off by default.
The way it's currently implemented also configured this way.

I removed this portion form the docs.

website/content/api-docs/system/inspect/router.mdx Outdated Show resolved Hide resolved
website/content/api-docs/system/inspect/router.mdx Outdated Show resolved Hide resolved

## Supported Inspection Paths

- [Router](/api-docs/system/internal/inspect/router)
Copy link
Contributor

@mladlow mladlow Nov 7, 2022

Choose a reason for hiding this comment

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

In the vercel preview, this link is broken - I think because the path in the api-docs-nav json doesn't have the internal part of the link. Edit (sorry missed this on the first pass)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed this in the current commit

---

# `/sys/internal/inspect/router`
The `/sys/internal/inspect/router` is intended for Vault admin to inspect a specific internal subsystem for debugging purposes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The `/sys/internal/inspect/router` is intended for Vault admin to inspect a specific internal subsystem for debugging purposes.
The `/sys/internal/inspect/router` is intended for a Vault admin to inspect a specific internal subsystem of the router for debugging purposes.


# `/sys/internal/inspect/router`
The `/sys/internal/inspect/router` is intended for Vault admin to inspect a specific internal subsystem for debugging purposes.
This token can be accessed with a root token or sudo privileges.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This token can be accessed with a root token or sudo privileges.
This endpoint can be accessed with a root token or sudo privileges.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

Copy link
Contributor

@raskchanky raskchanky left a comment

Choose a reason for hiding this comment

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

Looks great! Just a few minor nits.

website/content/api-docs/system/inspect/index.mdx Outdated Show resolved Hide resolved
website/content/api-docs/system/inspect/router.mdx Outdated Show resolved Hide resolved
website/content/api-docs/system/inspect/router.mdx Outdated Show resolved Hide resolved
Co-authored-by: Josh Black <raskchanky@users.noreply.github.com>
divyaac and others added 2 commits November 10, 2022 16:43
Co-authored-by: Josh Black <raskchanky@users.noreply.github.com>
Co-authored-by: Josh Black <raskchanky@users.noreply.github.com>
@divyaac divyaac merged commit 55ea56f into main Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants