Neo4J Database resource type

[superbeeny]

Overview

• Adds a new application-oriented Resource Type, Radius.Data/neo4jDatabases, and an initial Alpha Kubernetes Bicep recipe.
• The recipe provisions Neo4j via a StatefulSet with a PVC for persistence and a ClusterIP Service exposing Bolt (7687).
• Documentation is included for platform engineers and recipe usage.

Changes

• Resource type and docs:
• Data/neo4jDatabases/neo4jDatabases.yaml
  • capabilities: ["SupportsRecipes"]
  • apiVersion: 2025-09-11-preview
  • Properties:
    • Inputs: environment (required), application (optional)
    • Read-only outputs: host (string), port (integer), username (string), password (string)
  • Data/neo4jDatabases/README.md
    • Platform engineer docs, inputs/outputs, and recipe listing
• Kubernetes Bicep recipe:
  • Data/neo4jDatabases/recipes/kubernetes/bicep/kubernetes-neo4j.bicep
    • Parameters:
      • database (default: resource name)
      • user (default: neo4j)
      • password (secure, default: uniqueString(context.resource.id))
      • tag (default: community)
  • Resources:
    • apps/StatefulSet with ReadWriteOnce PVC (10Gi)
    • core/Service (ClusterIP) for Bolt (7687)
  • Outputs:
    • values.host, values.port, values.database, values.username
    • secrets.password
  • Output resource IDs reference apps/StatefulSet (matches what is deployed)
  • Data/neo4jDatabases/recipes/kubernetes/README.md
  • Updated to reflect StatefulSet + PVC, auth parameters, and outputs
  • Markdown-linted (indentation and blank lines)
  • Validation utility update:
    • .github/scripts/validate-common.sh
    • Includes Data and Compute folders and maps to Radius.Data and Radius.Compute so validation can find and handle Data resource types

Resource Type Schema Summary

• Namespace: Radius.Data
• Type: neo4jDatabases
• apiVersion: 2025-09-11-preview
• Properties:
  • environment (string, required)
  • application (string, optional)
  • host (string, readOnly)
  • port (integer, readOnly)
  • username (string, readOnly)
  • password (string, readOnly)

Directory Structure

Data/
└── neo4jDatabases/
    ├── README.md
    ├── neo4jDatabases.yaml
    └── recipes/
        └── kubernetes/
            ├── README.md
            └── bicep/
                └── kubernetes-neo4j.bicep

Developer Usage Example

resource neo4j 'Radius.Data/neo4jDatabases@2025-09-11-preview' = {
  name: 'neo4j'
  properties: {
    environment: environment
    // application: myApp.id // Optional
  }
}

Recipe Parameters

• database (string, default: resource name): Database name to configure.
• user (string, default: neo4j): Username to provision.
• password (secure string, default: uniqueString(context.resource.id)): Password to provision.
• tag (string, default: community): Tag for the neo4j container image.

Recipe Outputs

• values.host: Internal DNS name of the Service.
• values.port: Bolt port (7687).
• values.database: Database name used by the deployment.
• values.username: Username provided to the recipe.
• secrets.password: Password provided to the recipe.

Testing Instructions

• Prereqs:
  • Docker + k3d
  • ORAS CLI
  • rad CLI

Provision local environment and test:

• make install-radius
• make create-workspace
• make create-resource-types
• make publish-bicep-extensions
• make update-bicepconfig
• make test-bicep-recipes

Expected outcomes:

• Resource type Radius.Data/neo4jDatabases exists (make verify-resource-types).

• Bicep recipe publishes to local registry and registers as default.

• Test deploy succeeds and outputs:

  • values.host, values.port, values.database, values.username
  • secrets.password

• Test app cleanup succeeds.
  Acceptance Criteria

• Resource type schema validates and registers.

• Kubernetes Bicep recipe deploys successfully via test workflow.

• Documented inputs and outputs match the schema and recipe behavior.

• CI/lints pass for touched files.

Notes

Maturity: Alpha. Feedback welcome on production-hardening (auth, storage class, external exposure, backup/restore).

[Reshrahim]

@superbeeny Looks like some of the commits from main were again signed by you in this branch and already merged commits shows up as a new change. @brooke-hamilton suggested some approaches to overcome this in this PR. Copy pasting it here to see if it helps

I think there are a few things you can try to fix up this branch. Here are some options:

• Merge the current version of main into your branch (not rebase). I'm not 100% sure that will fix the diffs appearing in the PR, but it might.
• Delete the unrelated commits from this branch, then merge from main (or rebase), then force push this branch again.
• Create a new branch from main, cherry-pick your changes from this branch into the new branch, and create a new PR from the new branch. Close this PR.
• Create a new branch from main, copy over your file changes to the new branch, and create a new PR from the new branch. Close this PR.

Let me know if this helps!

[superbeeny]

Closing, replacement PR #58