Integrated deployment configuration and documentation.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

conventions.rst 1.6KB

Undercloud Platform Conventions

Undercloud Platform components conform to a minimal set of of conventions to provide for reasonable levels of consistency.


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