Release 2.0

[mdbooth]

Release 1.1 2.0 will continue to be an alpha release. It may be was renumbered according to SemVer constraints according to changes in the exposed Go API.

It will be possible to upgrade to release 1.1 from release 1.0 seamlessly.

Functionally, release 1.1 2.0 will:

• include at least the following controllers:
  • Flavor
  • Image
  • Network
  • Port
  • Router (including router interface)
  • SecurityGroup (including security group rules)
  • Server
  • Subnet
• support mutability for all some resources
• have e2e tests covering a TBD set of target resource deployments
• increase unit test coverage
• be able to deploy a server running an 'all-in-one' devstack with a public interface from a single deployment

We will provide documentation covering the following:

• Automatically generated API docs covering the complete API
• A quick start guide
• Improved getting-started experience with credentials
• Developer on-boarding

[mandre]

I was looking at the go-apidiff output earlier, and there are a few breaking changes between the release-1.0 branch and main:

❯ ~/dev/private/go-apidiff/go-apidiff 690b760f49dfb61b173755e91cb51ed42472c7f3 d564345ec2903f3f7ca41e9d831d2ecc4ff0e87a

github.com/k-orc/openstack-resource-controller/pkg/clients/applyconfiguration/api/v1alpha1
  Incompatible changes:
  - (*ImageFilterApplyConfiguration).WithName: changed from func(string) *ImageFilterApplyConfiguration to func(github.com/k-orc/openstack-resource-controller/api/v1alpha1.OpenStackName) *ImageFilterApplyConfiguration
  - (*ImagePropertiesApplyConfiguration).WithMinDiskGB: changed from func(int) *ImagePropertiesApplyConfiguration to func(int32) *ImagePropertiesApplyConfiguration
  - (*ImagePropertiesApplyConfiguration).WithMinMemoryMB: changed from func(int) *ImagePropertiesApplyConfiguration to func(int32) *ImagePropertiesApplyConfiguration
  - (*ImagePropertiesHardwareApplyConfiguration).WithCPUCores: changed from func(int) *ImagePropertiesHardwareApplyConfiguration to func(int32) *ImagePropertiesHardwareApplyConfiguration
  - (*ImagePropertiesHardwareApplyConfiguration).WithCPUSockets: changed from func(int) *ImagePropertiesHardwareApplyConfiguration to func(int32) *ImagePropertiesHardwareApplyConfiguration
  - (*ImagePropertiesHardwareApplyConfiguration).WithCPUThreads: changed from func(int) *ImagePropertiesHardwareApplyConfiguration to func(int32) *ImagePropertiesHardwareApplyConfiguration
  - (*ImageResourceSpecApplyConfiguration).WithName: changed from func(string) *ImageResourceSpecApplyConfiguration to func(github.com/k-orc/openstack-resource-controller/api/v1alpha1.OpenStackName) *ImageResourceSpecApplyConfiguration
  - (*ImageStatusApplyConfiguration).WithDownloadAttempts: changed from func(int) *ImageStatusApplyConfiguration to func(int32) *ImageStatusApplyConfiguration
  - (*ImageStatusExtraApplyConfiguration).WithDownloadAttempts: changed from func(int) *ImageStatusExtraApplyConfiguration to func(int32) *ImageStatusExtraApplyConfiguration
  - ImageFilterApplyConfiguration.Name: changed from *string to *github.com/k-orc/openstack-resource-controller/api/v1alpha1.OpenStackName
  - ImagePropertiesApplyConfiguration.MinDiskGB: changed from *int to *int32
  - ImagePropertiesApplyConfiguration.MinMemoryMB: changed from *int to *int32
  - ImagePropertiesHardwareApplyConfiguration.CPUCores: changed from *int to *int32
  - ImagePropertiesHardwareApplyConfiguration.CPUSockets: changed from *int to *int32
  - ImagePropertiesHardwareApplyConfiguration.CPUThreads: changed from *int to *int32
  - ImageResourceSpecApplyConfiguration.Name: changed from *string to *github.com/k-orc/openstack-resource-controller/api/v1alpha1.OpenStackName
  - ImageStatusApplyConfiguration.DownloadAttempts: changed from *int to *int32
  - ImageStatusExtraApplyConfiguration.DownloadAttempts: changed from *int to *int32

github.com/k-orc/openstack-resource-controller/pkg/clients/clientset/clientset/typed/api/v1alpha1
  Incompatible changes:
  - FlavorsGetter.Flavors: added
  - NetworksGetter.Networks: added
  - PortsGetter.Ports: added
  - RouterInterfacesGetter.RouterInterfaces: added
  - RoutersGetter.Routers: added
  - SecurityGroupsGetter.SecurityGroups: added
  - ServersGetter.Servers: added
  - SubnetsGetter.Subnets: added

github.com/k-orc/openstack-resource-controller/pkg/clients/informers/externalversions/api/v1alpha1
  Incompatible changes:
  - Interface.Flavors: added
  - Interface.Networks: added
  - Interface.Ports: added
  - Interface.RouterInterfaces: added
  - Interface.Routers: added
  - Interface.SecurityGroups: added
  - Interface.Servers: added
  - Interface.Subnets: added

github.com/k-orc/openstack-resource-controller/api/v1alpha1
  Incompatible changes:
  - ImageFilter.Name: changed from *string to *OpenStackName
  - ImageProperties.MinDiskGB: changed from *int to *int32
  - ImageProperties.MinMemoryMB: changed from *int to *int32
  - ImagePropertiesHardware.CPUCores: changed from *int to *int32
  - ImagePropertiesHardware.CPUSockets: changed from *int to *int32
  - ImagePropertiesHardware.CPUThreads: changed from *int to *int32
  - ImageResourceSpec.Name: changed from string to *OpenStackName
  - ImageResourceStatus.Status: changed from *string to string
  - ImageStatus.DownloadAttempts: changed from *int to *int32
  - ImageStatusExtra.DownloadAttempts: changed from *int to *int32
  - OpenStackConditionAvailable: removed
  - OpenStackConditionProgressing: removed
  - OpenStackConditionReasonInvalidConfiguration: removed
  - OpenStackConditionReasonProgressing: removed
  - OpenStackConditionReasonSuccess: removed
  - OpenStackConditionReasonTransientError: removed
  - OpenStackConditionReasonUnrecoverableError: removed

github.com/k-orc/openstack-resource-controller/pkg/controllers
  Incompatible changes:
  - ImageController: removed
  - NewScopeFactory: removed

We'll most probably call the next release 2.0.

That said, it's not clear to me why go-apidiff flags additions as backward incompatible changes.