AWS deadline-cloud documentation change
Summary
Added documentation about removing packages from S3 channels, updated build number guidance, added disk space warning, and simplified command examples
Security assessment
The changes are primarily operational improvements and clarifications about package management. The addition of package removal instructions could have security implications if misused (removing production packages breaks environments), but there's no evidence this addresses a specific security vulnerability. The build number guidance promotes immutability which enhances integrity but isn't a security fix.
Diff
diff --git a/deadline-cloud/latest/developerguide/publish-packages-s3-channel.md b/deadline-cloud/latest/developerguide/publish-packages-s3-channel.md index 7e7b53321..637c8eeed 100644 --- a//deadline-cloud/latest/developerguide/publish-packages-s3-channel.md +++ b//deadline-cloud/latest/developerguide/publish-packages-s3-channel.md @@ -5 +5 @@ -PrerequisitesPublishing a package to an Amazon S3 channelTesting the packageCleaning upDebugging buildsBuilding packages for other platformsNext steps +PrerequisitesPublishing a package to an Amazon S3 channelTesting the packageRemoving packages from the channelCleaning upDebugging buildsBuilding packages for other platformsNext steps @@ -47,0 +48,4 @@ The following example publishes the Blender 4.5 sample recipe from the [Deadline +###### Note + +Large applications can require tens of GB of free disk space for the source archive, extracted files, and build output. Make sure that you use a disk with enough available space for the package build output. + @@ -60,9 +64 @@ The following example publishes the Blender 4.5 sample recipe from the [Deadline -On Linux and macOS, run the following command. - - rattler-build publish blender-4.5/recipe/recipe.yaml \ - --to s3://amzn-s3-demo-bucket/Conda/Default - -On Windows (cmd), run the following command. - - rattler-build publish blender-4.5/recipe/recipe.yaml ^ - --to s3://amzn-s3-demo-bucket/Conda/Default + rattler-build publish blender-4.5/recipe/recipe.yaml --to s3://amzn-s3-demo-bucket/Conda/Default --build-number=+1 @@ -75 +71 @@ The `/Conda/Default` prefix organizes the channel within the bucket. You can use -To rebuild and publish an updated package, add `--build-number=+1` to automatically increment the build number. +###### About build numbers @@ -76,0 +73 @@ To rebuild and publish an updated package, add `--build-number=+1` to automatica +The `--build-number=+1` option automatically picks the next build number based on what already exists in the destination channel. The best practice is to never overwrite a package in a channel. Always build to a new build number if the package would otherwise have the same filename. Using `--build-number=+1` achieves this when you build to a production channel or a staging channel that mirrors production. @@ -78,3 +75 @@ To rebuild and publish an updated package, add `--build-number=+1` to automatica - rattler-build publish blender-4.5/recipe/recipe.yaml \ - --to s3://amzn-s3-demo-bucket/Conda/Default \ - --build-number=+1 +If you want to control the build number directly, you can set it with a specific value such as `--build-number=7`. If you omit the option, `rattler-build` uses the build number defined in the `recipe.yaml` file. @@ -109,0 +105,19 @@ After you publish the package, create a temporary pixi project to verify that th +The [`pixi run`](https://pixi.sh/latest/reference/cli/pixi/run/) command activates the conda environment for the project directory and runs the specified command within it. The environment persists in the project directory, so you can use the same `pixi run` command from other terminals. + + + + +## Removing packages from the channel + +Avoid removing packages from channels that you use for production, because lockfiles reference specific packages by hash. Removing a package prevents re-creating environments from those lockfiles. For development and testing channels, you can remove a specific package by deleting the `.conda` file from the bucket and then re-indexing the channel. First, install `rattler-index`. + + + pixi global install rattler-index + +Then delete the package file and re-index the channel. Replace `amzn-s3-demo-bucket` with your bucket name. + + + aws s3 rm s3://amzn-s3-demo-bucket/Conda/Default/linux-64/blender-4.5.0-hb0f4dca_1.conda + rattler-index s3 s3://amzn-s3-demo-bucket/Conda/Default + +Package files are stored in platform-specific subdirectories such as `linux-64`, `win-64`, or `osx-arm64`. To list the packages in a subdirectory, run the following command. @@ -111,0 +126 @@ After you publish the package, create a temporary pixi project to verify that th + aws s3 ls s3://amzn-s3-demo-bucket/Conda/Default/linux-64/