Configure Renovate

.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+docs/.vitepress/dist
+docs/.vitepress/cache

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = false
+max_line_length = 120
+tab_width = 4
+ij_continuation_indent_size = 8
+ij_formatter_off_tag = @formatter:off
+ij_formatter_on_tag = @formatter:on
+ij_formatter_tags_enabled = true
+ij_smart_tabs = false
+ij_visual_guides = 
+ij_wrap_on_typing = false

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+docs/.vitepress/dist
+docs/.vitepress/cache
+bin

Dockerfile

@@ -0,0 +1,6 @@
+FROM node:24-alpine
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+EXPOSE 5173
+CMD ["npm", "run", "docs:dev", "--", "--host=0.0.0.0"]

docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  vitepress:
+    build: .
+    ports:
+      - "5173:5173" # Map container port 5173 to host port 5173
+    volumes:
+      - ./docs:/app/docs # Mount your local project directory into the container

docs/.vitepress/config.mts

@@ -0,0 +1,46 @@
+import { defineConfig } from 'vitepress'
+import { withMermaid } from "vitepress-plugin-mermaid";
+
+
+// https://vitepress.dev/reference/site-config
+export default withMermaid(defineConfig({
+  title: "CobaltCore",
+  description: "Opinionated OpenStack distribution that builds upon IronCore’s foundation to support non-cloud-native workloads",
+  head: [['link', { rel: 'icon', href: 'https://raw.githubusercontent.com/cobaltcore-dev/.github/refs/heads/main/assets/Logo_Cobalt_Core_background_white.svg' }]],
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Architecture', link: '/architecture' }
+    ],
+
+    editLink: {
+      pattern: 'https://github.com/cobaltcore-dev/.github/blob/main/docs/:path',
+      text: 'Edit this page on GitHub'
+    },
+
+    footer: {
+      copyright: `Copyright ${new Date().getFullYear()} SAP SE or an SAP affiliate company and cobaltcore-dev contributors.`
+    },
+
+    logo: { src: 'https://raw.githubusercontent.com/cobaltcore-dev/.github/refs/heads/main/assets/Logo_Cobalt_Core_background_white.svg', width: 24, height: 24 },
+
+    search: {
+      provider: 'local'
+    },
+
+    sidebar: [
+      {
+        text: 'Contents',
+        items: [
+          { text: 'Architecture', link: '/architecture' },
+          { text: 'API Reference', link: '/api' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/cobaltcore-dev' }
+    ]
+  }
+}))

docs/.vitepress/theme/custom.css

@@ -0,0 +1,37 @@
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+          120deg,
+          #e30909 30%,
+          #0a9ae8
+  );
+  --vp-home-hero-image-background-image: linear-gradient(
+          -45deg,
+          #e30909 50%,
+          #0a9ae8 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+.VPHero .VPImage {
+  filter: drop-shadow(-2px 4px 6px rgba(0, 0, 0, 0.2));
+  padding: 18px;
+}
+
+/* used in reference/default-theme-search */
+img[src='/search.png'] {
+  width: 100%;
+  aspect-ratio: 1 / 1;
+}

docs/.vitepress/theme/index.js

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default DefaultTheme

docs/api/index.md

@@ -0,0 +1,5 @@
+# API Reference
+
+::: warning
+API Reference is not available yet.
+:::

docs/architecture/index.md

