Skip to content

Commit b807b9b

Browse files
committed
fix: disable strict markdown linting rules for documentation
1 parent 222a5ce commit b807b9b

File tree

12 files changed

+1027
-75
lines changed

12 files changed

+1027
-75
lines changed

.kiro/specs/puppetdb-integration/design.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

33
## Overview
44

5-
This design document outlines the architecture for version 0.2.0 of Padawi, transforming it from a Bolt-specific web interface into a general-purpose remote execution platform. The core architectural shift introduces a plugin-based integration system where PuppetDB serves as the first additional integration beyond Puppet Bolt. This establishes patterns and abstractions that will support future integrations with Ansible, Terraform, AWS CLI, Azure CLI, Kubernetes, and other infrastructure management tools.
5+
This design document outlines the architecture for version 0.2.0 of Pabawi, transforming it from a
6+
Bolt-specific web interface into a general-purpose remote execution platform. The core architectural
7+
shift introduces a plugin-based integration system where PuppetDB serves as the first additional
8+
integration beyond Puppet Bolt. This establishes patterns and abstractions that will support future
9+
integrations with Ansible, Terraform, AWS CLI, Azure CLI, Kubernetes, and other infrastructure
10+
management tools.
611

712
The design introduces two key concepts:
813

@@ -19,13 +24,17 @@ PuppetDB integration provides:
1924

2025
Additionally, this version introduces action re-execution capabilities, allowing users to quickly repeat operations with preserved parameters, and comprehensive UI enhancements to support the multi-tool architecture.
2126

22-
**Expert Mode Enhancement**: A critical priority for this version is enhancing the expert mode experience to provide complete transparency into command execution. When expert mode is enabled, users will see the full command line being executed and complete, untruncated output (stdout/stderr). This visibility is essential for debugging, auditing, and understanding exactly what operations are being performed on managed infrastructure.
27+
**Expert Mode Enhancement**: A critical priority for this version is enhancing the expert mode
28+
experience to provide complete transparency into command execution. When expert mode is enabled,
29+
users will see the full command line being executed and complete, untruncated output (stdout/stderr).
30+
This visibility is essential for debugging, auditing, and understanding exactly what operations are
31+
being performed on managed infrastructure.
2332

2433
## Architecture
2534

2635
### High-Level Architecture
2736

