Skip to content

docs: add OTPKI Connector integration guide#331

Open
karolhrdina wants to merge 2 commits into
OmniTrustILM:release/2.19.0from
karolhrdina:docs/otpki-connector-integration-guide
Open

docs: add OTPKI Connector integration guide#331
karolhrdina wants to merge 2 commits into
OmniTrustILM:release/2.19.0from
karolhrdina:docs/otpki-connector-integration-guide

Conversation

@karolhrdina

Copy link
Copy Markdown

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

  • How the connector works — architecture and the two configuration planes (process env vars vs. per-request ILM authority attributes), with a PlantUML issuance sequence diagram
  • Deploy — environment-variable reference, Docker, and a hardened Kubernetes example
  • Register the connector in ILM
  • Create an authority — the OTPKI connection attributes (base/token URL, OAuth2 client credentials, TLS trust, timeouts/retries)
  • Create RA profiles — end-entity profile → certificate profile / CA cascade, and login-id strategies
  • Certificate lifecycle — issue, renew, register, revoke (with supported reasons), discover, CRL
  • Attributes v2 interface (/v2/attributes)
  • Constraints and Troubleshooting

Also lists the connector in the available-connectors catalog.

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

  • Full docusaurus build passes — MDX compiles and the onBrokenLinks: 'throw' checker passes repo-wide.
  • The PlantUML diagram was validated through the repo's render pipeline (marker/normalize/hash).

Content was sourced from the connector on the issue-25 branch (OmniTrustILM/otpki-connector#25, Attributes v2 interface).

🤖 Generated with Claude Code

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>
@CLAassistant

CLAassistant commented Jul 17, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

sidebar_position: 1
---

# Integration Guide

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

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?

@lubomirw
lubomirw changed the base branch from documentation to release/2.19.0 July 17, 2026 08:49
@lubomirw lubomirw added the documentation Documentation work label Jul 17, 2026
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>
@karolhrdina
karolhrdina requested a review from 3keyroman July 17, 2026 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants