Uploaded image for project: 'Puppet Development Kit'
  1. Puppet Development Kit
  2. PDK-1618

Add feature flags to the PDK

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PDK 1.17.0
    • Component/s: None
    • Template:
    • Acceptance Criteria:
      • All other PDK functionality should NOT be affected if no flags are set.
      • Users should be able to easily set and unset flags
      • (Nice to have) be able to query for available feature flags.
    • Team:
      Puppet Developer Experience
    • Release Notes:
      New Feature
    • Release Notes Summary:
      Hide
      The PDK now has [feature flags](https://en.wikipedia.org/wiki/Feature_toggle). You activate feature flags by setting the PDK_FEATURE_FLAGS environment variable with a comma separated list of flag names. For example

      Windows: `$ENV:PDK_FEATURE_FLAGS = 'feature1, feature2'`

      Non-Windows: `export PDK_FEATURE_FLAGS=feature1,feature2

      You can see what flags are available using the `pdk get config command

      ```
      > pdk get config
      ...
      user.pdk_feature_flags.available=["feature1","feature2"]
      user.pdk_feature_flags.requested=[]
      ```
      Show
      The PDK now has [feature flags]( https://en.wikipedia.org/wiki/Feature_toggle ). You activate feature flags by setting the PDK_FEATURE_FLAGS environment variable with a comma separated list of flag names. For example Windows: `$ENV:PDK_FEATURE_FLAGS = 'feature1, feature2'` Non-Windows: `export PDK_FEATURE_FLAGS=feature1,feature2 You can see what flags are available using the `pdk get config command ``` > pdk get config ... user.pdk_feature_flags.available=["feature1","feature2"] user.pdk_feature_flags.requested=[] ```
    • QA Risk Assessment:
      Needs Assessment

      Description

      Currently in the PDK all features are available at all times. However this makes it difficult to
      try out new functionality which may have breaking behaviours. This ticket will track the work to implement features flags into the PDK.

      They could be a configuration file, or an environment variable

      I imagine the flags may not be documented on the main docs site, but the in the release notes.

      Features behind flags will not be "supported", as in breakages are expected

      All other PDK functionality should NOT be affected if no flags are set.

        Attachments

          Activity

            People

            Assignee:
            glenn.sarti Glenn Sarti
            Reporter:
            glenn.sarti Glenn Sarti
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support