MetadataSchema

The MetadataSchema represents deployment and configuration metadata for services in the ConfidentialMind system. It is used as part of the ServiceEntrySchema.

Properties

Property	Type	Description
deployment_image	string	The image used for deployment
deployment_image_version	string	Version of the deployment image
chart_version	string	Version of the Helm chart used
values_file	string | null	Optional: Path to the values file
custom_registry_url	string | null	Optional: URL of a custom registry
custom_chart_url	string | null	Optional: URL of a custom chart
overwrite_values	ServiceOverrideSchema | null	Optional: Overwrite values for the service

Usage

This schema is used in the metadata field of the ServiceEntrySchema. It provides crucial information about the deployment configuration of a service.

Example

{
  "deployment_image": "myservice",
  "deployment_image_version": "1.2.3",
  "chart_version": "0.1.0",
  "values_file": "/path/to/values.yaml",
  "custom_registry_url": "https://my-custom-registry.com",
  "custom_chart_url": "https://my-custom-charts.com/myservice",
  "overwrite_values": {
    "replicaCount": 3,
    "image": {
      "pullPolicy": "Always"
    },
    "autoscaling": {
      "enabled": true,
      "minReplicas": 2,
      "maxReplicas": 5
    }
  }
}

Validation

When validating a Metadata object, ensure that:

1. deployment_image, deployment_image_version, and chart_version are always present and non-empty strings.
2. values_file, custom_registry_url, and custom_chart_url are either strings or null.
3. overwrite_values, if present, conforms to the ServiceOverrideSchema.

This schema is crucial for defining how a service should be deployed and configured in the ConfidentialMind system.