DOCS-823: Clarify certificate discovery behavior and troubleshooting

[harrison-akeyless]

Summary

• expand certificate discovery guidance for internal domains, public domains, IP, and CIDR sources
• add troubleshooting steps for gateway traffic origin, log review, and debug-mode execution
• clarify deployment compatibility check path when environments report only akeyless-api-proxy
• document current in-container logging behavior and planned STDOUT-only direction
• mention AI Insights through Active Directory migration flow for local file system certificate discovery

Validation

• pre-commit run --files "docs/Certificate Lifecycle Management/certificate-discovery.md"

Jira

• DOCS-823

Summary by CodeRabbit

• Documentation
  • Enhanced certificate discovery guide with metadata recording and expiration tracking details
  • Added Gateway version 4.46.0+ requirement information
  • New sections covering discovery behavior for public/internal domains and IP/CIDR sources
  • Expanded CLI examples and troubleshooting diagnostic guidance

[coderabbitai]

Warning

Rate limit exceeded

@harrison-akeyless has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 46 minutes and 6 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 96176239-dd8a-402e-a846-c9cc94d39642

📥 Commits

Reviewing files that changed from the base of the PR and between 45bf916 and 6edf774.

📒 Files selected for processing (2)

• docs/Certificate Lifecycle Management/certificate-discovery.md
• docs/Integrations & Plugins/cli-reference/cli-reference-certificates.md

📝 Walkthrough

Walkthrough

This PR enhances the certificate discovery documentation by adding clarifications on automated metadata recording, Early Access version gating, discovery behavior across different source types, expanded CLI examples with debug mode, and a new troubleshooting section with container log inspection and debug command guidance.

Changes

Certificate Discovery Documentation

Layer / File(s)	Summary
Core discovery behavior and metadata handling docs/Certificate Lifecycle Management/certificate-discovery.md	Introduces automated certificate record creation with metadata, optional expiration-event tracking, Early Access gating for Gateway 4.46.0+, guidance on interpreting akeyless-api-proxy logs, and describes discovery behavior across public domains, internal domains, subdomains, and IP/CIDR sources.
CLI command and flag documentation docs/Certificate Lifecycle Management/certificate-discovery.md	Updates CLI command example to include --gateway-url and --debug flags, and documents the --debug flag as enabling verbose troubleshooting output for certificate discovery operations.
Troubleshooting guide docs/Certificate Lifecycle Management/certificate-discovery.md	Adds comprehensive troubleshooting section with deployment/version requirements checklist, gateway network path expectations, container log inspection commands, debug-mode CLI invocation examples, and guidance for correlating CLI output timestamps with gateway logs and interpreting failure counters.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• Avi-Akeyless
• EldadH89

Poem

🐰 A rabbit hops through docs with care,
Adding troubleshooting guides so rare,
Discovery paths now crystal clear,
Debug mode shining far and near,
Knowledge shared for all to cheer!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title directly and specifically describes the main changes: clarifying certificate discovery behavior and adding troubleshooting guidance, which aligns perfectly with the documentation updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch v1.0_docs-823

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/Certificate Lifecycle Management/certificate-discovery.md (1)

1-7: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Add required ReadMe.com front matter keys.

This page is missing required front matter fields: excerpt, and metadata.title + metadata.description.

Proposed front matter patch

 ---
 title: Certificate Discovery
+excerpt: Discover and inventory certificates across public and internal sources.
 deprecated: false
 hidden: false
 metadata:
+  title: Certificate Discovery
+  description: Learn how to configure, run, and troubleshoot certificate discovery in Akeyless.
   robots: index
 ---

As per coding guidelines, "Ensure ReadMe.com pages have front matter with required keys: title, excerpt, deprecated, hidden, and metadata (title, description, robots)".

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/Certificate` Lifecycle Management/certificate-discovery.md around lines
1 - 7, The front matter for the Certificate Discovery page is missing required
keys; update the YAML at the top of this file to include an excerpt field and
complete metadata with metadata.title and metadata.description (in addition to
the existing title, deprecated, hidden, and metadata.robots) so it conforms to
ReadMe.com requirements; place a concise one-line excerpt and descriptive
metadata.title and metadata.description values that summarize the page content.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/Certificate` Lifecycle Management/certificate-discovery.md:
- Around line 113-114: The numbered troubleshooting list restarts after item 5;
update the two subsequent list entries currently beginning "Interpret report
counters by target execution status..." and "Use AI Insights in the Active
Directory migration flow..." to continue as items 6 and 7 (not 1 and 2) so the
ordered sequence remains contiguous and renders correctly.

---

Outside diff comments:
In `@docs/Certificate` Lifecycle Management/certificate-discovery.md:
- Around line 1-7: The front matter for the Certificate Discovery page is
missing required keys; update the YAML at the top of this file to include an
excerpt field and complete metadata with metadata.title and metadata.description
(in addition to the existing title, deprecated, hidden, and metadata.robots) so
it conforms to ReadMe.com requirements; place a concise one-line excerpt and
descriptive metadata.title and metadata.description values that summarize the
page content.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 29178025-1b01-478a-9212-4acaa299a2df

📥 Commits

Reviewing files that changed from the base of the PR and between 42c6804 and 45bf916.

📒 Files selected for processing (1)

• docs/Certificate Lifecycle Management/certificate-discovery.md

[EldadH89]

great work