@@ -0,0 +1,194 @@
+---
+outline: deep
+---
+
+# Architecture
+
+CobaltCore is built on top of OpenStack and IronCore, leveraging their capabilities to provide a robust cloud-native environment for non-cloud-native workloads. The architecture consists of several key components that work together to deliver a seamless experience.
+
+- **Kubernetes**: The container orchestration platform that manages the deployment, scaling, and operation of containerized applications.
+- **IronCore**: Bare metal provisioning and management tool that automates the discovery, provisioning, and evacuation of servers in the CobaltCore environment.
+- **OpenStack**: The various OpenStack services that provide compute, storage, and networking capabilities to the CobaltCore environment.
+- **Greenhouse**: The monitoring and management tool that provides insights into the health and performance of the CobaltCore environment.
+- **HA Service**: The high availability service that ensures critical workloads remain operational even in the event of failures.
+- **Cortex**: Smart placement service for VMs and storage in an OpenStack cloud environment.
+
+## Hypervisor
+The hypervisor is the foundation of the CobaltCore architecture, providing the virtualization layer that allows multiple virtual machines to run on a single physical server.
+Components of the hypervisor include:
+- **Node Agent**: Responsible for managing the node lifecycle and integration with the Kubernetes cluster.
+- **Nova Agent**: Handles the compute services, including scheduling and resource allocation for virtual machines.
+- **Neutron Agent**: Manages networking services, providing connectivity between virtual machines and external networks.
+- **HA Agent**: Ensures high availability of critical workloads by monitoring and managing failover processes.
+- **GardenLinux**: The Linux based operating system that runs on the hypervisor, providing a lightweight and secure environment for virtual machines.
+
+**Architecture:**
+
+```mermaid
+block-beta
+    columns 1
+    block:vms
+        columns 3
+        vm ["Virtual Machine 1"]
+        vm2 ["Virtual Machine 2"]
+    end
+    libvirt ["LibVirt"]
+    block:containers
+        columns 3
+        kvm ["Node Agent"]
+        nova ["Nova Agent"]
+        neutron ["Neutron Agent"]
+        ha ["HA Agent"]
+    end
+    block:os
+        gl ["GardenLinux"]
+    end
+    hv ["Hypervisor Baremetal Node"]
+```
+
+## Cluster Components
+The cluster components are responsible for managing the overall CobaltCore environment, including orchestration, monitoring, and management of resources.
+Components of the cluster include:
+
+**Hypervisor Operator**: 
+The Kubernetes operator that manages the lifecycle of hypervisor nodes.
+It ensures a newly discovered node is properly configured and integrated into the cluster.
+After the initial onboarding, the operator runs a final check to ensure the node is ready for use.
+The operator also handles the evacuation of nodes in case of failures or maintenance.
+
+
+## OpenStack
+OpenStack is a collection of services that provide compute, storage, and networking capabilities to the CobaltCore environment. The architecture of OpenStack in CobaltCore consists of several key components:
+
+This is a simplified model, leaving out [cells](https://docs.openstack.org/nova/latest/admin/cells.html).
+
+
+### Compute
+
+```mermaid
+C4Deployment
+    Deployment_Node(cp, "Control Plane", "i.e. qa-de-1"){
+        Deployment_Node(nova, "Nova Deployment", "chart"){
+            Container(novaapi, "API", "deployment", "")
+            ContainerDb(novadb, "DBs", "deployment", "")
+            ContainerQueue(novamq, "RabbitMQ", "deployment", "")
+            Container(novacond, "Conductor", "deployment", "")
+        }
+    }
+    Deployment_Node(cc, "Compute Cluster(s)", "i.e. cc-b0-qa-de-1"){
+        Deployment_Node(node, "Node", "i.e. shoot-xyz-xz"){
+            Deployment_Node(kubelet, "Kubernetes managed", ""){
+                Container(computeagent, "Nova Compute Agent", "daemonset")
+            }
+            Container_Boundary(systemd, "systemd managed", "Delivered in Image"){
+                Container_Ext(libvirtd, "libvirtd", "unit")
+                Container_Ext(vm, "VM", "unit")
+            }
+        }
+    }
+    Rel(novaapi, novamq, "", "AMQP")
+    BiRel(novamq, computeagent, "", "AMQP")
+    BiRel(novamq, novacond, "", "AMQP")
+    Rel(computeagent, libvirtd, "Instructs", "UNIX")
+    Rel(novaapi, novadb, "", "MYSQL")
+    Rel(novacond, novadb, "", "MYSQL")
+    Rel(libvirtd, vm, "Manages")
+    UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="1")
+```
+
+### Networking
+
+This section describes the networking components of OpenStack in CobaltCore, focusing on the Neutron service and its integration with OVN (Open Virtual Network).
+
+- Further reading
+  - [OVN Architecture](https://www.ovn.org/en/architecture/)
+  - Redhat Documentation on [Open Virtual Network (OVN)](https://docs.redhat.com/en/documentation/red_hat_openstack_platform/13/html/networking_with_open_virtual_network/open_virtual_network_ovn)
+
+```mermaid
+C4Deployment
+    Deployment_Node(cp, "Control Plane", "i.e. qa-de-1"){
+        Deployment_Node(neutron, "Neutron Deployment", "chart"){
+            Container(neutronapi, "Neutron API", "deployment", "")
+            ContainerDb(neutrondb, "DB", "deployment", "")
+            Container(neutronagents, "Agents (ACI...)", "deployment", "")
+            Container(ovnnb, "OVN-NB", "statefulset", "")
+            ContainerQueue(neutronmq, "RabbitMQ", "deployment", "")
+            Container(ovnsb, "OVN-SB", "statefulset", "")
+            Container(ovnnorthd, "OVN-NorthD", "statefulset", "")
+        }
+    }
+    Deployment_Node(cc, "Compute Cluster(s)", "i.e. cc-b0-qa-de-1"){
+        Deployment_Node(node, "Node", "i.e. shoot-xyz-xz"){
+            Deployment_Node(kubelet, "Kubernetes managed", ""){
+                Container(ovncontroller, "OVN Controller", "daemonset")
+            }
+            Container_Boundary(systemd, "systemd managed", "Delivered in Image"){
+                Container_Ext(vm, "VM", "unit")
+                Container_Ext(vmnic, "Interface", "Interface")
+                Container_Ext(ovs, "OVS", "unit")
+            }
+        }
+    }
+    BiRel(neutronapi, neutronmq, "AMQP")
+    BiRel(neutronmq, neutronagents, "AMQP")
+    Rel(neutronapi, neutrondb, "", "MYSQL")
+    Rel(neutronapi, ovnnb, "Configures", "OVS-DB")
+    Rel(ovnnorthd, ovnnb, "Reads", "OVS-DB")
+    Rel(ovnnorthd, ovnsb, "Translates", "OVS-DB")
+    Rel(ovnsb, ovncontroller, "Reads", "OVS-DB")
+    Rel(ovncontroller, ovs, "Translates", "OVS-DB")
+    Rel(vm, vmnic, "Uses")
+    Rel(ovncontroller, vmnic, "Creates")
+    Rel(ovs, vmnic, "Manages")
+    UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
+```
+
+### Storage
+
+
+```mermaid
+C4Deployment
+    Deployment_Node(cp, "Control Plane", "i.e. qa-de-1"){
+        Deployment_Node(nova, "Nova Deployment", "chart"){
+            Container(novaapi, "API", "deployment", "")
+            ContainerQueue(novamq, "RabbitMQ", "deployment", "")
+            Container(novacond, "Conductor", "deployment", "")
+        }
+        Deployment_Node(cinder, "Cinder", "chart"){
+            Container(cindervolume, "Volume Services", "deployment", "")
+            ContainerQueue(cindermq, "RabbitMQ", "deployment", "")
+            ContainerDb(cinderdb, "DB", "deployment", "")
+            Container(cinderapi, "API", "deployment", "")
+        }
+    }
+    Deployment_Node(cc, "Compute Cluster(s)", "i.e. cc-b0-qa-de-1"){
+        Deployment_Node(node, "Node", "i.e. shoot-xyz-xz"){
+            Deployment_Node(kubelet, "Kubernetes managed", ""){
+                Container(computeagent, "Nova Compute Agent", "daemonset")
+            }
+            Container_Boundary(systemd, "SystemD managed", "Delivered in Image"){
+                Container_Ext(libvirtd, "libvirtd", "unit")
+                Container_Ext(vm, "VM", "unit")
+                Container_Ext(mount, "Share", "mount")
+            }
+        }
+    }
+    Deployment_Node(ext, "Infrastructure"){
+        System_Ext(netapp, "Filer")
+    }
+    Rel(novaapi, novamq, "", "AMQP")
+    BiRel(novamq, computeagent, "", "AMQP")
+    BiRel(novamq, novacond, "", "AMQP")
+    Rel(computeagent, libvirtd, "Instructs", "UNIX")
+    Rel(libvirtd, vm, "Manages")
+    Rel(cinderapi, cindermq, "", "AMQP")
+    BiRel(cindermq, cindervolume, "", "AMQP")
+    Rel(cinderapi, cinderdb, "", "MYSQL")
+    Rel(cindervolume, cinderdb, "", "MYSQL")
+    Rel(cindervolume, netapp, "Manages", "REST")
+    Rel(cindervolume, novaapi, "Calls", "REST")
+    Rel(computeagent, mount, "Mounts")
+    Rel(computeagent, cinderapi, "Calls")
+    Rel(mount, netapp, "Accesses", "NFS")
+    UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
+```

docs/index.md

@@ -0,0 +1,29 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "CobaltCore"
+  text: "Cloud-Native OpenStack distribution to support non-Cloud-Native workloads"
+  image:
+    src: https://raw.githubusercontent.com/cobaltcore-dev/.github/refs/heads/main/assets/Logo_Cobalt_Core_background_black.svg
+    alt: CobaltCore logo
+
+  tagline: Leverage the power of OpenStack and IronCore bring your workloads to the cloud
+  actions:
+    - theme: alt
+      text: Architecture
+      link: /architecture
+    - theme: alt
+      text: API Reference
+      link: /api
+
+features:
+  - title: 🚀 Automatic Server Discovery, Provisioning and Evacuation
+    details: Installs and configures OpenStack services on bare metal servers automatically
+  - title: 😎 High Availability for critical Workloads
+    details: Automatic failover and redundancy for a smoother operation of your workloads
+  - title: 🔎️ Monitoring and Management
+    details: Integrated monitoring and management tools powered by Greenhouse to keep your OpenStack environment healthy
+---
+