Skip to content

DOCS-3950: Change default module version #4312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DOCS-3950: Change default module version #4312

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c1e592
DOCS-3950: Change default module version
JessamyT May 16, 2025
55b87be
Update docs/operate/reference/module-configuration.md
JessamyT May 16, 2025
7eee94e
Update module-configuration.md
JessamyT May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/operate/reference/module-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,8 @@ The model is configured as a component with the name `myRealsenseCamera1`.
{{% /tab %}}
{{< /tabs >}}

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

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

You can configure how each module on your machine updates itself when a newer version becomes available from the Viam Registry.
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_.
By default, a newly-added module is set to pin to the latest release (**Latest**) of the version you added.

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.
To change the update strategy for your module, set the **Pinned version type** for your module in its module card on the **CONFIGURE** tab.

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

The following update options are available:

- **Patch (X.Y.Z)**: Do not update to any other version.
This is the default.
- **Minor (X.Y.\*)**: Only update to newer patch releases of the same minor release branch.
The module will automatically restart and update itself whenever new updates within the same minor release are available in the Viam Registry.
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`.
- **Major (X.\*)**: Only update to newer minor releases of the same major release branch.
The module will automatically restart and update itself whenever new updates within the same major release are available in the Viam Registry.
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`.
- **Latest (`latest`)**: Always update to the latest version of this module available from the Viam Registry as soon as a new version becomes available.
This is the default.
- **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.

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.
Expand Down
Loading