Skip to content

Latest commit

 

History

History
122 lines (84 loc) · 7 KB

README.md

File metadata and controls

122 lines (84 loc) · 7 KB

Container registry

This terraform module automates the creation of container registry resources on the azure cloud platform, enabling easier deployment and management of container images.

Goals

The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.

The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.

A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.

A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.

Non-Goals

These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.

They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.

Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.

End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.

Features

  • data replication is possible across different geolocations
  • detailed access control is ensured through scope maps and tokens
  • data protection is enhanced by encryption with user-managed identities
  • multiple task types support docker, encoded, and file-based operations
  • flexible triggers enable scheduled, source, and base image automations
  • dedicated agent pools provide enhanced scalability and isolation
  • network rules allow granular access control and IP restrictions
  • key vault integration enables secure secret management
  • webhook support enables automated notifications and integrations
  • custom cache rules optimize container image delivery
  • immediate task execution is supported through run-now capability
  • platform settings allow customized architecture and OS configurations
  • utilization of terratest for robust validation.
  • integrates seamlessly with private endpoint capabilities for direct and secure connectivity.

Requirements

Name Version
terraform ~> 1.0
azurerm ~> 4.0
random ~> 3.6

Providers

Name Version
azurerm ~> 4.0

Resources

Name Type
azurerm_container_registry.acr resource
azurerm_container_registry_agent_pool.pools resource
azurerm_container_registry_cache_rule.cache resource
azurerm_container_registry_scope_map.scope resource
azurerm_container_registry_token.token resource
azurerm_container_registry_token_password.password resource
azurerm_container_registry_webhook.webhook resource
azurerm_key_vault_secret.secret resource
azurerm_role_assignment.admins resource
azurerm_role_assignment.rol resource
azurerm_user_assigned_identity.mi resource
azurerm_client_config.current data source

Inputs

Name Description Type Default Required
location default azure region to be used. string null no
naming contains naming related configuration map(string) {} no
registry contains container registry related configuration any n/a yes
resource_group default resource group to be used. string null no
tags tags to be added to the resources map(string) {} no

Outputs

Name Description
agentpools contains the agent pools
registry contains container registry related configuration

Testing

For more information, please see our testing guidelines

Notes

Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes.

Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory.

To update the module's documentation run make doc

Authors

Module is maintained by these awesome contributors.

Contributing

We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.

For more information, please see our contribution guidelines.

License

MIT Licensed. See LICENSE for full details.

Reference