You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/developing/0021-develop-script-extensions.md
+5-47Lines changed: 5 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,56 +3,14 @@ The use of scripting languages (e.g. Python, PowerShell) is a popular choice for
3
3
on bare metal hardware systems. The Virtual Client platform provides runtime support for running scripts directly from the command line and additionally
4
4
supports a controller/agent workflow for remote execution through SSH sessions on both Linux and Windows systems.
5
5
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.
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.
53
10
54
11
## 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
56
14
platform often defines complex workflows using profiles, scripts can be executed directly without the need for a profile. Before getting into design and implementation
57
15
recommendations for script-based automation, it is helpful to get a sense of how they will be used in Virtual Client.
0 commit comments