Skip to content

Commit f7abfb4

Browse files
ericcamesericcames
committed
updating the documentation
1 parent 036c037 commit f7abfb4

7 files changed

Lines changed: 118 additions & 0 deletions

doc/AAP_Servicenow.pdf renamed to docs/AAP_Servicenow.pdf

File renamed without changes.

doc/Conscience of an Automator Eric Ames.pdf renamed to docs/Conscience of an Automator Eric Ames.pdf

File renamed without changes.

doc/README.md renamed to docs/README.md

File renamed without changes.

doc/ServiceNow_EventDriven_Ansible_integration.pdf renamed to docs/ServiceNow_EventDriven_Ansible_integration.pdf

File renamed without changes.

‎docs/architecture.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Architecture
2+
3+
## Executive Summary
4+
5+
This project is an Ansible-based "Configuration as Code" (CaC) repository. It is designed to be used with the Ansible Automation Platform to set up and manage demo environments on the Red Hat Demo Platform.
6+
7+
## Technology Stack
8+
9+
| Category | Technology | Version | Justification |
10+
| ------------------------- | ---------- | --------------- | ---------------------------------------------------------------------------- |
11+
| Orchestration/Automation | Ansible | Not specified | ansible.cfg, ansible-navigator.yml, galaxy.yml, playbooks/, collections/ |
12+
13+
## Architecture Pattern
14+
15+
The project follows an **Configuration as Code (CaC)** pattern. All configuration is defined in code and managed through Ansible playbooks.
16+
17+
## Source Tree
18+
19+
The source tree is organized as follows:
20+
21+
```
22+
project-root/
23+
├── playbooks/ # Ansible playbooks
24+
│ ├── main.yml # Main playbook entry point
25+
│ └── files/ # Files used by playbooks
26+
│ └── config_as_code/ # Configuration as code files
27+
│ ├── controller_credentials.yml
28+
│ ├── controller_hosts.yml
29+
│ ├── controller_inventories.yml
30+
│ ├── controller_projects.yml
31+
│ ├── controller_settings.yml
32+
│ ├── controller_templates.yml
33+
│ ├── credential_types.yml
34+
│ ├── eda_credentials.yml
35+
│ ├── eda_decision_environments.yml
36+
│ ├── eda_event_streams.yml
37+
│ ├── eda_projects.yml
38+
│ ├── eda_rulebook_activations.yml
39+
│ ├── execution_environments.yml
40+
│ ├── gateway_organizations.yml
41+
│ ├── gateway_settings.yml
42+
│ ├── gateway_teams.yml
43+
│ └── gateway_users.yml
44+
```
45+
46+
## Development Workflow
47+
48+
See `development-guide.md` for details on the development workflow.
49+
50+
## Deployment Architecture
51+
52+
See `deployment-guide.md` for details on the deployment architecture.

‎docs/index.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Project Documentation Index
2+
3+
## Project Overview
4+
5+
- **Type:** monolith
6+
- **Primary Language:** yaml
7+
- **Architecture:** Configuration as Code (CaC)
8+
9+
### Quick Reference
10+
11+
- **Tech Stack:** Ansible
12+
- **Entry Point:** playbooks/main.yml
13+
- **Architecture Pattern:** Configuration as Code (CaC)
14+
15+
### Generated Documentation
16+
17+
- [Project Overview](./project-overview.md)
18+
- [Architecture](./architecture.md)
19+
- [Source Tree Analysis](./source-tree-analysis.md)
20+
- [Component Inventory](./component-inventory.md) _(To be generated)_
21+
- [Development Guide](./development-guide.md)
22+
- [Deployment Guide](./deployment-guide.md)
23+
- [Contribution Guide](./contribution-guide.md) _(To be generated)_
24+
- [API Contracts](./api-contracts.md) _(To be generated)_
25+
- [Data Models](./data-models.md) _(To be generated)_
26+
27+
### Existing Documentation
28+
29+
- [README.md](README.md)
30+
- [AAP_Servicenow.pdf](AAP_Servicenow.pdf)
31+
- [Conscience of an Automator Eric Ames.pdf](./Conscience%20of%20an%20Automator%20Eric%20Ames.pdf)
32+
- [ServiceNow_EventDriven_Ansible_integration.pdf](./ServiceNow_EventDriven_Ansible_integration.pdf)
33+
34+
### Getting Started
35+
36+
See the [Development Guide](./development-guide.md) for instructions on how to get started with this project.

‎docs/project-overview.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Project Overview
2+
3+
## Project Name
4+
5+
aap.as.code
6+
7+
## Executive Summary
8+
9+
This project is an Ansible-based "Configuration as Code" (CaC) repository. It is designed to be used with the Ansible Automation Platform to set up and manage demo environments on the Red Hat Demo Platform.
10+
11+
## Technology Stack
12+
13+
| Category | Technology | Version |
14+
| ------------------------- | ---------- | --------------- |
15+
| Orchestration/Automation | Ansible | Not specified |
16+
17+
## Architecture
18+
19+
The project follows an **Configuration as Code (CaC)** pattern. All infrastructure and configuration is defined in code and managed through Ansible playbooks.
20+
21+
## Repository Structure
22+
23+
The project is a monolith. See `source-tree-analysis.md` for a detailed breakdown of the directory structure.
24+
25+
## Links to Detailed Documentation
26+
27+
- [Architecture](architecture.md)
28+
- [Source Tree Analysis](source-tree-analysis.md)
29+
- [Development Guide](development-guide.md)
30+
- [Deployment Guide](deployment-guide.md)

0 commit comments

Comments
 (0)