Skip to content

feat: Add webhook integration guide (Phase 3)#381

Draft
Alan-Cha wants to merge 2 commits into
feat/vault-fetcher-clifrom
feat/vault-docs-polish
Draft

feat: Add webhook integration guide (Phase 3)#381
Alan-Cha wants to merge 2 commits into
feat/vault-fetcher-clifrom
feat/vault-docs-polish

Conversation

@Alan-Cha

@Alan-Cha Alan-Cha commented May 7, 2026

Copy link
Copy Markdown
Member

Summary

Phase 3 of the Vault pattern: Webhook integration documentation and Kubernetes manifests.

Stacked on: #380 (Phase 2 - vault-fetcher CLI)

This PR provides complete documentation for integrating vault-fetcher with the kagenti-operator webhook.

What This Adds

Documentation

  • WEBHOOK_INTEGRATION.md (450+ lines) — Complete integration guide
    • Webhook architecture and injection flow
    • Implementation guidance for kagenti-operator
    • Configuration examples
    • Testing and troubleshooting guides
    • Migration guide from manual to webhook injection

Kubernetes Manifests

  • configmap-vault-fetcher.yaml — Example ConfigMap for vault-fetcher configuration
  • example-deployment.yaml — Manual injection example (before webhook)

Key Content

Webhook Injection Logic

Shows how kagenti-operator should inject vault-fetcher:

  • Label-based injection (kagenti.io/vault-fetcher-inject: "true")
  • Init container specification
  • Volume mounts and ConfigMap mounting
  • Security context (non-root, read-only, seccomp)

Configuration Examples

  • Minimal (single secret)
  • Multiple secrets
  • With env file output
  • Kubernetes SA auth (without SPIFFE)

Vault Setup

Complete Vault JWT auth configuration:

  • Enable JWT auth method
  • Configure OIDC discovery (SPIRE)
  • Create roles with SPIFFE ID patterns
  • Create policies
  • Store secrets

Files Added

  • vault-fetcher/WEBHOOK_INTEGRATION.md (450+ lines)
  • vault-fetcher/k8s/configmap-vault-fetcher.yaml
  • vault-fetcher/k8s/example-deployment.yaml

Total: ~577 lines added

Stacked PR Structure

```
main
└─> #379 (Phase 1: authlib/vault)
└─> #380 (Phase 2: vault-fetcher CLI)
└─> THIS PR (Phase 3: Webhook integration)
```

Next Steps (Phase 4)

  • CI/CD pipeline for vault-fetcher image
  • Root-level documentation updates
  • Integration testing

Review Notes

This PR is documentation-only, no code changes. Focus review on:

  1. Completeness: Does the guide cover all integration scenarios?
  2. Clarity: Is the webhook implementation guidance clear?
  3. Examples: Are the Kubernetes manifests realistic and usable?
  4. Troubleshooting: Does it cover common issues?

Assisted-By: Claude (Anthropic AI) noreply@anthropic.com

Alan-Cha added 2 commits May 7, 2026 11:20
Add documentation and Kubernetes manifests for webhook integration.

This completes Phase 3 of the Vault pattern implementation. Provides:
- Webhook integration architecture and design
- Example Kubernetes manifests (ConfigMap, Deployment)
- Webhook implementation guidance for kagenti-operator
- Testing and troubleshooting guides
- Migration guide from manual to webhook injection

Files added:
- vault-fetcher/WEBHOOK_INTEGRATION.md (450+ lines) — Integration guide
- vault-fetcher/k8s/configmap-vault-fetcher.yaml — Example ConfigMap
- vault-fetcher/k8s/example-deployment.yaml — Manual injection example

Next steps (Phase 4):
- Add CI/CD pipeline for vault-fetcher image
- Create demo scenario
- Update root CLAUDE.md files
- Integration testing

Ref: #vault-pattern
Stacked on: #380

Signed-off-by: Alan Cha <Alan.cha1@ibm.com>
Complete documentation and CI/CD integration for Vault pattern.

This completes Phase 4 (final phase) of the Vault pattern implementation:
- Add vault-fetcher to CI/CD build matrix
- Update root CLAUDE.md with vault-fetcher documentation
- Create comprehensive stacked PR workflow guide

Files modified:
- .github/workflows/build.yaml — Add vault-fetcher to build matrix
- CLAUDE.md — Document vault-fetcher in container images table

Files added:
- STACKED_PR_WORKFLOW.md (300+ lines) — Complete guide for stacked PR workflow and cascade rebase process

Documentation includes:
- Current stack structure
- Creating stacked PRs (manual and gh-stack)
- Critical rebase process when earlier branches change
- Handling conflicts
- Merging strategy
- Common scenarios and troubleshooting
- Best practices

This document is essential for maintaining the stacked PR workflow,
especially when review feedback requires changes to earlier branches.

Ref: #vault-pattern
Stacked on: PR #TBD (Phase 3)

Signed-off-by: Alan Cha <Alan.cha1@ibm.com>
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. If this PR is still relevant, please comment or remove the stale label.

@github-actions github-actions Bot added the stale label Jul 7, 2026
@mrsabath mrsabath moved this from New/ToDo to Backlog in Kagenti Issue Prioritization Jul 16, 2026
@mrsabath

Copy link
Copy Markdown
Contributor

We are putting Vault activity on hold until we figure out whether this work should be done by CPEX or directly in Cortex.

@github-actions github-actions Bot removed the stale label Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

3 participants