Rename bay to cluster

Registered by Jaycen Grant

The use of new magnum term of bay has caused confusion with users. The common term is now cluster and magnum should be updated to follow the more common term for better user experience. Both python client and api service APIs will be updated to replace bay with cluster. Internal classes, documentation, and any references will be updated to the new term. Bay and BayModel APIs will still be valid with a depreciated warning to the user for the next few releases. See Newton Mid-cycle notes[1] for details behind this change.

Note (hongbin): This work needs to be backward-compatible, which means the bay and baymodel abstraction should work as before.


Blueprint information

Jaycen Grant
Jaycen Grant
Series goal:
Accepted for newton
Milestone target:
milestone icon newton-3
Started by
Jaycen Grant
Completed by
Jaycen Grant

Related branches



Bay = Cluster
BayModel = ClusterTemplate

Gerrit topic:,topic:bp/rename-bay-to-cluster,n,z

Addressed by:
    [WIP]Rename Bay to Cluster in api

Addressed by:
    [WIP]Rename Bay to Cluster in docs

Addressed by:
    [WIP] Add support for cluster UUID parameter in addition to bay UUID in Certificate API.

Addressed by:
    Rename bay UUID parameter to cluster UUID in certificates API.

Addressed by:
    Add cluster to cert commands

Addressed by:
    Bay to Cluster api cleanup

Addressed by:
    Rename BayModel DB, Object, and internal usage to ClusterTemplate

Addressed by:
    Rename bay to cluster in certificate object and references

Addressed by:
    Rename Bay to Cluster in functional tests

Addressed by:
    Updates CONF usage from bay to cluster.

Addressed by:
    Updates drivers from BayModel to ClusterTemplate

Addressed by:
    Rename Bay DB, Object, and internal usage to Cluster

Gerrit topic:,topic:bug/1622949,n,z

Addressed by:
    Rename bay to cluster in opensuse k8s driver


Work Items

Work items:
Update Client with new cluster APIs(including unit and functional test updates): DONE
Update API service with new cluster APIs(including unit and function test updates): DONE
Update User Guide and Quick start guide documentation: DONE
Update internal code references(Classes, references, documentation, etc...): DONE
Update UI with new cluster terms: DONE

This blueprint contains Public information 
Everyone can see this information.


No subscribers.