Parameter Management

Parameters can be created as either standard or secret. A standard parameter will be visible as plain text in the UI or in any output from our CLI and API.

Standard parameters are typically used for configuration values. A secret parameter will be masked in any output and will require an extra step or additional flag to reveal the secret value. Standard parameter values can be populated via either Internal or External sources.

Secret parameters are typically passwords, private certificates, or any other sensitive information where one needs to be explicit as to when the values can be visible or unencrypted. Secret parameter values can be populated via either Internal or External sources. Secret parameters are also stored with additional encryption in the CloudTruth application.

Once created, parameters cannot be converted between secret and the standard parameter types.

Creating a parameter

  1. Using the global context at the top of the page, select Create Parameter from the Action menu to open the CREATE NEW PARAMETER dialog:

  • NAME - The parameter name used to reference the parameter's value (required)

  • DESCRIPTION - Further describe the parameter's purpose (optional)

  • SECRET PARAMETER - Select to mask the parameter's value by default when referenced (optional)

  • RULES - Expand to access the available parameter validation types and parameter value validation rules (optional):

  • PARAMETER TYPE - Set the type to ensure parameter values conform to a particular type (optional, default type is string)

  • RULE TYPE & CONSTRAINT - Optional constraints based on the selected PARAMETER TYPE (optional)

  • EXPIRES - Check the box to access the available parameter value expiration details (optional):

  • EXPIRES IN - Period in days for which a value expires.

  • AUTO-GENERATE VALUE - When a parameter is set to expire, regenerate the value based on selected options (optional). Check the box to access the available options:

If AUTO-GENERATE VALUE is unchecked, the value will not be modified at the end of the expiration period and will be labeled as expired in the UI

  1. Click Create Parameter after filling out the required fields to finish the parameter creation process. Upon parameter creation, the app will automatically navigate to the Parameter Details page and open the ADD ENVIRONMENT VALUE modal to be able to add the required value.

Editing a parameter

Parameter settings can be modified via the EDIT PARAMETER modal. These are the same settings the create parameter process has without the ability to change from standard to secret or vice versa.

  1. Open the EDIT PARAMETER modal by navigating to either the parameter list or a parameter's detail page and clicking the drop down selector and choosing: Edit Parameter Settings.

  1. Make any modifications and then click Save to save the new settings and close the modal.

Deleting a parameter

  1. Navigating to either the parameter list or a parameter's detail page and clicking the drop down selector and choosing: Delete Parameter.

  1. Confirm deletion by clicking Yes, delete to complete the parameter delete process.

Last updated

CopyrightΒ© 2023 CloudTruth