AWS deadline-cloud documentation change
Summary
Added disk space warning, build number documentation, and new section on removing packages from channels with specific commands and warnings about production environments
Security assessment
This change adds security-related documentation about package management best practices, including warnings about not removing packages from production channels to prevent environment recreation issues. While it includes security considerations for package integrity and reproducibility, there's no evidence of addressing a specific security vulnerability.
Diff
diff --git a/deadline-cloud/latest/developerguide/build-test-packages-locally.md b/deadline-cloud/latest/developerguide/build-test-packages-locally.md index 64f8dd08d..8967fc563 100644 --- a//deadline-cloud/latest/developerguide/build-test-packages-locally.md +++ b//deadline-cloud/latest/developerguide/build-test-packages-locally.md @@ -5 +5 @@ -PrerequisitesBuilding and publishing a package to a local channelDebugging buildsTesting the packageCleaning up +PrerequisitesBuilding and publishing a package to a local channelDebugging buildsTesting the packageRemoving packages from the channelCleaning up @@ -33,0 +34,4 @@ In this procedure, you clone the Deadline Cloud samples repository and use `ratt +###### 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. + @@ -49 +53,2 @@ On Linux and macOS, run the following command. - --to file://$HOME/my-conda-channel + --to file://$HOME/my-conda-channel \ + --build-number=+1 @@ -54 +59,2 @@ On Windows (cmd), run the following command. - --to file://%USERPROFILE%/my-conda-channel + --to file://%USERPROFILE%/my-conda-channel ^ + --build-number=+1 @@ -71 +77 @@ If your package recipe depends on packages from a particular channel, such as [c -To rebuild the package after making changes to the recipe, add `--build-number=+1` to automatically increment the build number. +###### About build numbers @@ -72,0 +79 @@ To rebuild the package after making changes to the recipe, add `--build-number=+ +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. @@ -74,3 +81 @@ To rebuild the package after making changes to the recipe, add `--build-number=+ - rattler-build publish blender-4.5/recipe/recipe.yaml \ - --to file://$HOME/my-conda-channel \ - --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. @@ -116,0 +122,2 @@ On Windows (cmd), run the following commands. +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. + @@ -121,0 +129,23 @@ When you are satisfied with the package, you can publish the package to an Amazo +## 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 channel directory 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. + +On Linux and macOS, run the following commands. + + + rm $HOME/my-conda-channel/linux-64/blender-4.5.0-hb0f4dca_1.conda + rattler-index fs $HOME/my-conda-channel + +On Windows (cmd), run the following commands. + + + del %USERPROFILE%\my-conda-channel\win-64\blender-4.5.0-hb0f4dca_1.conda + rattler-index fs %USERPROFILE%\my-conda-channel + +Package files are stored in platform-specific subdirectories such as `linux-64`, `win-64`, or `osx-arm64`. List the contents of these subdirectories to find the exact filename of the package you want to remove. +