Major Feature Overview (aka. Goal Summary)
An elevator pitch (value statement) that describes the Feature in a clear, concise way. Complete during New status.
Enable customization of throughput settings for rootVolume drives during the installation of OpenShift in AWS to prevent production outages caused by the masters being capped at the default value of throughput.
We're setting the type of the root volumes for the masters at install time in the install-config.yaml:
controlPlane: name: master replicas: 3 architecture: amd64 hyperthreading: Enabled platform: aws: type: m5.4xlarge zones: - us-east-1a - us-east-1b - us-east-1c rootVolume: size: 500 type: gp3
Goals (aka. expected user outcomes)
The observable functionality that the user now has as a result of receiving this feature. Include the anticipated primary user type/persona and which existing features, if any, will be expanded. Complete during New status.
Will be able to customize the throughput settings of rootVolume drives at install time. This will enhance the existing feature of setting the root drives for the masters to customize the throughput capped to the default 125MiB/s (for GP3).
controlPlane:
name: master
replicas: 3
architecture: amd64
hyperthreading: Enabled
platform:
aws:
type: m5.4xlarge
zones:
- us-east-1a
- us-east-1b
- us-east-1c
rootVolume:
size: 500
throughput: 250MiB/s
type: gp3
Requirements (aka. Acceptance Criteria):
A list of specific needs or objectives that a feature must deliver in order to be considered complete. Be sure to include nonfunctional requirements such as security, reliability, performance, maintainability, scalability, usability, etc. Initial completion during Refinement status.
Allow users to customize the throughput settings of rootVolume drives at install time
Anyone reviewing this Feature needs to know which deployment configurations that the Feature will apply to (or not) once it's been completed. Describe specific needs (or indicate N/A) for each of the following deployment scenarios. For specific configurations that are out-of-scope for a given release, ensure you provide the OCPSTRAT (for the future to be supported configuration) as well.
| Deployment considerations | List applicable specific needs (N/A = not applicable) |
| Self-managed, managed, or both | Both |
| Classic (standalone cluster) | Yes |
| Hosted control planes | Yes |
| Multi node, Compact (three node), or Single node (SNO), or all | All |
| Connected / Restricted Network | Both |
| Architectures, e.g. x86_x64, ARM (aarch64), IBM Power (ppc64le), and IBM Z (s390x) | All |
| Operator compatibility | Yes |
| Backport needed (list applicable versions) | N/A |
| UI need (e.g. OpenShift Console, dynamic plugin, OCM) | May be required |
| Other (please specify) | N/A |
Use Cases (Optional):
Include use case diagrams, main success scenarios, alternative flow scenarios. Initial completion during Refinement status.
A customer wants to install an OpenShift cluster in AWS. They want to set the root drives for the masters to be GP3 and customize the throughput settings at install time to prevent potential production outages.
Questions to Answer (Optional):
Include a list of refinement / architectural questions that may need to be answered before coding can begin. Initial completion during Refinement status.
What are the technical challenges in implementing this feature?
Out of Scope
High-level list of items that are out of scope. Initial completion during Refinement status.
N/A
Background
Provide any additional context is needed to frame the feature. Initial completion during Refinement status.
The need for this feature arose from experiencing a few production outages where the masters were being capped at the default value of throughput.
Customer Considerations
Provide any additional customer-specific considerations that must be made when designing and delivering the Feature. Initial completion during Refinement status.
Customers who frequently experience high levels of traffic and have experienced outages due to throughput limitations will greatly benefit from this feature.
Documentation Considerations
Provide information that needs to be considered and planned so that documentation will meet customer needs. If the feature extends existing functionality, provide a link to its current documentation. Initial completion during Refinement status.
The existing documentation on installing OpenShift cluster in AWS will need to be updated to include instructions on how to customize the throughput settings of GP3 drives at install time.
Interoperability Considerations
Which other projects, including ROSA/OSD/ARO, and versions in our portfolio does this feature impact? What interoperability test scenarios should be factored by the layered products? Initial completion during Refinement status.
None