Skip to content

Commit ccca75c

Browse files
committed
Update controller/agent documentation to remove certain internal terminology/references.
1 parent 8094328 commit ccca75c

2 files changed

Lines changed: 74 additions & 113 deletions

File tree

website/docs/developing/0021-develop-script-extensions.md

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,56 +3,14 @@ The use of scripting languages (e.g. Python, PowerShell) is a popular choice for
33
on bare metal hardware systems. The Virtual Client platform provides runtime support for running scripts directly from the command line and additionally
44
supports a controller/agent workflow for remote execution through SSH sessions on both Linux and Windows systems.
55

6-
The following document provides a set of general guidelines to consider when developing script-based automation extensions so that they can be readily integrated
7-
into the Virtual Client platform.
8-
9-
## Preliminaries
10-
The following section covers some of the important preliminaries required for executing script-based automation on hardware systems.
11-
12-
### Linux System Setup
13-
This section describes system setup considerations when running on Linux systems.
14-
15-
#### User/Execution Account Requirements
16-
A lot of test automation for hardware systems requires elevated privileges to access parts of the Linux system. This means that the
17-
user accounts in which the automation is running must have the ability to elevate. There are a few ways that this is typically done:
18-
19-
* **Run as "root"**
20-
Whereas this is not generally recommended, the user or execution CAN login as the **root** user. One of the most common use cases involves installing
21-
services/daemons configured to run as the **root** user.
22-
23-
**Run as User Account with Root Privileges**
24-
A more typical scenario is to run under a specific account (e.g. user_admin) that has been configured to have root privileges. The following section describes
25-
how to configure an account to have root privileges.
6+
[Controller/Agent Overview](../guides/0021-controller-agent.md)
267

27-
<mark>Note that commands requiring elevated permissions (e.g. dmidecode -t bios) must be executed using "sudo" so that they
28-
are running with superuser privileges.</mark>
29-
30-
``` bash
31-
# Option 1: Configure a Single User Account
32-
# --------------------------------------------
33-
# With this option, we configure a single user account. Note that you MUST be executing
34-
# the following commands when logged in as the "root" account or with an account that has "root"
35-
# privileges.
36-
37-
# Given there is a user account named "user_admin"...
38-
#
39-
# 1) Provide the account with membership to the "sudo" group
40-
sudo usermod -aG sudo user_admin
41-
42-
# 2a) Add a file to the /etc/sudoers.d directory with the following content. This enables
43-
# the execution of sudo commands without requiring a password. This is very important
44-
# for unattended automation scenarios where there will be no one there to provide it.
45-
#
46-
# Run as "root"
47-
su -
48-
49-
# Create the permissions file. You can name it whatever you like but it is best to
50-
# ensure it is specific to the 1 user account (to allow for other accounts in the future).
51-
echo "user_admin ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/user_admin_permissions
52-
```
8+
The following document provides a set of general guidelines to consider when developing script-based automation extensions so that they can be readily integrated
9+
into the Virtual Client platform.
5310

5411
## Script Extensions Usage
55-
The following sections illustrate how to integrate script packages into the Virtual Client platform for execution via the command line. Whereas the Virtual Client
12+
Before going into the details for script extensions development, it is helpful to have an idea of how they can be used in the
13+
Virtual Client platform. The following sections illustrate how to integrate script packages into the Virtual Client platform for execution via the command line. Whereas the Virtual Client
5614
platform often defines complex workflows using profiles, scripts can be executed directly without the need for a profile. Before getting into design and implementation
5715
recommendations for script-based automation, it is helpful to get a sense of how they will be used in Virtual Client.
5816

0 commit comments

Comments
 (0)