Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
98 changes: 84 additions & 14 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,82 @@ function observabilitySidebar() {
};
}

function operationsSidebar() {
const genSection = (scanStartPath: string, resolvePath: string) => generateSidebar([{
documentRootPath: '/docs/',
scanStartPath,
resolvePath,
capitalizeFirst: false,
useTitleFromFrontmatter: true,
useFolderLinkFromIndexFile: true,
useFolderTitleFromIndexFile: true,
sortMenusByFrontmatterOrder: true,
}]);

const platformItems = genSection('operations/platform', '/operations/platform/')['/operations/platform/'].items
.filter((i: any) => i.link !== 'index.md');
const observabilityItems = genSection('observability', '/observability/')['/observability/'].items
.filter((i: any) => i.link !== 'index.md');
const sustainabilityItems = genSection('sustainability', '/sustainability/')['/sustainability/'].items
.filter((i: any) => i.link !== 'index.md');

const sharedItems = [
{
text: 'Operations Manual',
items: [
{ text: 'Overview', link: '/operations/' },
{
text: 'Platform',
collapsed: true,
base: '/operations/platform/',
items: [{ text: 'Overview', link: '/platform/' }, ...platformItems],
},
{
text: 'Observability',
collapsed: true,
base: '/observability/',
items: [{ text: 'Overview', link: 'index.md' }, ...observabilityItems],
},
{
text: 'Sustainability',
collapsed: true,
base: '/sustainability/',
items: [{ text: 'Overview', link: 'index.md' }, ...sustainabilityItems],
},
],
},
];

return {
'/operations/': { items: sharedItems },
'/operations/platform/': { items: sharedItems },
'/observability/': { items: sharedItems },
'/sustainability/': { items: sharedItems },
};
}

function governanceSidebar() {
const generated = generateSidebar([{
documentRootPath: '/docs/',
scanStartPath: 'governance',
resolvePath: '/governance/',
capitalizeFirst: false,
useTitleFromFrontmatter: true,
useFolderLinkFromIndexFile: true,
useFolderTitleFromIndexFile: true,
sortMenusByFrontmatterOrder: true,
}]);
const items = generated['/governance/'].items.filter((i: any) => i.link !== 'index.md');
return {
'/governance/': {
base: '/governance/',
items: [
{ text: 'Governance', items: [{ text: 'Overview', link: 'index.md' }, ...items] },
],
},
};
}

