> ## Documentation Index
> Fetch the complete documentation index at: https://docs.celum.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Install rook ceph

> Rook-Ceph install via Flux helm-controller.

**Authorisation:** `storage:InstallDriver` on `krn:celum:supervisor:{name}:storage:*`.



## OpenAPI

````yaml /openapi.json post /api/supervisors/{name}/storage/rook/install
openapi: 3.0.3
info:
  description: >-
    The HTTP surface of the Celum backend, generated from its own router and

    authorisation map — so this list cannot drift from the server that serves
    it.


    **Every operation states the IAM action and resource it is authorised

    against.** That pairing is the part worth reading: a policy naming the right

    action against the wrong resource matches nothing, and fails silently.


    Request and response bodies come from the Go types the handlers send and

    decode. Where those types do not determine the shape (an interface, a

    map[string]any, an unknown custom encoding), the operation says so in

    `x-celum-schema-gap` instead of carrying a guessed schema.
  title: Celum API
  version: 1.0.0
servers:
  - description: Your Celum deployment
    url: https://{host}
    variables:
      host:
        default: celum.example.com
        description: The host your Celum backend is served from
security:
  - sessionCookie: []
  - bearerToken: []
tags:
  - description: AI assistant & MCP
    name: ai-assistant
  - description: Clusters & CAPI lifecycle
    name: capi
  - description: Certificates & external secrets
    name: certs
  - description: GitOps & apps
    name: gitops
  - description: IAM, audit & auth
    name: iam
  - description: Image library
    name: images
  - description: Infrastructure & supervisors
    name: infrastructure
  - description: Networking
    name: networking
  - description: Observability & platform health
    name: observability
  - description: Platform onboarding & settings
    name: platform-settings
  - description: Projects
    name: projects
  - description: Registries & mirroring
    name: registries
  - description: Security & flows
    name: security
  - description: Storage
    name: storage
  - description: Templates & addons
    name: templates
  - description: Virtualization platform (KubeVirt/CDI)
    name: virt
  - description: Virtual machines
    name: vms
  - description: Workloads & topology
    name: workloads
paths:
  /api/supervisors/{name}/storage/rook/install:
    post:
      tags:
        - storage
      summary: Install rook ceph
      description: >-
        Rook-Ceph install via Flux helm-controller.


        **Authorisation:** `storage:InstallDriver` on
        `krn:celum:supervisor:{name}:storage:*`.
      operationId: post_supervisors_byName_storage_rook_install
      parameters:
        - description: >-
            The supervisor's name, as registered under Administration →
            Supervisors.
          in: path
          name: name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.rookInstallRequest.Input'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.rookInstallResponse'
          description: Accepted.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Request.
        '401':
          description: Not authenticated — no valid session cookie or API token.
        '403':
          description: >-
            Authenticated, but no policy allows this action on this resource.
            The body carries the action and resource that were evaluated.
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Precondition Failed.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Unprocessable Entity.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Gateway.
components:
  schemas:
    api.rookInstallRequest.Input:
      properties:
        cephConfig:
          additionalProperties:
            additionalProperties:
              type: string
            nullable: true
            type: object
          nullable: true
          type: object
        cephImage:
          type: string
        clusterChartVersion:
          type: string
        clusterNetworkCidr:
          type: string
        createCephFS:
          type: boolean
        createObjectStore:
          type: boolean
        createRBD:
          type: boolean
        createSANPool:
          type: boolean
        crushFailureDomain:
          type: string
        deviceFilter:
          type: string
        enableDashboard:
          type: boolean
        enableDiscovery:
          type: boolean
        enableMonitoring:
          type: boolean
        monCount:
          format: int64
          type: integer
        operatorChartVersion:
          type: string
        osdCpuRequest:
          type: string
        osdMemoryLimit:
          type: string
        osdMemoryRequest:
          type: string
        publicNetworkCidr:
          type: string
        replicaSize:
          format: int64
          type: integer
        sanReplicaSize:
          format: int64
          type: integer
        selectedDisks:
          additionalProperties:
            items:
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
        selectedSanDisks:
          additionalProperties:
            items:
              type: string
            nullable: true
            type: array
          nullable: true
          type: object
        wipeDisks:
          items:
            $ref: '#/components/schemas/api.hostDisksEntry.Input'
          nullable: true
          type: array
      type: object
      x-go-type: backend/internal/api.rookInstallRequest
    api.rookInstallResponse:
      properties:
        message:
          type: string
        steps:
          items:
            $ref: '#/components/schemas/api.rookInstallStepResult'
          nullable: true
          type: array
      required:
        - steps
      type: object
      x-go-type: backend/internal/api.rookInstallResponse
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
    api.hostDisksEntry.Input:
      properties:
        disks:
          items:
            type: string
          nullable: true
          type: array
        hostname:
          type: string
      type: object
      x-go-type: backend/internal/api.hostDisksEntry
    api.rookInstallStepResult:
      properties:
        action:
          type: string
        kind:
          type: string
        name:
          type: string
      required:
        - action
        - kind
        - name
      type: object
      x-go-type: backend/internal/api.rookInstallStepResult
  securitySchemes:
    sessionCookie:
      description: >-
        The session cookie issued by the OIDC sign-in flow. This is what a
        browser uses.
      in: cookie
      name: k8s-gate-session
      type: apiKey
    bearerToken:
      description: >-
        An API token, minted from your own identity page. A token carries the
        IAM groups you held **when it was minted**, and cannot bypass deletion
        approval — except for guest clusters inside a project that same token
        created.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.