Skip to content

Commit 5344f09

Browse files
mgonzalezomgonzalezo
committed
feature update: add telcoeng-blueprint-workflow plugin for blueprint lifecycle automation
1 parent d2de5a1 commit 5344f09

18 files changed

Lines changed: 2055 additions & 0 deletions

File tree

‎.claude-plugin/marketplace.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@
238238
"source": "./plugins/marketplace-ops",
239239
"description": "Maintenance commands for Claude Code plugin marketplaces",
240240
"version": "0.1.2"
241+
},
242+
{
243+
"name": "telcoeng-blueprint-workflow",
244+
"source": "./plugins/telcoeng-blueprint-workflow",
245+
"description": "Create, validate, and manage Telco Engineering partner blueprints against telcoeng-blueprint-standards with JIRA integration and kube-compare-mcp connectivity",
246+
"version": "0.1.0"
241247
}
242248
]
243249
}

‎PLUGINS.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ This document lists all available Claude Code plugins and their commands in the
3131
- [Snowflake](#snowflake-plugin)
3232
- [Sosreport](#sosreport-plugin)
3333
- [Teams](#teams-plugin)
34+
- [Telcoeng Blueprint Workflow](#telcoeng-blueprint-workflow-plugin)
3435
- [Test Coverage](#test-coverage-plugin)
3536
- [Testing](#testing-plugin)
3637
- [Utils](#utils-plugin)
@@ -395,6 +396,19 @@ Team structure knowledge and health analysis commands for OpenShift teams
395396

396397
See [plugins/teams/README.md](plugins/teams/README.md) for detailed documentation.
397398

399+
### Telcoeng Blueprint Workflow Plugin
400+
401+
Create, validate, and manage Telco Engineering partner blueprints against telcoeng-blueprint-standards with JIRA integration and kube-compare-mcp connectivity
402+
403+
**Commands:**
404+
- **`/telcoeng-blueprint-workflow:fix` `<blueprint-path> [--partner <name>] [--auto] [--jira]`** - Generate fix proposals and diffs for non-compliant blueprint sections, with optional auto-apply and JIRA integration
405+
- **`/telcoeng-blueprint-workflow:generate` `<section-type> [--partner <name>] [--blueprint <path>] [--ocp-version <version>]`** - Generate standards-compliant paragraphs, tables, and sections for Telco Partner Blueprints
406+
- **`/telcoeng-blueprint-workflow:ingest` `<file-path> [--partner <name>] [--format word|pdf|markdown|gdocs]`** - Convert partner blueprints from Word/PDF/Google Docs into normalized Markdown aligned with telcoeng-blueprint-standards
407+
- **`/telcoeng-blueprint-workflow:search` `<query> [--dir <blueprints-directory>]`** - Search across normalized blueprints for patterns, configurations, and cross-references
408+
- **`/telcoeng-blueprint-workflow:validate` `<blueprint-path> [--partner <name>] [--cluster <kubeconfig>] [--jira]`** - Score a blueprint against telcoeng-blueprint-standards (0-100) with section-by-section compliance report
409+
410+
See [plugins/telcoeng-blueprint-workflow/README.md](plugins/telcoeng-blueprint-workflow/README.md) for detailed documentation.
411+
398412
### Test Coverage Plugin
399413

400414
Analyze code coverage and identify untested paths

‎docs/data.json‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1790,6 +1790,72 @@
17901790
"name": "marketplace-ops",
17911791
"skills": [],
17921792
"version": "0.1.2"
1793+
},
1794+
{
1795+
"commands": [
1796+
{
1797+
"argument_hint": "<blueprint-path> [--partner <name>] [--auto] [--jira]",
1798+
"description": "Generate fix proposals and diffs for non-compliant blueprint sections, with optional auto-apply and JIRA integration",
1799+
"name": "fix",
1800+
"synopsis": "/telcoeng-blueprint-workflow:fix <blueprint-path> [--partner <name>] [--auto] [--jira]"
1801+
},
1802+
{
1803+
"argument_hint": "<section-type> [--partner <name>] [--blueprint <path>] [--ocp-version <version>]",
1804+
"description": "Generate standards-compliant paragraphs, tables, and sections for Telco Partner Blueprints",
1805+
"name": "generate",
1806+
"synopsis": "/telcoeng-blueprint-workflow:generate <section-type> [--partner <name>] [--blueprint <path>] [--ocp-version <version>]"
1807+
},
1808+
{
1809+
"argument_hint": "<file-path> [--partner <name>] [--format word|pdf|markdown|gdocs]",
1810+
"description": "Convert partner blueprints from Word/PDF/Google Docs into normalized Markdown aligned with telcoeng-blueprint-standards",
1811+
"name": "ingest",
1812+
"synopsis": "/telcoeng-blueprint-workflow:ingest <file-path> [--partner <name>] [--format word|pdf|markdown|gdocs]"
1813+
},
1814+
{
1815+
"argument_hint": "<query> [--dir <blueprints-directory>]",
1816+
"description": "Search across normalized blueprints for patterns, configurations, and cross-references",
1817+
"name": "search",
1818+
"synopsis": "/telcoeng-blueprint-workflow:search <query> [--dir <blueprints-directory>]"
1819+
},
1820+
{
1821+
"argument_hint": "<blueprint-path> [--partner <name>] [--cluster <kubeconfig>] [--jira]",
1822+
"description": "Score a blueprint against telcoeng-blueprint-standards (0-100) with section-by-section compliance report",
1823+
"name": "validate",
1824+
"synopsis": "/telcoeng-blueprint-workflow:validate <blueprint-path> [--partner <name>] [--cluster <kubeconfig>] [--jira]"
1825+
}
1826+
],
1827+
"description": "Create, validate, and manage Telco Engineering partner blueprints against telcoeng-blueprint-standards with JIRA integration and kube-compare-mcp connectivity",
1828+
"has_readme": true,
1829+
"hooks": [],
1830+
"name": "telcoeng-blueprint-workflow",
1831+
"skills": [
1832+
{
1833+
"description": "Dynamically reads telcoeng-blueprint-standards to extract the required section hierarchy for partner blueprints",
1834+
"id": "blueprint-structure",
1835+
"name": "Blueprint Structure"
1836+
},
1837+
{
1838+
"description": "Scores a blueprint against telcoeng-blueprint-standards using a weighted rubric (0-100)",
1839+
"id": "compliance-scoring",
1840+
"name": "Compliance Scoring"
1841+
},
1842+
{
1843+
"description": "Generates standards-compliant text snippets, tables, and sections for Telco Partner Blueprints",
1844+
"id": "content-generation",
1845+
"name": "Content Generation"
1846+
},
1847+
{
1848+
"description": "Documents RDS deviations, manages SUPPORTEX ticket references, and creates ECOPS JIRA tickets for blueprint compliance issues",
1849+
"id": "deviation-tracking",
1850+
"name": "Deviation Tracking"
1851+
},
1852+
{
1853+
"description": "Integrates with kube-compare-mcp for cluster-level validation against Telco RDS profiles",
1854+
"id": "kube-compare-integration",
1855+
"name": "Kube Compare Integration"
1856+
}
1857+
],
1858+
"version": "0.1.0"
17931859
}
17941860
]
17951861
}

‎plugins/telcoeng-blueprint-workflow/.claude-plugin/plugin.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "telcoeng-blueprint-workflow",
3+
"description": "Create, validate, and manage Telco Engineering partner blueprints against telcoeng-blueprint-standards with JIRA integration and kube-compare-mcp connectivity",
4+
"version": "0.1.0",
5+
"author": {
6+
"name": "github.com/openshift-eng"
7+
}
8+
}

‎plugins/telcoeng-blueprint-workflow/README.md‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
# Telco Blueprint Workflow Plugin
2+
3+
End-to-end blueprint lifecycle management for Telco Engineering partner blueprints, aligned with `telcoeng-blueprint-standards`.
4+
5+
## Features
6+
7+
- **Document Ingestion** - Convert partner blueprints from Word/PDF/Google Docs into normalized Markdown matching the standards section hierarchy
8+
- **Compliance Validation** - Score blueprints (0-100) against `telcoeng-blueprint-standards` with section-by-section compliance reports
9+
- **Content Generation** - Generate standards-compliant S-BOM tables, networking sections, deviation lists, and full blueprint scaffolds
10+
- **Blueprint Search** - Search across normalized blueprints for patterns, configurations, and cross-references
11+
- **Automated Fix Proposals** - Generate concrete fix proposals as diffs for non-compliant sections, with optional auto-apply
12+
- **JIRA Integration** - Create and update ECOPS tickets for compliance findings and deviations
13+
- **Cluster Validation** - Validate live clusters against Telco RDS profiles via kube-compare-mcp
14+
15+
## Prerequisites
16+
17+
- Claude Code installed
18+
- `telcoeng-blueprint-standards` repository accessible (sibling directory or discoverable path)
19+
- Optional: `pandoc` or `pip install markitdown` for Word/PDF conversion
20+
- Optional: kube-compare-mcp server configured for cluster-level validation
21+
- Optional: Jira MCP server configured for ECOPS ticket integration
22+
23+
## Installation
24+
25+
Ensure you have the ai-helpers marketplace enabled, via [the instructions here](https://github.com/openshift-eng/ai-helpers#readme).
26+
27+
```bash
28+
/plugin install telcoeng-blueprint-workflow@ai-helpers
29+
```
30+
31+
## Available Commands
32+
33+
### `/telcoeng-blueprint-workflow:ingest` - Document Ingestion & Normalization
34+
35+
Convert partner blueprints from Word, PDF, or Google Docs into normalized Markdown aligned with `telcoeng-blueprint-standards`.
36+
37+
```bash
38+
# Convert a Word document
39+
/telcoeng-blueprint-workflow:ingest ~/Documents/partner-blueprint.docx --partner acme-telecom
40+
41+
# Normalize an existing Markdown file
42+
/telcoeng-blueprint-workflow:ingest ./existing-blueprint.md --partner softbank
43+
```
44+
45+
See [commands/ingest.md](commands/ingest.md) for full documentation.
46+
47+
---
48+
49+
### `/telcoeng-blueprint-workflow:validate` - Compliance Checking & Validation
50+
51+
Score a blueprint against `telcoeng-blueprint-standards` (0-100) with a section-by-section compliance report.
52+
53+
```bash
54+
# Basic validation
55+
/telcoeng-blueprint-workflow:validate .work/blueprints/acme-telecom/blueprint.md
56+
57+
# Validation with cluster check
58+
/telcoeng-blueprint-workflow:validate ./blueprint.md --cluster ~/.kube/config --partner samsung
59+
60+
# Validation with JIRA ticket creation
61+
/telcoeng-blueprint-workflow:validate ./blueprint.md --partner softbank --jira
62+
```
63+
64+
See [commands/validate.md](commands/validate.md) for full documentation.
65+
66+
---
67+
68+
### `/telcoeng-blueprint-workflow:generate` - Content Generation
69+
70+
Generate standards-compliant paragraphs, tables, and sections for Telco Partner Blueprints.
71+
72+
```bash
73+
# Generate S-BOM table
74+
/telcoeng-blueprint-workflow:generate sbom --partner acme-telecom --ocp-version 4.17
75+
76+
# Generate full blueprint scaffold
77+
/telcoeng-blueprint-workflow:generate all --partner samsung --ocp-version 4.16
78+
79+
# Generate and insert into existing blueprint
80+
/telcoeng-blueprint-workflow:generate deviations --blueprint .work/blueprints/softbank/blueprint.md
81+
```
82+
83+
Supported section types: `metadata`, `intro`, `sbom`, `operators`, `support-exceptions`, `deviations`, `hbom`, `node-config`, `networking`, `operations`, `certification`, `all`.
84+
85+
See [commands/generate.md](commands/generate.md) for full documentation.
86+
87+
---
88+
89+
### `/telcoeng-blueprint-workflow:search` - Blueprint Index & Search
90+
91+
Search across normalized blueprints for patterns, configurations, and cross-references.
92+
93+
```bash
94+
# Search for a specific configuration
95+
/telcoeng-blueprint-workflow:search "siteconfigv1"
96+
97+
# Compare S-BOM across blueprints
98+
/telcoeng-blueprint-workflow:search "compare OCP versions across blueprints"
99+
100+
# Search with custom directory
101+
/telcoeng-blueprint-workflow:search "BIOS settings" --dir ./blueprints/
102+
```
103+
104+
See [commands/search.md](commands/search.md) for full documentation.
105+
106+
---
107+
108+
### `/telcoeng-blueprint-workflow:fix` - Automated Fix Proposals
109+
110+
Compare non-compliant blueprints against standards and propose concrete fixes as diffs.
111+
112+
```bash
113+
# Interactive fix session
114+
/telcoeng-blueprint-workflow:fix .work/blueprints/acme-telecom/blueprint.md --partner acme-telecom
115+
116+
# Auto-apply all fixes
117+
/telcoeng-blueprint-workflow:fix ./blueprint.md --partner samsung --auto
118+
119+
# Fix with JIRA tracking
120+
/telcoeng-blueprint-workflow:fix ./blueprint.md --partner softbank --jira
121+
```
122+
123+
See [commands/fix.md](commands/fix.md) for full documentation.
124+
125+
---
126+
127+
## Typical Workflow
128+
129+
```text
130+
1. Ingest Partner sends Word doc --> /telcoeng-blueprint-workflow:ingest
131+
2. Validate Check compliance --> /telcoeng-blueprint-workflow:validate
132+
3. Fix Apply automated fixes --> /telcoeng-blueprint-workflow:fix
133+
4. Generate Fill remaining gaps --> /telcoeng-blueprint-workflow:generate
134+
5. Search Cross-reference others --> /telcoeng-blueprint-workflow:search
135+
6. Validate Final compliance check --> /telcoeng-blueprint-workflow:validate
136+
```
137+
138+
## Standards Resilience
139+
140+
This plugin reads `telcoeng-blueprint-standards` dynamically at runtime. When standards change:
141+
142+
- Section hierarchy updates automatically on next command run
143+
- Compliance rubric weights can be adjusted in `reference/compliance-rubric.md`
144+
- No hardcoded section names or compliance rules in commands or skills
145+
- If standards are unavailable, commands fall back to `reference/blueprint-sections.md` and warn about potentially stale data
146+
147+
## Reference Files
148+
149+
| File | Purpose |
150+
|------|---------|
151+
| [reference/blueprint-sections.md](reference/blueprint-sections.md) | Standards section hierarchy (pointer to canonical source) |
152+
| [reference/mcp-tools.md](reference/mcp-tools.md) | kube-compare-mcp and JIRA MCP tool signatures |
153+
| [reference/compliance-rubric.md](reference/compliance-rubric.md) | Scoring criteria and weights (configurable) |
154+
155+
## Contributing
156+
157+
Contributions welcome! Please submit pull requests to the [ai-helpers repository](https://github.com/openshift-eng/ai-helpers).
158+
159+
## License
160+
161+
Apache-2.0

0 commit comments

Comments
 (0)