Versioning of Custom Resource Definitions

Effective 10.0.2604.2 June release, to support multiple API versions for Custom Resource Definitions (CRDs), a stable version v1 is introduced for the IBM® Sterling Intelligent Promising Operator. The previous version v1beta1 is deprecated and the new features are available only in the v1 version.

Storage version change

The storage version is v1, which means:

  • If you create resources using v1beta1, Kubernetes or OpenShift will automatically translate them to v1 for storage.
  • All existing resources stored as v1beta1 will be automatically converted to v1 when accessed.
  • This ensures seamless compatibility and forward migration path.

API version support

The following key points are applicable for SIPEnvironment and all the service components, IVServiceGroup, PromisingServiceGroup, OptimizerServiceGroup, UtilityServiceGroup, OMSGateway, and CertificateManager

  • All features and configurations introduced in v1beta1 remain fully supported in v1.
  • Existing configurations are automatically carried over to v1.
  • No manual intervention required for feature parity.

User action

For new environments

  • Use v1 API version for all new custom resources.
  • Reference the v1 API documentation for the latest schema and features.
  • Example: 
    apiVersion: apps.sip.ibm.com/v1
kind: IVServiceGroup
metadata:
  name: my-iv-service
spec:
  # Your configuration here

For existing environments

  • No immediate action required. Your existing v1beta1 resources will continue to function.
  • Kubernetes or OpenShift automatically handles version conversion.
  • It is recommended to update your custom resource YAML files to use v1 for better long-term support.
  • CI/CD pipelines: Update your automation scripts to reference v1 API version.

For CI/CD and GitOps workflows

If you maintain custom resources in version control or automation pipelines:

  1. Before upgrading to 10.0.2604.2 release, update the apiVersion field from apps.sip.ibm.com/v1beta1 to apps.sip.ibm.com/v1.
  2. Review and test changes in non-production environments first.
  3. No schema changes required as all v1beta1 fields are supported in v1.

Version deprecation timeline

  • v1beta1 is supported but deprecated and it will be removed in a future release.
  • v1 is the current stable version and it is recommended for all deployments.