netbox_rpki.maturity

Subsystem maturity metadata for the netbox_rpki plugin.

Each navigation group (subsystem) is assigned a maturity level that conveys its stability posture to operators. Maturity levels are surfaced in navigation labels, documented in the Sphinx site, and consumed by the hide_experimental plugin setting.

Maturity level definitions

GA

Generally available. The subsystem has shipped, is covered by the contract test suite, and its data model and public API surface are considered stable for the current release line.

Beta

Feature-complete and tested but still settling. The subsystem is expected to evolve across minor releases. Breaking changes are possible but will be documented in the changelog.

Experimental

Early-stage or recently introduced. The subsystem may change significantly, be restructured, or be removed. Use cautiously in production.

Attributes

SUBSYSTEM_MATURITY

MATURITY_BADGE_TEXT

Classes

MaturityLevel

Subsystem maturity classification.

Functions

get_maturity(group_name)

Return the maturity level for a navigation group, defaulting to GA.

get_badge(group_name)

Return the badge suffix for group_name, or empty string for GA.

is_hidden(group_name, *, hide_experimental)

Return True when group_name should be suppressed from navigation.

Module Contents

class netbox_rpki.maturity.MaturityLevel(*args, **kwds)[source]

Bases: enum.Enum

Inheritance diagram of netbox_rpki.maturity.MaturityLevel

Subsystem maturity classification.

GA = 'GA'[source]
BETA = 'Beta'[source]
EXPERIMENTAL = 'Experimental'[source]
netbox_rpki.maturity.SUBSYSTEM_MATURITY: dict[str, MaturityLevel][source]
netbox_rpki.maturity.MATURITY_BADGE_TEXT: dict[MaturityLevel, str][source]
netbox_rpki.maturity.get_maturity(group_name)[source]

Return the maturity level for a navigation group, defaulting to GA.

Parameters:

group_name (str)

Return type:

MaturityLevel

netbox_rpki.maturity.get_badge(group_name)[source]

Return the badge suffix for group_name, or empty string for GA.

Parameters:

group_name (str)

Return type:

str

netbox_rpki.maturity.is_hidden(group_name, *, hide_experimental)[source]

Return True when group_name should be suppressed from navigation.

Parameters:
  • group_name (str)

  • hide_experimental (bool)

Return type:

bool