AWS deadline-cloud documentation change
Summary
Updated terminology from 'admin scripts' to 'host configuration scripts', clarified elevated privileges (sudo/Administrator), added troubleshooting tip for testing, and improved log monitoring instructions.
Security assessment
The changes reinforce security responsibilities by emphasizing that scripts run with elevated privileges and users must ensure scripts don't introduce security issues. However, there's no evidence of addressing a specific vulnerability.
Diff
diff --git a/deadline-cloud/latest/developerguide/smf-admin.md b/deadline-cloud/latest/developerguide/smf-admin.md index 275cd991d..078bcd9e7 100644 --- a//deadline-cloud/latest/developerguide/smf-admin.md +++ b//deadline-cloud/latest/developerguide/smf-admin.md @@ -7 +7 @@ Troubleshooting -# Run scripts as an administrator to configure workers +# Run host configuration scripts with administrator privileges @@ -9 +9 @@ Troubleshooting -Custom fleet host configuration scripts allow you to perform administrative tasks, such as software installation, on your service-managed fleet workers. These scripts run with elevated privileges, giving you the flexibility to configure your workers for your system. +Host configuration scripts allow you to perform administrative tasks, such as software installation, on your service-managed fleet workers. These scripts run with elevated privileges (`sudo` on Linux, Administrator on Windows), giving you the flexibility to configure your workers for your system. @@ -15 +15 @@ Deadline Cloud runs the script after the worker enters the `STARTING` state and -The script runs with elevated permissions, `sudo` on Linux systems and 'Administrator' on Windows systems. It is your responsibility to ensure that the script does not introduce any security issues. +The script runs with elevated permissions. It is your responsibility to ensure that the script does not introduce any security issues. @@ -17 +17 @@ The script runs with elevated permissions, `sudo` on Linux systems and 'Administ -When you use an admin script you are responsible for monitoring the health of your fleet. +When you use a host configuration script you are responsible for monitoring the health of your fleet. @@ -19 +19 @@ When you use an admin script you are responsible for monitoring the health of yo -Common uses for the script include: +Common uses for host configuration scripts include: @@ -125 +125 @@ Use the following PowerShell script to show that a script is running with Admini -## Troubleshooting host configuration scripts +## Troubleshoot host configuration scripts @@ -150,0 +151,4 @@ To monitor the script: +###### Tip + +When testing host configuration scripts, set the fleet's maximum worker count to 1 to avoid starting multiple workers while iterating on the script. + @@ -157,3 +161 @@ Important notes: -Within that log group is a stream of - - worker-ZZZZZ +Within that log group, look for a stream named `worker-`ZZZZZ``. @@ -166 +168 @@ Within that log group is a stream of -### Monitoring host configuration script execution +### Monitor host configuration script execution @@ -168 +170 @@ Within that log group is a stream of -With Admin scripts to configure workers, you can take full control of a Deadline Cloud worker. You can install any software package, reconfigure operating system parameters, or mount shared file systems. With this advanced feature and Deadline Cloud's capability to scale to thousands of workers, you can now monitor when configuration scripts are executed successfully or failed. Failure causes may include script errors, flaky behavior, or other unknown situations. +With host configuration scripts, you can take full control of a Deadline Cloud worker. You can install any software package, reconfigure operating system parameters, or mount shared file systems. With this advanced feature and Deadline Cloud's capability to scale to thousands of workers, you can monitor when configuration scripts are executed successfully or failed. @@ -252 +254 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Service-managed fleets +Test your package with a Maya render job @@ -254 +256 @@ Service-managed fleets -Connect VPC resources to your SMF +Using software licenses