-
Notifications
You must be signed in to change notification settings - Fork 1
WIP - PACXDR connector #27
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
base: main
Are you sure you want to change the base?
Conversation
📝 WalkthroughWalkthroughThis PR introduces documentation and setup guides for a new Palo Alto Networks Cortex XDR connector, updates branding for the Cortex XSOAR connector, reorganizes connector references across documentation indexes to use standardized paths, and updates configuration metadata to register both connectors. Changes
Poem
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 5
🤖 Fix all issues with AI agents
In `@baton/capabilities.mdx`:
- Around line 168-169: The two table rows use incorrect path prefixes; replace
the link targets "[Palo Alto Networks Cortex XDR](/docs/baton/palo-alto-cortex)"
and "[Palo Alto Networks Cortex XSOAR](/docs/baton/xsoar)" in
baton/capabilities.mdx with the consistent paths "/baton/palo-alto-cortex" and
"/baton/xsoar" respectively so they match the docs.json registrations (e.g.,
change to "[Palo Alto Networks Cortex XDR](/baton/palo-alto-cortex)" and "[Palo
Alto Networks Cortex XSOAR](/baton/xsoar)").
In `@baton/intro.mdx`:
- Around line 202-203: Update the incorrect link prefixes: replace occurrences
of "/docs/baton/palo-alto-cortex" and "/docs/baton/xsoar" in this file with
"/baton/palo-alto-cortex" and "/baton/xsoar" respectively (there are multiple
instances including the shown diff and two other occurrences elsewhere in the
file); ensure all five instances use the standard "/baton/..." connector path so
the links resolve correctly.
In `@baton/palo-alto-cortex.md`:
- Around line 22-24: Fix the grammatical typo inside the hint block: change the
text "A an **Instance Administrator** in Cortex XDR must perform this task." to
"An **Instance Administrator** in Cortex XDR must perform this task." by editing
the string within the {{% hint style="warning" %}} ... {{% /hint %}} block so
the leading article is corrected.
- Line 94: The self-hosted connector link text for "Cortex XDR" is pointing to
the wrong GitHub repo (baton-pandadoc); update the markdown link so its URL
references the correct repository name baton-palo-alto-cortex (the same repo
used in the Kubernetes examples), e.g., change the href in the sentence starting
"**Follow these instructions to use the [Cortex XDR]...**" to point to
https://github.com/ConductorOne/baton-palo-alto-cortex.
In `@baton/palo-alto-cortex.mdx`:
- Around line 25-27: Fix the grammatical typo inside the Warning block: replace
the string "A an **Instance Administrator** in Cortex XDR must perform this
task." with the correct article "An **Instance Administrator** in Cortex XDR
must perform this task." so the Warning text reads correctly; update the Warning
element content in baton/palo-alto-cortex.mdx accordingly.
🧹 Nitpick comments (1)
baton/palo-alto-cortex.mdx (1)
184-186: Quote the boolean value in the YAML secret.Environment variables are strings, so the boolean
trueshould be quoted to avoid potential parsing issues when the secret is consumed.🔧 Suggested fix
# Optional: Include if you want ConductorOne to provision access using this connector - BATON_PROVISIONING: true + BATON_PROVISIONING: "true"
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
baton/_release-notes.mdxbaton/capabilities.mdxbaton/intro.mdxbaton/palo-alto-cortex.mdbaton/palo-alto-cortex.mdxbaton/xsoar.mdxdocs.json
🔇 Additional comments (11)
baton/_release-notes.mdx (1)
6-7: LGTM!The placeholder comment for the Cortex XDR connector is appropriate for tracking upcoming release notes.
docs.json (1)
373-374: LGTM!The new connector entries are correctly added to the navigation configuration with consistent path formatting.
baton/xsoar.mdx (2)
2-6: LGTM!The branding update to include "Palo Alto Networks Cortex XSOAR" is consistent across title, og:title, and sidebarTitle.
49-59: LGTM!The new "Find your API URL" section provides clear instructions for users to locate their API URL using the View Examples feature.
baton/palo-alto-cortex.mdx (2)
1-19: LGTM!The frontmatter and capabilities section are well-structured. The info note about the Account Admin role limitation is helpful for users to understand connector constraints upfront.
161-223: LGTM!The Kubernetes deployment configuration is well-documented with clear separation between secrets and deployment manifests. The step-by-step instructions provide a good guide for self-hosted deployment.
baton/intro.mdx (2)
274-274: Cortex XDR correctly added to "New this month" section.The new connector is appropriately listed here. Note: The same
/docs/baton/path inconsistency applies here as flagged above.
501-502: LGTM!The entries are correctly placed in alphabetical order within the Security category.
baton/palo-alto-cortex.md (3)
130-149: LGTM!The Kubernetes secrets configuration is well-structured with clear comments distinguishing ConductorOne credentials from Cortex XDR credentials.
155-181: LGTM!The deployment configuration follows standard Kubernetes patterns with appropriate labels for identification.
8-16: LGTM!The capabilities table is clear, and the limitation note about the Account Admin role provides important context for users.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| | [Palo Alto Networks Cortex XDR](/docs/baton/palo-alto-cortex) | <Icon icon="cloud" /> <Icon icon="plug" /> | <Icon icon="key" /> | | | ||
| | [Palo Alto Networks Cortex XSOAR](/docs/baton/xsoar) | <Icon icon="cloud" /> <Icon icon="plug" /> | | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Path prefix inconsistency with other connectors.
These new entries use /docs/baton/... paths while all other connectors in this table use /baton/... paths (e.g., /baton/pagerduty on line 167, /baton/panda-doc on line 170).
Additionally, docs.json registers these connectors as baton/palo-alto-cortex and baton/xsoar without the /docs prefix, which would result in broken links in the capabilities table.
🔧 Suggested fix
-| [Palo Alto Networks Cortex XDR](/docs/baton/palo-alto-cortex) | <Icon icon="cloud" /> <Icon icon="plug" /> | <Icon icon="key" /> | |
-| [Palo Alto Networks Cortex XSOAR](/docs/baton/xsoar) | <Icon icon="cloud" /> <Icon icon="plug" /> | | |
+| [Palo Alto Networks Cortex XDR](/baton/palo-alto-cortex) | <Icon icon="cloud" /> <Icon icon="plug" /> | <Icon icon="key" /> | |
+| [Palo Alto Networks Cortex XSOAR](/baton/xsoar) | <Icon icon="cloud" /> <Icon icon="plug" /> | | |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | [Palo Alto Networks Cortex XDR](/docs/baton/palo-alto-cortex) | <Icon icon="cloud" /> <Icon icon="plug" /> | <Icon icon="key" /> | | | |
| | [Palo Alto Networks Cortex XSOAR](/docs/baton/xsoar) | <Icon icon="cloud" /> <Icon icon="plug" /> | | | | |
| | [Palo Alto Networks Cortex XDR](/baton/palo-alto-cortex) | <Icon icon="cloud" /> <Icon icon="plug" /> | <Icon icon="key" /> | | | |
| | [Palo Alto Networks Cortex XSOAR](/baton/xsoar) | <Icon icon="cloud" /> <Icon icon="plug" /> | | | |
🤖 Prompt for AI Agents
In `@baton/capabilities.mdx` around lines 168 - 169, The two table rows use
incorrect path prefixes; replace the link targets "[Palo Alto Networks Cortex
XDR](/docs/baton/palo-alto-cortex)" and "[Palo Alto Networks Cortex
XSOAR](/docs/baton/xsoar)" in baton/capabilities.mdx with the consistent paths
"/baton/palo-alto-cortex" and "/baton/xsoar" respectively so they match the
docs.json registrations (e.g., change to "[Palo Alto Networks Cortex
XDR](/baton/palo-alto-cortex)" and "[Palo Alto Networks Cortex
XSOAR](/baton/xsoar)").
| - [Palo Alto Networks Cortex XDR](/docs/baton/palo-alto-cortex) | ||
| - [Palo Alto Networks Cortex XSOAR](/docs/baton/xsoar) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# First, view the file to see the actual path patterns around the flagged lines
echo "=== Viewing lines 195-210 (around line 202-203) ==="
sed -n '195,210p' baton/intro.mdx
echo -e "\n=== Viewing lines 270-280 (around line 274) ==="
sed -n '270,280p' baton/intro.mdx
echo -e "\n=== Viewing lines 495-510 (around line 501-502) ==="
sed -n '495,510p' baton/intro.mdx
echo -e "\n=== Counting /baton/ vs /docs/baton/ patterns in file ==="
echo "Total /baton/ paths:"
grep -o '/baton/[a-z-]*' baton/intro.mdx | sort | uniq -c | head -20
echo -e "\nTotal /docs/baton/ paths:"
grep -o '/docs/baton/[a-z-]*' baton/intro.mdx | sort | uniq -cRepository: ConductorOne/docs
Length of output: 2482
🏁 Script executed:
#!/bin/bash
# Check if /docs/baton/ paths are actual documentation routes
echo "=== Searching for references to /docs/baton paths ==="
rg '/docs/baton' . --type mdx --type md
echo -e "\n=== Checking if docs directory has palo-alto-cortex ==="
find . -name "*palo-alto-cortex*" -o -name "*xsoar*" 2>/dev/null | head -20
echo -e "\n=== Checking for baton directory structure ==="
ls -la baton/ | head -30
echo -e "\n=== Checking if palo-alto-cortex.mdx exists in baton dir ==="
ls -la baton/ | grep -i "palo\|cortex\|xsoar"Repository: ConductorOne/docs
Length of output: 2482
Fix incorrect path prefixes for Palo Alto connectors.
Lines 202-203 (and also 274, 501-502) use /docs/baton/palo-alto-cortex and /docs/baton/xsoar, but the actual files exist at /baton/palo-alto-cortex and /baton/xsoar (like all other connectors). Remove the /docs prefix from these 5 instances to match the standard path format and fix the broken links.
🤖 Prompt for AI Agents
In `@baton/intro.mdx` around lines 202 - 203, Update the incorrect link prefixes:
replace occurrences of "/docs/baton/palo-alto-cortex" and "/docs/baton/xsoar" in
this file with "/baton/palo-alto-cortex" and "/baton/xsoar" respectively (there
are multiple instances including the shown diff and two other occurrences
elsewhere in the file); ensure all five instances use the standard "/baton/..."
connector path so the links resolve correctly.
baton/palo-alto-cortex.md
Outdated
| {{% hint style="warning" %}} | ||
| A an **Instance Administrator** in Cortex XDR must perform this task. | ||
| {{% /hint %}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammatical error: "A an" → "An".
There's a typo in the hint text.
📝 Proposed fix
{{% hint style="warning" %}}
-A an **Instance Administrator** in Cortex XDR must perform this task.
+An **Instance Administrator** in Cortex XDR must perform this task.
{{% /hint %}}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {{% hint style="warning" %}} | |
| A an **Instance Administrator** in Cortex XDR must perform this task. | |
| {{% /hint %}} | |
| {{% hint style="warning" %}} | |
| An **Instance Administrator** in Cortex XDR must perform this task. | |
| {{% /hint %}} |
🤖 Prompt for AI Agents
In `@baton/palo-alto-cortex.md` around lines 22 - 24, Fix the grammatical typo
inside the hint block: change the text "A an **Instance Administrator** in
Cortex XDR must perform this task." to "An **Instance Administrator** in Cortex
XDR must perform this task." by editing the string within the {{% hint
style="warning" %}} ... {{% /hint %}} block so the leading article is corrected.
baton/palo-alto-cortex.md
Outdated
|
|
||
| {{< tab label="Self-hosted" >}} | ||
| {{< markdown >}} | ||
| **Follow these instructions to use the [Cortex XDR](https://github.com/ConductorOne/baton-pandadoc) connector, hosted and run in your own environment.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
# First, locate the file
find . -name "palo-alto-cortex.md" -type fRepository: ConductorOne/docs
Length of output: 88
🏁 Script executed:
# Check if the file exists and read the content around line 94
if [ -f "baton/palo-alto-cortex.md" ]; then
sed -n '90,98p' "baton/palo-alto-cortex.md"
else
echo "File not found in expected location"
# Search more broadly
find . -name "*palo*cortex*" -type f
fiRepository: ConductorOne/docs
Length of output: 605
🏁 Script executed:
# Verify the correct repository exists by checking the GitHub API
curl -s -I https://api.github.com/repos/ConductorOne/baton-palo-alto-cortex | head -5Repository: ConductorOne/docs
Length of output: 244
🏁 Script executed:
# Search for other references to Cortex XDR or palo alto in the repository
rg -i "cortex|palo" --type md | head -20Repository: ConductorOne/docs
Length of output: 2322
🏁 Script executed:
# Look for the pattern of connector repository names
rg "github.com/ConductorOne/baton-" --type md | grep -o "baton-[a-z0-9-]*" | sort -uRepository: ConductorOne/docs
Length of output: 75
🏁 Script executed:
# Check if there are any variations of the palo alto cortex repository name
rg -i "palo.*alto.*cortex|cortex.*xdr" --type md -C 2Repository: ConductorOne/docs
Length of output: 8243
Incorrect GitHub repository URL in self-hosted section link.
The link points to baton-pandadoc but should reference baton-palo-alto-cortex. This is a copy-paste error; the correct repository name is used consistently throughout the Kubernetes configuration examples in the same file.
🔗 Proposed fix
-**Follow these instructions to use the [Cortex XDR](https://github.com/ConductorOne/baton-pandadoc) connector, hosted and run in your own environment.**
+**Follow these instructions to use the [Cortex XDR](https://github.com/ConductorOne/baton-palo-alto-cortex) connector, hosted and run in your own environment.**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Follow these instructions to use the [Cortex XDR](https://github.com/ConductorOne/baton-pandadoc) connector, hosted and run in your own environment.** | |
| **Follow these instructions to use the [Cortex XDR](https://github.com/ConductorOne/baton-palo-alto-cortex) connector, hosted and run in your own environment.** |
🤖 Prompt for AI Agents
In `@baton/palo-alto-cortex.md` at line 94, The self-hosted connector link text
for "Cortex XDR" is pointing to the wrong GitHub repo (baton-pandadoc); update
the markdown link so its URL references the correct repository name
baton-palo-alto-cortex (the same repo used in the Kubernetes examples), e.g.,
change the href in the sentence starting "**Follow these instructions to use the
[Cortex XDR]...**" to point to
https://github.com/ConductorOne/baton-palo-alto-cortex.
| <Warning> | ||
| A an **Instance Administrator** in Cortex XDR must perform this task. | ||
| </Warning> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammatical error.
There's a typo in the warning text: "A an" should be "An".
📝 Suggested fix
<Warning>
-A an **Instance Administrator** in Cortex XDR must perform this task.
+An **Instance Administrator** in Cortex XDR must perform this task.
</Warning>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Warning> | |
| A an **Instance Administrator** in Cortex XDR must perform this task. | |
| </Warning> | |
| <Warning> | |
| An **Instance Administrator** in Cortex XDR must perform this task. | |
| </Warning> |
🤖 Prompt for AI Agents
In `@baton/palo-alto-cortex.mdx` around lines 25 - 27, Fix the grammatical typo
inside the Warning block: replace the string "A an **Instance Administrator** in
Cortex XDR must perform this task." with the correct article "An **Instance
Administrator** in Cortex XDR must perform this task." so the Warning text reads
correctly; update the Warning element content in baton/palo-alto-cortex.mdx
accordingly.
Do not merge until connector is out of validation status.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.