Update mentions of viam-provisioning.json to viam-defaults.json by ale7714 · Pull Request #4110 · viamrobotics/docs

ale7714 · 2025-03-20T17:31:48Z

This was part of the recent config migration for the agent. I missed it when we updated the docs.

netlify · 2025-03-20T17:32:09Z

✅ Deploy Preview for viam-docs ready!

Name	Link
🔨 Latest commit	`710fb3e`
🔍 Latest deploy log	https://app.netlify.com/sites/viam-docs/deploys/67ec59ad81fa2500087e627a
😎 Deploy Preview	https://deploy-preview-4110--viam-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 39 (🟢 up 6 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 70 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Otterverse

This isn't sufficient for the changes involved. viam-defaults.json uses the new syntax and field names, including sections, identical to the agent section of the cloud config (though version_control section is ignored and shouldn't be included since that can only affect cloud-side App behavior.)

Meanwhile, the old viam-provisioning.json uses the OLD field names, and only a subset of them, mostly from what is now the network_configuration section.

So simply renaming the file in the docs will break things (putting the new format in the old file name/location.)

EDIT: Also, for the preinstall.sh usage, that script itself needs to be updated. Ticketed here: https://viam.atlassian.net/browse/APP-7902

ale7714 · 2025-03-20T20:53:30Z

@Otterverse good catch updated both docs here and the preinstall script

npentrel · 2025-03-21T16:23:16Z

Ok, so we'll have to continue documenting both for the time being I think. @ale7714 I can take over on that front and finish this next week if you want

ale7714 · 2025-03-21T23:25:58Z

I think that the PR to update the preinstall script is merged viamrobotics/agent#86. This can also be merged.

npentrel · 2025-03-24T14:51:20Z

If I understand James correctly @ale7714 we may need to keep the docs for the old way as well

npentrel · 2025-03-24T15:01:31Z

@Otterverse does dd62b4a address your feedback?

Otterverse

@npentrel Sorry I didn't get to this yesterday when I first got back. Still some fixes needed IMHO.

Otterverse · 2025-03-27T15:18:06Z

+    "hotspot_prefix": "<PREFIX>", # machine creates a hotspot during setup
+    "disable_captive_portal_redirect": false, # set to true if using a mobile app
+    "hotspot_password": "<PASSWORD>", # password for the hotspot
+    "networks" : []


The networks section isn't part of network_configuration.

Otterverse · 2025-03-27T15:21:51Z

