update commands in agent 'manual install' path #3594
Conversation
viambot
added
the
safe to build
There was a problem hiding this comment.
Mostly fine, in that it correccts the commands but the one noted issue is that it's not clear this should only be used for offline pre-installs.
Honestly, the manual steps may not even be needed. If the scripted tarball generation isn't enough for a particular client, they can talk to us about why, IMHO. Also, with the unification happening in agent, these instructions will change (and become simpler with only one binary involved) after that releases (monday.)
I'm fine either way though. They've been broken this long and no one else has said anything, so I'm fine with this merging as-is too if you prefer.
docs/how-tos/provision-setup.md
Outdated
| @@ -314,15 +314,15 @@ sudo ./preinstall.sh /path/to/rootfs | |||
| {{< tablestep >}} | |||
| **1. Create and download files** | |||
|
|
|||
| Run the following commands to create directories for the provisioning binaries, then download the binaries and make them executable: | |||
| As root on the target device, run the following commands to create directories for the provisioning binaries, then download the binaries and make them executable: | |||
There was a problem hiding this comment.
So the issue is that these instructions are supposed to be when you're NOT on the target device. This is pre-install to a factory image that's not currently running. On a live device, the normal install script should just be used.
There was a problem hiding this comment.
oh that makes my experience make more sense. this is the manual version of the preinstall flow
I'm guessing these commands are wrong if you're not on the target device bc of abs paths
There was a problem hiding this comment.
So do any of these changes apply?
There was a problem hiding this comment.
nope I'm had the wrong idea, changes don't apply
but I think these would still fail in 'editing an sd card' context because of the mix of abs and relative paths
see discussion below about removing the 'manual install' tab entirely -- @npentrel are you okay with that change?
|
@Otterverse if your call is to remove this 'manual install' path entirely, and only support the preinstall script, I'm for it. I can make that change in this branch |
I think that makes sense. This was orginally deep-dive, last-resort stuff meant for other viam devs trying to understand the provisioning preinstall process. We should instead just focus on improving/fix the script if it ever fails to work for someone (or advanced devs could just read the script to figure out how to do the manual things if they absolutely had to.) |
|
That sounds good to me, I'll make the change |
|
@npentrel thanks, all yours |
npentrel
force-pushed
the
agent-manual-install
branch
from
c68aa94 to
d6797fd
Compare
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3594 |
|
There are some caching issues so providing a screenshot for https://docs-test.viam.dev/3594/how-tos/provision-setup/index.html#install-viam-agent Does this add better context for the script @abe-winter ? |
|
yup makes sense now I think the reason I got it wrong before was that I thought the 'manual install' path was for installing on device not on SD card |
|
I can't approve bc github thinks it's my PR, but LGTM |
|
Ok - thanks both! merging! |
What changed
Why
Ran into trouble when trying it
Manual test
Followed steps in rendered docs on a pi
Questions