docs: add OTPKI Connector integration guide#331
Conversation
Administrator-facing guide for the OTPKI Connector — an ILM Authority Provider v3 connector that fronts the OTPKI backend over Connect-RPC. Covers deployment (environment variables, Docker, Kubernetes), connector registration, authority and RA-profile configuration, the certificate lifecycle (issue, renew, register, revoke, discover, CRL), the Attributes v2 interface, constraints, and troubleshooting. Also lists the connector in the available-connectors catalog. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
|
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| # Integration Guide |
There was a problem hiding this comment.
This seems to be technical documentation instead of user guidance on how to setup integration with OTPKI, which does not belong here.
The connector is already part of the Helm chart or operator for deployment.
The integration guide should contain description what needs to be configured in OTPKI to make integration happen and test. See other integration guide. This should be removed.
There was a problem hiding this comment.
Reworked the guide to focus on the OTPKI-side setup and testing, matching the other integration guides. It now covers: the OAuth2 client the connector authenticates as and the operations it must be allowed to perform; the CA, certificate profile, and end-entity profile to configure in OTPKI (including the API-enrollment and supplied-password requirements the profile must meet); connecting the OTPKI authority in ILM; and testing by issuing a certificate. The connector deployment and internal-API sections are removed, since the connector ships with ILM via the Helm chart / operator.
One open point: the connector repository doesn't document the exact OTPKI admin procedures (they are assumed pre-provisioned), and I couldn't find an OTPKI product-documentation URL to reference. The guide describes what must exist and defers the how-to to "the OTPKI documentation". Is there an OTPKI docs page I should link for those steps?
Rework the OTPKI Connector integration guide per review: describe what must be configured in OTPKI (OAuth2 client, CA, certificate profile, end-entity profile) and how to test the integration, matching the other integration guides. Remove the connector deployment and internal API details — the connector is deployed with ILM through the Helm chart or operator. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Summary
Adds an administrator-facing integration guide for the OTPKI Connector — an ILM Authority Provider v3 connector that fronts the OTPKI backend over Connect-RPC — modelled on the existing EJBCA NG Connector guide.
What's included
/v2/attributes)Also lists the connector in the
available-connectorscatalog.Files
docs/certificate-key/integration-guides/otpki-connector/integration-guide.md(new)docs/certificate-key/integration-guides/otpki-connector/_category_.json(new)docs/certificate-key/connectors/available-connectors.md(catalog row)Verification
docusaurus buildpasses — MDX compiles and theonBrokenLinks: 'throw'checker passes repo-wide.Content was sourced from the connector on the
issue-25branch (OmniTrustILM/otpki-connector#25, Attributes v2 interface).🤖 Generated with Claude Code