+    "user_idle_minutes": "2m30s",
+    "retry_connection_timeout_minutes": "15m",
+    "turn_on_hotspot_if_wifi_has_no_internet": true,
+    "networks": [


There's no "networks" in network_configuration. There's a separate section for "additional_networks" and the format is now an object, not an array. Again, may be easier to just point to the main configuration page, as viam-defaults.json basically takes the exact same layout/format as the cloud config.

Otterverse · 2025-03-27T15:22:30Z

 | -------- | ----------- |
 | `VIAM_JSON_PATH` | The path to the machine credentials <FILE>viam.json</FILE> file to be copied to the machine. The script will also prompt you for this file if not provided. |
-| `PROVISIONING_PATH` | The path to the <FILE>viam-provisioning.json</FILE> file. The script will also prompt you for this file if not provided. |
+| `PROVISIONING_PATH` | The path to the <FILE>viam-defaults.json</FILE> file. The script will also prompt you for this file if not provided. |


This is called "DEFAULTS_PATH" now I believe, though I'm not sure if the changes to preinstall.sh with the new path were published publicly yet.

Otterverse · 2025-03-27T15:24:37Z

+    "offline_before_starting_hotspot_minutes": "3m30s",
+    "user_idle_minutes": "2m30s",
+    "retry_connection_timeout_minutes": "15m",
+    "turn_on_hotspot_if_wifi_has_no_internet": true,


This is mentioned as being "required" for additional_networks to work in lots of text body above/around this. That's not the case. It changes behavior, but it's not required.

Also, that other text should (most likely) be removed. We should really discourage people from adding additional_networks in the defaults file.

Otterverse · 2025-03-27T15:27:21Z

There are a lot of references to agent-provisioning which is no longer an actual thing. There is the Agent, which has a provisioning functionality, but no longer any seperate subsystem called "agent-provisioning."

Ok changing

Otterverse · 2025-03-27T15:35:40Z

 1. When you power on the machine that has `viam-agent` installed and `agent-provisioning` configured, `viam-agent` creates a WiFi hotspot.

-   - The [`agent-provisioning` configuration](/manage/fleet/provision/setup/#configure-agent-provisioning) is at <file>/etc/viam-provisioning.json</file> on your machine.
+   - The [`agent-provisioning` configuration](/manage/fleet/provision/setup/#configure-agent-provisioning) is at <file>/etc/viam-defaults.json</file> on your machine.


This isn't just the "agent-provisioning" config. As noted above, there is no longer anything specifically called "agent-provisioning." The defaults file is also not JUST for provisioning. It can be used to set ANY configuration value for agent to a preferred/custom default. Not sure if documentation explaining that belongs on this page or elsewhere though.

Otterverse · 2025-03-27T15:38:23Z

+{{% changelog color="changed" title="Viam provisioning filename" date="2025-03-24" %}}
+
+When provisioning devices, the configuration file for provisioning is now called <FILE>viam-defaults.json</FILE> and uses different syntax and field names. The old <FILE>viam-provisioning.json</FILE> is still required for older versions of `viam-agent`.


I'm not certain exactly how this should be phrased, but this isn't JUST a filename change. The new viam-defaults.json file allows setting ANY agent config values to customized defaults. So while it should now be used instead of the old, more limited viam-provisioning.json, it's not just a direct replacement.

ale7714 · 2025-03-27T21:05:23Z

I'm gonna close this for now, my plate is pretty full. I was hoping we could fina more minimal change that would get people to stop using provisioning.json but it sounds like we maybe need a more complete update.

npentrel · 2025-03-31T10:09:37Z

Hey @ale7714 that's fine - I'm going to make the changes James suggested on this branch and see how far I get. You don't need to work on this further!

npentrel · 2025-03-31T12:05:30Z

-{{< alert title="Important" color="note" >}}
-You must enable `turn_on_hotspot_if_wifi_has_no_internet` in the [`agent-provisioning` configuration](/manage/fleet/provision/setup/#configure-agent-provisioning) of the machine to allow the machine to connect to the specified networks after provisioning.
-{{< /alert >}}


@Otterverse can you just reconfirm that the note about turn_on_hotspot_if_wifi_has_no_internet can be removed? I was under the impression this was crucial

It's not required, but it changes the criteria for a connection being "good enough." If the ONLY connection that works is an additional network, and it provides full internet, then it'll work without the setting. But if the "primary" network is available, (but doesn't provide internet) then it'll prefer that one, and consider it "good enough" even without internet. So it won't "try all networks until it gets internet" in that situation.

Otterverse · 2025-03-31T22:42:19Z

+    "retry_connection_timeout_minutes": "15m",
+    "turn_on_hotspot_if_wifi_has_no_internet": true
+  },
+  "additional_networks": [


Additional_networks is an object, not an array. Networks have to have a field name/label. I can't make the actual suggested change as the lines below aren't part of the diff, but it looks something like:

"additional_networks": { "testNet": { "priority": 30, "psk": "myFirstPassword", "ssid": "otherNetworkOne", "type": "wifi" } }

Otterverse · 2025-03-31T22:44:18Z

 | -------- | ----------- |
 | `VIAM_JSON_PATH` | The path to the machine credentials <FILE>viam.json</FILE> file to be copied to the machine. The script will also prompt you for this file if not provided. |
-| `PROVISIONING_PATH` | The path to the <FILE>viam-provisioning.json</FILE> file. The script will also prompt you for this file if not provided. |
+| `DEFAULTS_PATH ` | The path to the <FILE>viam-defaults.json</FILE> file. The script will also prompt you for this file if not provided. |


As I was worried about before, the version of the preinstall script with this change made wasn't yet uploaded. I've uploaded it now, so we should be good.

Co-authored-by: James Otting <james@viam.com>

Otterverse

Thanks for the extra fixes here. LGTM!

github-actions · 2025-04-01T21:30:24Z

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)'

ale7714 · 2025-04-02T17:23:55Z

Thank you for picking this up Naomi 🙏

Update mentions of viam-provisioning.json to viam-defaults.json

f3d8b53

This was part of the recent config migration for the agent. I missed it when we updated the docs.

ale7714 requested review from Otterverse and npentrel March 20, 2025 17:31

viambot added the safe to build This pull request is marked safe to build from a trusted zone label Mar 20, 2025

npentrel approved these changes Mar 20, 2025

View reviewed changes

Otterverse suggested changes Mar 20, 2025

View reviewed changes

Fix provisioning config file name

b152c5b

ale7714 force-pushed the ale7714-patch-provisioning-config-file branch from 3cfbaae to b152c5b Compare March 20, 2025 20:52

Add old viam-provisioning info to changelog

dd62b4a

Otterverse suggested changes Mar 27, 2025

View reviewed changes

ale7714 closed this Mar 27, 2025

npentrel reopened this Mar 31, 2025

npentrel reviewed Mar 31, 2025

View reviewed changes

Comment thread docs/dev/reference/changelog.md Outdated

npentrel added 3 commits March 31, 2025 12:13

Update docs/dev/reference/changelog.md

9fcc5d2

Update setup.md

5fa85af

Update setup.md

de807cc

npentrel reviewed Mar 31, 2025

View reviewed changes

Comment thread docs/manage/fleet/provision/setup.md Outdated

Update docs/manage/fleet/provision/setup.md

67ee6e0

npentrel reviewed Mar 31, 2025

View reviewed changes

Comment thread docs/manage/fleet/provision/setup.md Outdated

npentrel reviewed Mar 31, 2025

View reviewed changes

Comment thread docs/manage/fleet/provision/setup.md Outdated

Update cotnent

1a8909f

npentrel force-pushed the ale7714-patch-provisioning-config-file branch from d8b3b36 to 1a8909f Compare March 31, 2025 12:04

npentrel reviewed Mar 31, 2025

View reviewed changes

npentrel requested a review from Otterverse March 31, 2025 12:05

Otterverse suggested changes Mar 31, 2025

View reviewed changes

npentrel and others added 2 commits April 1, 2025 22:01

Update docs/manage/reference/viam-agent/_index.md

4ec38b0

Co-authored-by: James Otting <james@viam.com>

Update setup.md

0c16552

npentrel requested a review from Otterverse April 1, 2025 20:03

Otterverse approved these changes Apr 1, 2025

View reviewed changes

Merge branch 'main' into ale7714-patch-provisioning-config-file

00cd771

npentrel reviewed Apr 1, 2025

View reviewed changes

Comment thread docs/manage/fleet/provision/setup.md Outdated

Update docs/manage/fleet/provision/setup.md

325cdfa

npentrel reviewed Apr 1, 2025

View reviewed changes

Comment thread docs/manage/fleet/provision/setup.md Outdated

Update docs/manage/fleet/provision/setup.md

feb81aa

npentrel reviewed Apr 1, 2025

View reviewed changes

Comment thread docs/dev/reference/changelog.md Outdated

npentrel reviewed Apr 1, 2025

View reviewed changes

Comment thread docs/manage/reference/viam-agent/_index.md Outdated

npentrel reviewed Apr 1, 2025

View reviewed changes

Comment thread docs/manage/fleet/provision/setup.md Outdated

Apply suggestions from code review

710fb3e

npentrel merged commit 42e4713 into main Apr 1, 2025
13 checks passed

npentrel deleted the ale7714-patch-provisioning-config-file branch April 1, 2025 21:29

		{{% changelog color="changed" title="Viam provisioning filename" date="2025-03-24" %}}

		When provisioning devices, the configuration file for provisioning is now called <FILE>viam-defaults.json</FILE> and uses different syntax and field names. The old <FILE>viam-provisioning.json</FILE> is still required for older versions of `viam-agent`.

Conversation

ale7714 commented Mar 20, 2025

Uh oh!

netlify Bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for viam-docs ready!

Uh oh!

Otterverse left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ale7714 commented Mar 20, 2025

Uh oh!

npentrel commented Mar 21, 2025

Uh oh!

ale7714 commented Mar 21, 2025

Uh oh!

npentrel commented Mar 24, 2025

Uh oh!

npentrel commented Mar 24, 2025

Uh oh!

Otterverse left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ale7714 commented Mar 27, 2025

Uh oh!

npentrel commented Mar 31, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Otterverse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2025

Uh oh!

ale7714 commented Apr 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify Bot commented Mar 20, 2025 •

edited

Loading

Otterverse left a comment •

edited

Loading