1.6 KiB
1.6 KiB
Undercloud Platform Conventions
Undercloud Platform components conform to a minimal set of of conventions to provide for reasonable levels of consistency.
Language
While these documents are not an IETF RFC, RFC 2119 provides for useful language definitions. In this spirit:
- 'must', 'shall', 'will', and 'required' language indicates inflexible rules.
- 'should' and 'recommended' language is expected to be followed but reasonable exceptions may exist.
- 'may' and 'can' lanugage is intended to be optional, but will provide a recommended approach if used.
Conventions and Standards
alarming-conditions api-conventions rbac-conventions client-software code-conventions documentation-conventions service-logging-conventions security-conventions