// https://vitepress.dev/reference/site-config
export default withMermaid({
title: "CobaltCore",
Expand Down Expand Up @@ -149,11 +225,11 @@ export default withMermaid({
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'About CobaltCore', link: '/overview/' },
{ text: 'Getting Started', link: '/getting-started/' },
{
text: 'Documentation',
items: [
{ text: 'About CobaltCore', link: '/overview/' },
{ text: 'Getting Started', link: '/getting-started/' },
{ text: 'Bare Metal Management', link: '/bare-metal/' },
{ text: 'Compute', link: '/compute/' },
{ text: 'Storage', link: '/storage/' },
Expand All @@ -164,14 +240,15 @@ export default withMermaid({
{
text: 'Operations Manual',
items: [
{ text: 'Overview', link: '/overview/' },
{ text: 'Overview', link: '/operations/' },
{ text: 'Platform', link: '/platform/' },
{ text: 'Observability', link: '/observability/' },
{ text: 'Sustainability', link: '/sustainability/' },
],
},
{ text: 'Blog', link: '/blog/' },
{ text: 'Community', link: '/community/' },
{ text: 'Governance', link: '/governance/' },
],

editLink: {
Expand Down Expand Up @@ -221,18 +298,10 @@ export default withMermaid({
useFolderTitleFromIndexFile: true,
sortMenusByFrontmatterOrder: true,
},
{
resolvePath: '/community/',
capitalizeFirst: false,
useTitleFromFrontmatter: true,
useFolderLinkFromIndexFile: true,
useFolderTitleFromIndexFile: true,
sortMenusByFrontmatterOrder: true,
},
{
documentRootPath: '/docs/',
scanStartPath: 'sustainability',
resolvePath: '/sustainability/',
scanStartPath: 'community',
resolvePath: '/community/',
capitalizeFirst: false,
useTitleFromFrontmatter: true,
useFolderLinkFromIndexFile: true,
Expand All @@ -241,10 +310,11 @@ export default withMermaid({
},
]),
...storageSidebar(),
...observabilitySidebar(),
...networkSidebar(),
...openstackSidebar(),
...overviewSidebar(),
...operationsSidebar(),
...governanceSidebar(),
},

socialLinks: [
Expand Down
57 changes: 57 additions & 0 deletions docs/governance/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Governance
order: 1
outline: deep
---

# Governance

CobaltCore is governed and operates under the [NeoNephos Foundation](https://neonephos.org/). Project decisions are made transparently through the structures described below.

## Technical Steering Committee

The Technical Steering Committee (TSC) holds all technical oversight for the project. It sets the direction, coordinates across working groups, and maintains the quality and integrity of the codebase and its processes.

The TSC operates under the [NeoNephos project charter](https://github.com/cobaltcore-dev/.github/blob/main/GOVERNANCE.md) and makes decisions by majority vote. Amendments to the charter require a supermajority.

**Current TSC members**

| Name | GitHub |
|---|---|
| Artem Kovalov | [@artemkovalyov](https://github.com/artemkovalyov) |
| Michael Schmidt | [@BugRoger](https://github.com/BugRoger) |

TSC meetings are held regularly. Agendas and notes are published in the [`.github` repository](https://github.com/cobaltcore-dev/.github).

## Special Interest Groups

Special Interest Groups (SIGs) are focused working groups that own specific areas of the CobaltCore stack. Each SIG maintains its own roadmap, reviews contributions in its domain, and reports back to the TSC.

### SIG Platform

Owns the platform bootstrap layer, including Gardener integration, GardenLinux, IronCore, and the Kubernetes control plane lifecycle.

### SIG Compute

Owns the compute layer, including hypervisor lifecycle, KVM node agent, OpenStack Nova integration, and high-availability scheduling.

### SIG Storage

Owns the storage layer, including Ceph, Rook, Liquid Ceph, Chorus, and the Arbiter monitor.

### SIG Networking

Owns the networking layer, including OVN, OVS, and OpenStack Neutron integration.

### SIG Observability

Owns the observability stack, including Prometheus, Perses, Prysm, and alerting rule coverage across the full stack.

## Code of Conduct

All community spaces and contributions are governed by the [NeoNephos Code of Conduct](https://github.com/neonephos/.github/blob/main/CODE_OF_CONDUCT.md). Violations can be reported per the instructions in the Code of Conduct.

## How to get involved

- **Join a SIG:** TBD
- **Propose a new SIG:** TBD
16 changes: 16 additions & 0 deletions docs/operations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Operations Manual
order: 1
---

# Operations Manual

The Operations Manual covers day-two operations of CobaltCore, including lifecycle management, observability, and sustainability.

## Sections

| Section | Description |
|---|---|
| [Platform](/platform/) | Bootstrap, Gardener, GardenLinux, and IronCore lifecycle |
| [Observability](/observability/) | Metrics, dashboards, and alerting across the full stack |
| [Sustainability](/sustainability/) | Energy efficiency and resource optimization |
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ graph LR

IronCore must be configured with access to your BMC (IPMI/Redfish) interfaces. Once connected, it discovers servers, collects hardware capabilities (CPU, memory, NIC topology), and makes them available as Kubernetes resources.

See [Platform - IronCore](/platform/ironcore) for configuration details.
See [Platform - IronCore](/operations/platform/ironcore) for configuration details.

## Phase 2: Cluster provisioning

Gardener creates a Kubernetes cluster using the machines made available by IronCore. You define a `Shoot` resource describing the cluster topology (node count, machine type, Kubernetes version), and Gardener reconciles it.

See [Platform - Gardener](/platform/gardener) for Shoot configuration and common operations.
See [Platform - Gardener](/operations/platform/gardener) for Shoot configuration and common operations.

## Phase 3: Component installation

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs"
"docs:preview": "vitepress preview docs",
"docs:clean": "rm -rf docs/.vitepress/cache docs/.vitepress/dist",
"docs:build:fresh": "npm run docs:clean && npm run docs:build"
}
}
Loading