Skip to content

repo: root docs and license #96

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.

Sign up for GitHub

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

Draft
croadfeldt wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

repo: root docs and license #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,28 +174,3 @@
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
157 changes: 117 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,117 @@
# DCM

DCM (Data Center Management) is envisioned as a framework designed to provide a "hyperscaler-like cloud experience" for on-premises infrastructure. It aims to centralize and automate the management, observation, and lifecycle of IT/IS services within an enterprise data center. This is a work in progress with the initial stage of HLD documentation completed. Detailed specifications and discussions are on-going. Expertise and opinions are encouraged and welcome.

## Core Principles & Goals:

* **Centralized Management**: Consolidate disparate automation efforts under a single control plane or "single pane of glass" to manage various data center components.
* **Automation & Self-Service**: Leverage existing automation tools (like Ansible Automation Platform) to offer a self-service model for provisioning, configuration, and day-to-day management. The goal is to enable application teams to define and deploy infrastructure as code.
* **Declarative Infrastructure**: Define the desired state of infrastructure, with the system working to achieve and maintain that state, aiding in reconciliation between discovered and intended inventory.
* **Composability**: Emphasize a composable architecture that allows for reusable services and operational efficiencies.
* **Technology Agnostic Framework**: Designed to be flexible and consume common data formats, translating them to appropriate technologies, though an opinionated model is available.
* **Full Lifecycle Management**: Enable complete lifecycle management of IT/IS services and ephemeral/declarative infrastructure.
* **Mimics Kubernetes Design**: Draws inspiration from Kubernetes' orchestration and declarative control plane.
* **API First**: All integrations are done via a common API framework.
* **AI Ready**: DCM is standalone, but designed with AI in mind as core components and AIOps layered over the top.

## Status of next release (alpha)

- [ ] todo 1 (owned by ....)
- [ ] todo 2 (owned by ....)
- [ ] todo 3 (owned by ....)
- [ ] todo 4 (owned by ....)

## Recommended Reading
- [overview.md](overview.md) - Project overview - will be merged into READMe.
- [taxonomy.md](./taxonomy/) — DCM taxonomy and definitions

## AI Model Knowledge Base

[Infrastructure Knowledge YAML file](architecture/infrastructure_knowledge.yaml) - This file is pre-loaded with information and context on DCM to be used by an AI model. - This is a WIP in progress, best effort to be update with changes.

## MVP
_(No text files listed)_

## Other projects in the same space
There are many other projects in the same space, like:

* [Crossplane](https://crossplane.io)
* [Kessel](https://github.com/project-kessel)
* [KRO](https://kro.run)
# DCM — Data Center Management

DCM is a framework for sovereign private cloud management. It provides a
declarative control plane for managing the lifecycle of arbitrary infrastructure
resources across an enterprise — from bare metal and VMs to containers,
applications, and managed services.

**DCM is one realization of [UDLM](https://github.com/croadfeldt/udlm)**, the
Universal Data Lifecycle Model. UDLM is the wire-compatible substrate
(entity types, four-state lifecycle, contracts, identifiers, events). DCM is
the operational platform built on it — convergence engine, control-plane
components, deployment topology, persistence, runtime features, governance
enforcement, credentials, and integrations.

**Three foundational abstractions:** Data · Provider · Policy
**License:** Apache 2.0

---

## Repository Structure

```
dcm/
├── architecture/
│ ├── overview.md ← Start here — DCM architecture entry point
│ ├── layering.md ← UDLM/DCM boundary and how they relate
│ ├── operator-perspective.md ← Narrative operator/implementer handbook
│ ├── design-principles.md ← DCM-specific implementation choices
│ ├── consistency-review.md
│ ├── 00-split-manifest.md ← Permanent record of the UDLM/DCM split
│ ├── 00-layering-data-model-vs-dcm.md ← Conceptual layering doc
│ ├── control-plane/ ← Components, self-health, internal auth,
│ │ session revocation, API versioning
│ ├── convergence-engine/ ← The intent→realized loop:
│ │ overview, policy evaluation (matrix
│ │ evaluator), scoring, recovery/retry,
│ │ dependency orchestration
│ ├── ingestion/ ← Brownfield ingestion engine + workload analysis
│ ├── credentials-and-auth/ ← Auth implementation, credentials,
│ │ provider callback mechanism (mTLS + cred),
│ │ authority enforcement
│ ├── governance-enforcement/ ← Accreditation monitor, registry
│ │ enforcement, contribution pipeline,
│ │ policy profiles
│ ├── runtime-features/ ← Scheduling, notifications, webhooks/
│ │ messaging, federation runtime,
│ │ deployment redundancy
│ ├── topology/ ← DCM's canonical 9-layer location
│ │ hierarchy + placement/priority bands
│ ├── persistence/ ← PostgreSQL mandate + implementation
│ ├── integrations/ ← ITSM, Kessel evaluation
│ ├── adr/ ← Architectural Decision Records
│ ├── ai/DCM-AI-PROMPT.md ← AI knowledge base
│ ├── DCM-Capabilities-Matrix.md
│ ├── DISCUSSION-TOPICS.md
│ └── deployment/ ← Deployment topology
├── examples/
│ └── orchestration-scenarios.md ← DCM-specific orchestration (builds on
│ UDLM canonical examples)
├── reference/
│ ├── implementation-standards.md ← Specific algorithms, libs, configs DCM uses
│ ├── implementation-specifications.md
│ └── operational-reference.md
├── docs/
│ ├── specifications/ ← Prose specification documents
│ └── engineering/
├── taxonomy/DCM-Taxonomy.md
├── schemas/ ← OpenAPI, JSON Schema, SQL
├── deployment/ ← (existing deployment artifacts)
├── dav/ ← DCM validation framework
├── project-overview.md
├── LICENSE
└── README.md
```

For the substrate (entity types, four states, wire contracts, identifiers,
events, schema sharing, conformance), see
**[github.com/croadfeldt/udlm](https://github.com/croadfeldt/udlm)**.

## Key Facts

| Metric | Value |
|--------|-------|
| Architecture documents | 58 data model + 15 specifications |
| Capabilities | 322 across 39 domains |
| Provider types | 6 (service, information, meta, auth, peer_dcm, process) |
| Policy evaluation modes | 2 (Internal via OPA, External via provider) |
| Control plane services | 9 |
| Required infrastructure | 1 (PostgreSQL-compatible DB) — auth, secrets, events handled internally |
| Consumer API | 74 paths |
| Admin API | 61 paths |
| Event catalog | 101 payloads across 22 domains |

## Getting Started

1. **Understand the substrate first** — read [UDLM's README and CONFORMANCE.md](https://github.com/croadfeldt/udlm). DCM only makes sense if you know what it's a realization of.
2. **Read DCM's architecture overview** — [`architecture/overview.md`](architecture/overview.md), then [`architecture/layering.md`](architecture/layering.md) for the UDLM/DCM boundary.
3. **Read the operator perspective** — [`architecture/operator-perspective.md`](architecture/operator-perspective.md) — narrative handbook for running DCM.
4. **Dive into the convergence engine** — [`architecture/convergence-engine/overview.md`](architecture/convergence-engine/overview.md) — the heart of DCM.
5. **Learn the vocabulary** — read [`taxonomy/DCM-Taxonomy.md`](taxonomy/DCM-Taxonomy.md).
6. **See what DCM can do** — browse [`architecture/DCM-Capabilities-Matrix.md`](architecture/DCM-Capabilities-Matrix.md).
7. **Build a service** — start with the OpenAPI specs in [`schemas/openapi/`](schemas/openapi/) and the engineering guide in [`docs/engineering/ENGINEERING-ALIGNMENT.md`](docs/engineering/ENGINEERING-ALIGNMENT.md).
8. **Deploy an example** — see [dcm-examples](https://github.com/dcm-project/dcm-examples).

## Related Repositories

| Repository | Purpose |
|-----------|---------|
| [dcm-examples](https://github.com/dcm-project/dcm-examples) | Reference implementations — Summit demo with Go services, Ansible, OpenShift manifests |
| [dcm-project.github.io](https://github.com/dcm-project/dcm-project.github.io) | Project website — documentation segmented by domain |
| [catalog-manager](https://github.com/dcm-project/catalog-manager) | Service catalog implementation |
| [service-provider-manager](https://github.com/dcm-project/service-provider-manager) | Provider registration |
| [policy-manager](https://github.com/dcm-project/policy-manager) | Policy CRUD and evaluation |
| [placement-manager](https://github.com/dcm-project/placement-manager) | Provider selection |
| [api-gateway](https://github.com/dcm-project/api-gateway) | API ingress (Traefik) |
| [enhancements](https://github.com/dcm-project/enhancements) | Design proposals |
| [shared-workflows](https://github.com/dcm-project/shared-workflows) | CI/CD workflows |
Loading