Skip to content

Commit

Permalink
Merge pull request #2841 from balena-io/vipul/restart-behavior
Browse files Browse the repository at this point in the history
patch: Signify behavior when variables change
  • Loading branch information
vipulgupta2048 authored Oct 27, 2023
2 parents 9176eb7 + 926f568 commit 1060853
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pages/learn/manage/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ Variables defined in the dashboard are exposed on the device as environment vari

<img alt="Accessing variable" src="/img/variables/accessing_variables.png">

__Note:__ Adding or modifying a variable for all services will restart all services on the device. Similarly, changing variables defined only for a specific service will only restart the affected service.

Variables can be applied at the fleet or the individual device level through the Variables page. You can apply Variables to the entire fleet by navigating to the Variables page for that fleet.
Variables can be applied at the fleet or the individual device level through the Variables page. You can apply Variables to the entire fleet by navigating to the Variables page for that fleet. Adding or modifying a fleet variable for all services will restart all services on the device. Similarly, changing device variables defined only for a specific service will only restart the affected service.

Values defined for individual devices always override those defined for the fleet. Values defined for specific services would override variables defined at the same level (Fleet or device level). So for any given variable, the **device service specific variable** will always have the top priority, followed by the **device variable for all services**, then the **fleet service specific variable**, and finally the **fleet variable for all services**.

Expand All @@ -37,7 +35,7 @@ Define a name and value for your variable. Click the *Add* button to apply the v

<img alt="Add variable" src="/img/variables/variable_editor.png" width="80%">

Your new variable will show up in the list, where it can easily be modified or removed:
Your new variable will show up in the list, where it can easily be modified or removed. Adding or modifying fleet variables will trigger restart of all services on the device.

<img alt="List variables" src="/img/variables/variable_list.png" width="100%">

Expand All @@ -61,6 +59,8 @@ You can override the value of a fleet variable by clicking *override* in the far

<img alt="Add device variable" src="/img/variables/override.png" width="80%">

Changing a variable defined only for a specific service will only restart the affected service.

## Managing with the CLI & SDK

The {{ $names.company.lower }} CLI and SDKs all include methods to easily read, add or update variables. Consult the appropriate reference for code examples.
Expand Down

0 comments on commit 1060853

Please sign in to comment.