28-
```
37+
```text
2938
┌─────────────────────────────────────────────────────────────┐
3039
│ Frontend (Svelte) │
3140
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
@@ -501,7 +510,7 @@ interface AggregatedNodeData {
501510

502511
### Prework Analysis
503512

504-
1.1 WHEN the system is configured with PuppetDB connection details THEN Padawi SHALL retrieve the list of active nodes from PuppetDB
513+
1.1 WHEN the system is configured with PuppetDB connection details THEN Pabawi SHALL retrieve the list of active nodes from PuppetDB
505514
Thoughts: This is about the system's ability to connect to PuppetDB and retrieve data. We can test this by generating random PuppetDB configurations (valid and invalid), attempting connections, and verifying that valid configs return node lists while invalid ones fail appropriately.
506515
Testable: yes - property
507516

@@ -601,7 +610,7 @@ Testable: yes - property
601610
Thoughts: This is about filter functionality. We can verify all filter types work correctly.
602611
Testable: yes - property
603612

604-
6.1 WHEN the system starts THEN Padawi SHALL read PuppetDB connection configuration from environment variables or configuration files
613+
6.1 WHEN the system starts THEN Pabawi SHALL read PuppetDB connection configuration from environment variables or configuration files
605614
Thoughts: This is about configuration loading. We can verify the system reads config from expected sources.
606615
Testable: yes - example
607616

@@ -1218,7 +1227,7 @@ UI tests will verify:
12181227

12191228
### New PuppetDB Endpoints
12201229

1221-
```
1230+
```http
12221231
GET /api/integrations/status
12231232
GET /api/integrations/puppetdb/nodes
12241233
GET /api/integrations/puppetdb/nodes/:certname
@@ -1232,7 +1241,7 @@ POST /api/integrations/puppetdb/query
12321241

12331242
### Enhanced Execution Endpoints
12341243

1235-
```
1244+
```http
12361245
GET /api/executions/:id/original # Get original execution for re-execution
12371246
GET /api/executions/:id/re-executions # Get all re-executions of an execution
12381247
POST /api/executions/:id/re-execute # Trigger re-execution
@@ -1244,7 +1253,7 @@ GET /api/executions/:id/command # Get full command line for executi
12441253

12451254
### Enhanced Inventory Endpoints
12461255

1247-
```
1256+
```http
12481257
GET /api/inventory?sources=bolt,puppetdb # Get inventory from specific sources
12491258
GET /api/inventory/sources # Get available inventory sources and status
12501259
```

.kiro/specs/puppetdb-integration/requirements.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Introduction
44

5-
This document specifies the requirements for version 0.2.0 of Padawi, a general-purpose remote execution interface that integrates multiple infrastructure management tools. This version adds PuppetDB as the first additional integration beyond Puppet Bolt, establishing patterns for future integrations with tools like Ansible, Terraform, AWS CLI, Azure CLI, and Kubernetes. PuppetDB will serve as both a dynamic inventory source for discovering nodes and as a rich data source for displaying node facts, Puppet run reports, catalogs, and events. This version also introduces task re-execution capabilities and UI enhancements to support the multi-tool architecture.
5+
This document specifies the requirements for version 0.2.0 of Pabawi, a general-purpose remote execution interface that integrates multiple infrastructure management tools. This version adds PuppetDB as the first additional integration beyond Puppet Bolt, establishing patterns for future integrations with tools like Ansible, Terraform, AWS CLI, Azure CLI, and Kubernetes. PuppetDB will serve as both a dynamic inventory source for discovering nodes and as a rich data source for displaying node facts, Puppet run reports, catalogs, and events. This version also introduces task re-execution capabilities and UI enhancements to support the multi-tool architecture.
66

77
**Priority Focus:** A key priority for this version is enhancing the expert mode experience by ensuring full visibility of command execution details. When expert mode is enabled, users must be able to see the complete command line that was executed and the full, untruncated output (stdout/stderr). This transparency is critical for debugging, auditing, and understanding exactly what operations are being performed on managed infrastructure.
88

99
## Glossary
1010

11-
- **Padawi**: A general-purpose remote execution interface that integrates multiple infrastructure management tools (Bolt, PuppetDB, Ansible, Terraform, etc.)
11+
- **Pabawi**: A general-purpose remote execution interface that integrates multiple infrastructure management tools (Bolt, PuppetDB, Ansible, Terraform, etc.)
1212
- **PuppetDB**: A centralized storage service that collects and serves data generated by Puppet, including node facts, catalogs, reports, and events
1313
- **Inventory Source**: A system or service that provides a list of nodes available for remote execution operations
1414
- **Node Facts**: System information collected about managed nodes (OS, hardware, network configuration, etc.)
@@ -28,7 +28,7 @@ This document specifies the requirements for version 0.2.0 of Padawi, a general-
2828

2929
#### Acceptance Criteria
3030

31-
1. WHEN the system is configured with PuppetDB connection details THEN Padawi SHALL retrieve the list of active nodes from PuppetDB
31+
1. WHEN the system is configured with PuppetDB connection details THEN Pabawi SHALL retrieve the list of active nodes from PuppetDB
3232
2. WHEN PuppetDB returns node data THEN the system SHALL transform it into a normalized inventory format compatible with multiple execution tools
3333
3. WHEN the inventory page loads THEN the system SHALL display nodes from PuppetDB alongside nodes from other inventory sources with clear source attribution
3434
4. WHERE PuppetDB is configured as an inventory source THEN the system SHALL support filtering nodes by PuppetDB query language (PQL)
@@ -84,11 +84,11 @@ This document specifies the requirements for version 0.2.0 of Padawi, a general-
8484

8585
### Requirement 6
8686

87-
**User Story:** As an infrastructure administrator, I want to configure PuppetDB connection settings, so that I can connect Padawi to my PuppetDB instance securely.
87+
**User Story:** As an infrastructure administrator, I want to configure PuppetDB connection settings, so that I can connect Pabawi to my PuppetDB instance securely.
8888

8989
#### Acceptance Criteria
9090

91-
1. WHEN the system starts THEN Padawi SHALL read PuppetDB connection configuration from environment variables or configuration files
91+
1. WHEN the system starts THEN Pabawi SHALL read PuppetDB connection configuration from environment variables or configuration files
9292
2. WHERE PuppetDB uses HTTPS THEN the system SHALL support SSL certificate validation with options for custom CA certificates
9393
3. WHERE PuppetDB requires authentication THEN the system SHALL support token-based authentication
9494
4. WHEN PuppetDB configuration is invalid THEN the system SHALL log detailed error messages for troubleshooting

.markdownlint.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
{
22
"default": true,
3-
"MD013": {
4-
"line_length": 120,
5-
"code_blocks": false,
6-
"tables": false
3+
"MD013": false,
4+
"MD024": {
5+
"siblings_only": true
76
},
87
"MD033": false,
9-
"MD041": false
8+
"MD036": false,
9+
"MD040": false,
10+
"MD041": false,
11+
"MD060": false
1012
}

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Padawi
1+
# Pabawi
22

33
Version 0.2.0 - Unified Remote Execution Interface
44

5-
Padawi is a general-purpose remote execution platform that integrates multiple infrastructure management tools including Puppet Bolt and PuppetDB. It provides a unified web interface for managing infrastructure, executing commands, viewing system information, and tracking operations across your entire environment.
5+
Pabawi is a general-purpose remote execution platform that integrates multiple infrastructure management tools including Puppet Bolt and PuppetDB. It provides a unified web interface for managing infrastructure, executing commands, viewing system information, and tracking operations across your entire environment.
66

77
## Features
88

@@ -543,7 +543,7 @@ npm test --workspace=backend
543543

544544
## Acknowledgments
545545

546-
Padawi builds on excellent open-source projects:
546+
Pabawi builds on excellent open-source projects:
547547

548548
- **Puppet Bolt**: Remote task execution engine
549549
- **PuppetDB**: Centralized Puppet data storage

backend/src/integrations/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Integration Plugin System
33
*
44
* This module provides the plugin architecture for integrating multiple
5-
* backend systems into Padawi. It exports the core interfaces, base classes,
5+
* backend systems into Pabawi. It exports the core interfaces, base classes,
66
* and types needed to create and manage integration plugins.
77
*
88
* @module integrations

backend/src/integrations/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Integration Plugin Types and Interfaces
33
*
44
* This module defines the core plugin architecture for integrating multiple
5-
* backend systems (execution tools and information sources) into Padawi.
5+
* backend systems (execution tools and information sources) into Pabawi.
66
*/
77

88
import type { Node, Facts, ExecutionResult } from "../bolt/types";

docs/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,19 +1048,19 @@ curl http://localhost:3000/api/executions/jkl012
10481048
curl "http://localhost:3000/api/executions?page=1&pageSize=20"
10491049
```
10501050

1051-
2. **Filter by status:**
1051+
1. **Filter by status:**
10521052

10531053
```bash
10541054
curl "http://localhost:3000/api/executions?status=failed&page=1"
10551055
```
10561056

1057-
3. **Filter by node:**
1057+
1. **Filter by node:**
10581058

10591059
```bash
10601060
curl "http://localhost:3000/api/executions?targetNode=node1"
10611061
```
10621062

1063-
4. **Filter by date range:**
1063+
1. **Filter by date range:**
10641064

10651065
```bash
10661066
curl "http://localhost:3000/api/executions?startDate=2024-01-01T00:00:00Z&endDate=2024-01-31T23:59:59Z"

docs/puppetdb-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Version: 0.2.0
44

55
## Overview
66

7-
This document describes the API endpoints added in version 0.2.0 for PuppetDB integration, re-execution capabilities, and expert mode enhancements. These endpoints extend the base Padawi API to support multi-source infrastructure management.
7+
This document describes the API endpoints added in version 0.2.0 for PuppetDB integration, re-execution capabilities, and expert mode enhancements. These endpoints extend the base Pabawi API to support multi-source infrastructure management.
88

99
## Table of Contents
1010

@@ -1004,7 +1004,7 @@ curl -H "X-Expert-Mode: true" \
10041004

10051005
## Error Handling
10061006

1007-
All endpoints follow the standard Padawi error response format:
1007+
All endpoints follow the standard Pabawi error response format:
10081008

10091009
```json
10101010
{
@@ -1114,6 +1114,6 @@ List endpoints support pagination:
11141114
## Additional Resources
11151115

11161116
- [PuppetDB Integration Setup Guide](./puppetdb-integration-setup.md)
1117-
- [Padawi Configuration Guide](./configuration.md)
1118-
- [Padawi User Guide](./user-guide.md)
1117+
- [Pabawi Configuration Guide](./configuration.md)
1118+
- [Pabawi User Guide](./user-guide.md)
11191119
- [PuppetDB API Documentation](https://puppet.com/docs/puppetdb/latest/api/index.html)

0 commit comments

Comments
 (0)