Skip to content

Commit 9904850

Browse files
authored
DOCS-3950: Change default module version (#4312)
1 parent 0a12705 commit 9904850

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/operate/reference/module-configuration.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,8 @@ The model is configured as a component with the name `myRealsenseCamera1`.
184184
{{% /tab %}}
185185
{{< /tabs >}}
186186

187-
The following properties are configurable for each module:
187+
The following properties are configurable for each module.
188+
You can add and edit `env` by switching from **Builder** to **JSON** mode in the **CONFIGURE** tab.
188189

189190
<!--prettier-ignore-->
190191
| Name | Type | Required? | Description |
@@ -198,23 +199,23 @@ The following properties are configurable for each module:
198199
#### Module versioning
199200

200201
You can configure how each module on your machine updates itself when a newer version becomes available from the Viam Registry.
201-
By default, a newly-added module is set to pin to the specific patch release (**Patch (X.Y.Z)**) of the version you added, meaning that the module will _never automatically update itself_.
202+
By default, a newly-added module is set to pin to the latest release (**Latest**) of the version you added.
202203

203-
To allow automatic module updates when a new version of the module becomes available in the Viam Registry, set the **Pinned version type** for your module in its module card on the **CONFIGURE** tab.
204+
To change the update strategy for your module, set the **Pinned version type** for your module in its module card on the **CONFIGURE** tab.
204205

205206
{{<imgproc src="registry/modular-resources/deployed-module-with-component.png" style="width: 400px" resize="500x" declaredimensions=true alt="The module card" class="shadow" >}}
206207

207208
The following update options are available:
208209

209210
- **Patch (X.Y.Z)**: Do not update to any other version.
210-
This is the default.
211211
- **Minor (X.Y.\*)**: Only update to newer patch releases of the same minor release branch.
212212
The module will automatically restart and update itself whenever new updates within the same minor release are available in the Viam Registry.
213213
For example, use this option to permit a module with version `1.2.3` to update to version `1.2.4` or `1.2.5` but not `1.3.0` or `2.0.0`.
214214
- **Major (X.\*)**: Only update to newer minor releases of the same major release branch.
215215
The module will automatically restart and update itself whenever new updates within the same major release are available in the Viam Registry.
216216
For example, use this option to permit a module with version `1.2.3` to update to version `1.2.4` or `1.3.0` but not `2.0.0` or `3.0.0`.
217217
- **Latest (`latest`)**: Always update to the latest version of this module available from the Viam Registry as soon as a new version becomes available.
218+
This is the default.
218219
- **Latest with prerelease (`latest-with-prerelease`)**: Always update to the latest release or prerelease version of this module available from the Viam Registry as soon as the new version becomes available.
219220

220221
When using the **Patch (X.Y.Z)** version type, you may select any patch version of the module from the **Version** dropdown menu, including past versions if desired.

0 commit comments

Comments
 (0)