Registry Management
Overview
A registry configuration in WEDA stores the URL and authentication credentials for an external container registry. WEDA Core encrypts these credentials at rest and securely supplies the required registry settings to WEDA Node during deployment. This allows edge devices to pull images from private registries without requiring credentials to be configured manually on each machine.
WEDA supports four registry types:
| Registry Type | Required credential fields |
|---|---|
| DockerHub | username + accessToken (both required) |
| AzureACR | username + userPassword (both required) |
| AwsECR | region (required); accessKey + accessSecretKey (optional, must be paired) |
| Custom (e.g., Harbor, GitLab CR) | username + userPassword (optional; must be paired if used) |
Operations
| Operation | API | Description |
|---|---|---|
| Create Registry | POST /api/v1/orgs/{orgId}/containers/registries | Create a new registry configuration |
| List Registries | GET /api/v1/orgs/{orgId}/containers/registries | List all registry configurations in an Org |
| Get Registry | GET /api/v1/orgs/{orgId}/containers/registries/{registryId} | Get details of a specific registry |
| Update Registry | PUT /api/v1/orgs/{orgId}/containers/registries/{registryId} | Update an existing registry configuration |
| Delete Registry | DELETE /api/v1/orgs/{orgId}/containers/registries/{registryId} | Delete a registry configuration |
Constraints
registryNameis required, cannot be empty, must be unique within the Org, and has a maximum length of 32 charactersregistryUrlis required and must be a valid HTTP or HTTPS registry URL- Paired credential fields must be provided together — supplying only one field returns a validation error
- For
AwsECR,regionis always required;accessKeyandaccessSecretKeyare optional but must be provided as a pair
Scenario
A developer registers a private Harbor instance before creating Container Stacks for factory devices:
Container Stacks do not directly reference a registryId. Instead, each Compose file identifies images by registry hostname and image path. During deployment, WEDA Core supplies the target Org's registry configurations to WEDA Node so it can authenticate with the registries used by the Stack.
Creating or updating a registry configuration does not automatically re-trigger any active deployments. Devices continue using the registry settings that were current at their last deployment. To pick up new registry settings, either trigger a new deployment manually, or wait for the next scheduled/manual deployment — WEDA Node fetches the current registry configuration at that time.
Related
- Define container workloads that use this registry: Container Stack Management
- Deploy stacks and control running containers: Container Deployment & Commands