0.3.x CRD Field Migration

The 0.3.x release accepts both the previous and current names for CRD spec fields.

Versions marked “overview” do not contain this page. Selecting one opens that version’s documentation overview.

On this page

The 0.3.x release accepts both the previous and current names for CRD spec fields. The grid-site and grid-operator charts also translate previous value names when they render resources. The previous names are deprecated and will be removed in a later release. Migrate custom resources and Helm values before upgrading to 0.3.x.

Do not set both names for one field. The API schema and chart reject conflicting old and new names.

Field mapping

Resource or Helm valuePrevious fieldCurrent field
GridNetwork.specgatewayRefsconsumerGateways
GridNetwork.spec.consumerGateways[]localSiteNamesiteName
GridNetwork.spec.consumerGateways[]consumerConfigpraxisConfig
GridNetwork.spec.consumerGateways[].praxisConfigenabledgenerate
GridNetwork.spec.consumerGateways[].praxisConfigcredentialMountBasecredentialMountPath
GridNetwork.spec.tlsswimKeyRefswimKeySecretRef
GridSite.specegressgatewayEndpoint
InferenceProvider.specgatewayRefproviderGateway
InferenceProvider.specroutingClusterRefclusterName
InferenceProvider.spec.metricsConfigmetricsEndpointendpoint
InferenceProvider.spec.auth and AgentToolProvider.spec.authmanualcredentialsManagedExternally
grid-site chart gridNetwork valuesgatewayRefsconsumerGateways
grid-site chart gridNetwork.consumerGateways[]localSiteNamesiteName
grid-site chart gridNetwork.consumerGateways[]consumerConfigpraxisConfig
grid-site chart gridNetwork.consumerGateways[].praxisConfigenabledgenerate
grid-site chart gridNetwork.consumerGateways[].praxisConfigcredentialMountBasecredentialMountPath
grid-site chart gridNetwork.tlsswimKeyRefswimKeySecretRef
grid-site chart gridSite valuesegressgatewayEndpoint
grid-site chart inferenceProviders valuesroutingClusterRefclusterName
grid-site chart inferenceProviders valuesgatewayRefproviderGateway
grid-site chart inferenceProviders[].metricsConfigmetricsEndpointendpoint
grid-site chart inferenceProviders[].authmanualcredentialsManagedExternally
grid-operator rendered GridNetwork.specgatewayRefsconsumerGateways
grid-operator rendered GridNetwork.spec.consumerGateways[]localSiteNamesiteName
grid-operator rendered GridNetwork.spec.tlsswimKeyRefswimKeySecretRef
grid-operator chart grid.providers[]routingClusterRefclusterName
grid-operator chart grid.providers[]gatewayRefproviderGateway
grid-operator chart grid.providers[].metricsConfigmetricsEndpointendpoint
grid-operator chart grid.providers[].authmanualcredentialsManagedExternally

Upgrade to 0.3.x

Existing CRD spec field names and chart values remain accepted in 0.3.x. Update manifests and Helm values to the current names when convenient.

Status fields and reasons change in 0.3.x without legacy aliases. Update scripts and dashboards that read them during the 0.3.x upgrade, including overlayStatus to routingMapStatus and consumerConfigStatus to praxisConfigStatus. Status is operator-owned; do not migrate it by hand. The compatibility window covers spec fields and chart values only.

Upgrade in this order:

  1. Apply the 0.3.x CRDs first. When the platform owns the CRDs, apply the chart’s CRD templates before installing the charts with crds.enabled=false.
  2. Upgrade grid-operator.
  3. Upgrade grid-site.
  4. Apply custom resources and Helm values using the current field names.

For a rollback, roll back grid-site before grid-operator so the older operator does not receive current field names. Restore custom resources and values only after the older CRDs and charts are ready.

Previous status field or reasonCurrent status field or reason
distributedProviderCountremoteProviderCount
consumerConfigStatuspraxisConfigStatus
overlayStatusroutingMapStatus
OverlayRenderFailedRoutingMapRenderFailed
OverlayApplyFailedRoutingMapApplyFailed
ConsumerConfigRenderFailedPraxisConfigRenderFailed
ConsumerConfigApplyFailedPraxisConfigApplyFailed
ConsumerConfigErrorPraxisConfigError
ConsumerConfigDisabledPraxisConfigDisabled
EgressMissingGatewayAddressMissing

Before upgrading after the compatibility window

  1. Back up the affected custom resources and Helm values.
  2. Update manifests and Helm values using the mapping above.
  3. Pause the operator before installing CRD schemas that remove the aliases.
  4. Apply the updated custom resources and upgrade grid-site with its updated values.
  5. Start the later operator after all affected resources use the current names.