Struct Registry 

pub struct Registry { /* private fields */ }

The main Terraform Provider Registry.

This struct represents a configured Terraform Provider Registry that serves provider packages from GitHub Releases. It implements the complete Terraform Provider Registry Protocol.

Creating a Registry

Use the Registry::builder() method to create a new registry:

let registry = Registry::builder()
    .github_token("ghp_your_token")
    .gpg_signing_key(
        "KEY_ID".to_string(),
        EncodingKey::Pem("public_key".to_string())
    )
    .build()
    .await?;

Creating a Router

Once built, create an Axum router with create_router():

let app = registry.create_router();

Implementations

impl Registry

pub fn builder() -> RegistryBuilder

Creates a new RegistryBuilder for configuring a Registry.

This is the recommended way to create a new Registry instance.

Examples

let registry = Registry::builder()
    .github_token("ghp_token")
    .gpg_signing_key("KEY_ID".to_string(), EncodingKey::Pem("...".to_string()))
    .build()
    .await?;

pub fn create_router(&self) -> Router

Creates an Axum Router configured with this Registry’s routes and state.

The router includes the following endpoints:

• /.well-known/terraform.json - Service discovery
• /{base_url}/{namespace}/{type}/versions - List available provider versions
• /{base_url}/{namespace}/{type}/{version}/download/{os}/{arch} - Download provider package

Tracing

The router includes HTTP tracing middleware that logs all requests and responses at the DEBUG level, including headers.

Examples

let app = registry.create_router();

let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await?;
axum::serve(listener, app).await?;

Trait Implementations

impl Debug for Registry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.