AWS deadline-cloud documentation change
Summary
Added new section on initializing or reindexing channels and updated package removal instructions to reference the new reindexing section
Security assessment
This change adds operational documentation for channel management in Deadline Cloud, including how to initialize empty channels and reindex channels. These are routine operational procedures with no security implications mentioned. The changes are about package management workflows, not security features or vulnerabilities.
Diff
diff --git a/deadline-cloud/latest/developerguide/publish-packages-s3-channel.md b/deadline-cloud/latest/developerguide/publish-packages-s3-channel.md index 3b6633554..5cc9da3bb 100644 --- a//deadline-cloud/latest/developerguide/publish-packages-s3-channel.md +++ b//deadline-cloud/latest/developerguide/publish-packages-s3-channel.md @@ -7 +7 @@ -PrerequisitesPublishing a package to an Amazon S3 channelTesting the packageRemoving packages from the channelCleaning upDebugging buildsBuilding packages for other platformsNext steps +PrerequisitesPublishing a package to an Amazon S3 channelInitializing or reindexing a channelTesting the packageRemoving packages from the channelCleaning upDebugging buildsBuilding packages for other platformsNext steps @@ -86,0 +87,35 @@ You can also publish a package file that you already built, for example, a `.con +## Initializing or reindexing a channel + +When you use `rattler-build publish` to publish a package, the command initializes the channel automatically if the channel does not already exist. In most cases, you don't need to initialize or reindex the channel manually. + +You might need to manually initialize or reindex a channel in the following situations: + + * You want to create an empty channel before publishing any packages, for example, to verify that your Deadline Cloud queue environment can connect to the channel. + + * You uploaded or deleted `.conda` files directly with Amazon S3 tools instead of using `rattler-build publish`, and the channel index is out of date. + + + + +### Initializing an empty channel + +To initialize an empty channel, create a `repodata.json` file and upload it to the `noarch` subdirectory of the channel prefix. Replace `amzn-s3-demo-bucket` with your bucket name. + + + echo '{"info":{"subdir":"noarch"},"packages":{},"packages.conda":{},"removed":[],"repodata_version":1}' > empty_channel_repodata.json + aws s3api put-object --body empty_channel_repodata.json --key Conda/Default/noarch/repodata.json --bucket amzn-s3-demo-bucket + +The `/Conda/Default` prefix must match the channel prefix that your queue environment uses. After you initialize the channel, you can publish packages to the channel by using `rattler-build publish`. + +### Reindexing a channel + +If the channel index is out of date, use `rattler-index` to rebuild the index from the package files in the channel. First, install `rattler-index`. + + + pixi global install rattler-index + +Then reindex the channel. Replace `amzn-s3-demo-bucket` with your bucket name. + + + rattler-index s3 s3://amzn-s3-demo-bucket/Conda/Default + @@ -114,4 +149 @@ The [`pixi run`](https://pixi.sh/latest/reference/cli/pixi/run/) command activat -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 +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 reindexing the channel. @@ -119 +151 @@ Avoid removing packages from channels that you use for production, because lockf -Then delete the package file and re-index the channel. Replace `amzn-s3-demo-bucket` with your bucket name. +Delete the package file and then reindex the channel. Replace `amzn-s3-demo-bucket` with your bucket name. @@ -123 +155,2 @@ Then delete the package file and re-index the channel. Replace `amzn-s3-demo-buc - rattler-index s3 s3://amzn-s3-demo-bucket/Conda/Default + +After you delete the file, reindex the channel to update the channel metadata. For instructions, see Reindexing a channel.