# Google Cloud NCCL Plugins for NGC Containers

## Release Notes
**Version**: 1.1.2
**Architecture**: amd64
This release packages the Google Cloud optimized NCCL plugins (`net`, `profiler`, `env`, and `tuner` where applicable) tailored for deployment within accelerated container environments.

## User Guide (Manual Verification)
To manually enable and benefit from these plugins in your container:
1. Append the library path to your environment:
   `export LD_LIBRARY_PATH=/opt/gcp/nccl-plugins/lib64:$LD_LIBRARY_PATH`
2. Explicitly export the required NCCL environment variables (see Integration below) before running your workload.
3. Validate plugin activation by running standard NCCL tests and verifying output logs for successful `gcp` plugin hooking.

## Integration Instructions for Orchestrators & Entry Points
Upon detecting a Google Cloud (GCP) environment, the container initialization or entry point script should explicitly configure the following:

1. **Library Path**:
   Append `/opt/gcp/nccl-plugins/lib64` to `LD_LIBRARY_PATH`.

2. **Core Environment Variables**:
   Export the following variable to load the GCP environment plugin, which will automatically configure the other necessary plugins (e.g. net, profiler, tuner):

   `export NCCL_ENV_PLUGIN=gcp`

NVIDIA container entry points will automatically apply these environment variables and `LD_LIBRARY_PATH` injection upon detecting it is in a GCP environment.
