Skip to main content

Stacklok Desktop policies

These directives control which features are visible in Stacklok Desktop. Use them to hide elements that don't apply to your organization's workflow or to enforce a consistent interface for all users.

Playground

Use this directive to show or hide the Playground tab in Stacklok Desktop.

values.yaml
enterpriseConfig:
playground:
# false = hide the Playground tab
# true = show the Playground tab
value: false
# "enforced" blocks local overrides; "default" lets users override locally
enforcement: 'enforced'

The combined behavior of the value and enforcement fields:

EnforcementValueClient behavior
enforcedfalseClients must hide the Playground tab. Users cannot enable it.
enforcedtrueClients must show the Playground tab. Users cannot disable it.
defaultfalseClients hide the Playground by default but users may enable it.
defaulttrueClients show the Playground by default but users may disable it.

After updating your configuration, apply the change.

Variations

Advisory hide

Hide the Playground by default while allowing users to re-enable it locally:

values.yaml
enterpriseConfig:
playground:
value: false
enforcement: 'default'

Force Playground visible

For sandbox or training environments where you want to guarantee the Playground is accessible to all users:

values.yaml
enterpriseConfig:
playground:
value: true
enforcement: 'enforced'

Help menu

Use this directive to show or hide the help menu (? button) in Stacklok Desktop.

values.yaml
enterpriseConfig:
help_menu:
# false = hide the help menu
# true = show the help menu
value: false
# "enforced" blocks local overrides; "default" lets users override locally
enforcement: 'enforced'
EnforcementValueClient behavior
enforcedfalseClients must hide the help menu. Users cannot enable it.
enforcedtrueClients must show the help menu. Users cannot disable it.
defaultfalseClients hide the help menu by default but users may enable it.
defaulttrueClients show the help menu by default but users may disable it.

After updating your configuration, apply the change.

Variations

Advisory hide

Hide the help menu by default while allowing users to re-enable it locally:

values.yaml
enterpriseConfig:
help_menu:
value: false
enforcement: 'default'

Next steps