DOCS-2705: Add username and env attributes for processes #3649
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viambot
added
the
safe to build
npentrel
commented
Nov 1, 2024
| | Executable (`name`) | string | **Required** | The command you want to execute when your machine connects to the server. On many operating systems, you can find the executable path of commands by running `which <command-name>`. | | ||
| | Arguments (`args`) | string | Optional | Arguments to follow the command. | | ||
| | Working directory (`cwd`) | string | Optional | Where you want the process to execute. Defaults to the directory where `viam-server` executes. | | ||
| | `username` (not available in builder mode) | string | Optional | Example: `"username": "ubuntu"`. | |
There was a problem hiding this comment.
@zaporter-work I was not able to confirm that the username attribute does anything. My assumption is that it would allow us to run the process as a user?
On my pi I added a process with this config:
{
"env": {
"SVC_API_KEY": "VALUE"
},
"username": "pi",
"id": "process-2",
"name": "python",
"args": [
"username.py"
],
"cwd": "/home/pi",
"log": true,
"one_shot": false
}
and this little python program:
import os
import getpass
import time
while True:
print(1)
print(time.sleep(1))
raise ValueError(getpass.getuser())
I can't see anytihng printed at all and what gets raised always indicates that the process runs as root.
Does username do somethign else?
| | Arguments (`args`) | string | Optional | Arguments to follow the command. | | ||
| | Working directory (`cwd`) | string | Optional | Where you want the process to execute. Defaults to the directory where `viam-server` executes. | | ||
| | `username` (not available in builder mode) | string | Optional | Example: `"username": "ubuntu"`. | | ||
| | `env` (not available in builder mode) | string | Optional | Environment variables for the process. Example: `"environment": { "SVC_API_KEY":"VALUE" }`. | |
There was a problem hiding this comment.
@zaporter-work could you confirm for me how the config for a machine reaches the machine? That's all e2e encrypted right? I think we should probably mention that here.
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3649 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.