Introducing Automatic API Docs in Private Registry

Pulumi IDP Team — Wed, 27 Aug 2025 00:00:05 -0600

Building and maintaining reusable infrastructure has always been about more than just writing good code. It’s about making that code discoverable, understandable, and easy to adopt across your organization. Today, we’re excited to announce a new feature that removes significant friction from sharing and consuming infrastructure components: automatic multi-language API documentation in Pulumi Private Registry.

Platform teams invest significant effort in creating reusable infrastructure components. But creating the infrastructure is only half the battle. The real challenge comes in making these resources discoverable and usable by development teams across the organization.

Until now, platform teams publishing components faced a discovery challenge. While developers get excellent IDE support with autocomplete once they’re coding, teams first need to know what components exist, understand their capabilities, and evaluate which one fits their needs. Without browsable API documentation in the registry, developers couldn’t easily discover available components or compare versions. Security and compliance teams lacked visibility into what infrastructure patterns were being shared. And platform teams had no central place to showcase their catalog of approved, battle-tested components that encode organizational best practices.

From Code to Comprehensive Docs

Starting today, whenever you publish a component to your Pulumi private registry, whether it’s a brand new component or an updated version, Pulumi automatically generates comprehensive API documentation for all of the component’s resources.

How It Works

When you run pulumi package publish for your component, we analyze your component’s structure, inputs, outputs, and resources to generate rich, interactive API documentation. This documentation is immediately available in your private registry, formatted consistently across all Pulumi-supported languages.

Multi-Language Support Out of the Box

One of Pulumi’s core strengths is our multi-language components: write once in your preferred language, and teams can consume the component in Python, TypeScript, Go, C#, Java, or YAML. The automatic documentation generation embraces this philosophy.

When you publish a component written in Python, developers using TypeScript can view the TypeScript-specific documentation. The same component shows Go developers idiomatic Go code. This language-specific documentation removes the last barrier to cross-team component adoption.

Improving Discoverability and Adoption

With automatic API documentation, your private registry transforms from a simple package repository into a comprehensive catalog. Developers can:

Browse available components and immediately understand their purpose and usage
See all available configuration options with type information
Evaluate what infrastructure each component provisions before choosing to adopt it

This dramatically reduces the time from component discovery to successful deployment, accelerating your organization’s infrastructure velocity.

Getting Started

Automatic API docs are available today for all Pulumi Cloud customers with access to private registry. To start generating docs, simply publish your component. Documentation generation happens automatically with no configuration required, and docs will automatically appear for existing components.

Looking Ahead

Automatic API docs represent our continued investment in making Pulumi the most productive platform for infrastructure teams. By removing friction from the component lifecycle, we’re enabling platform teams to focus on what matters most: building robust, secure, and scalable infrastructure patterns that accelerate their entire organization.

We’re excited to see how teams use them to build more effective internal developer platforms. As always, we’d love to hear your feedback and learn about your use cases on our Pulumi Cloud requests repository.

Ready to streamline your infrastructure development workflow? Get started with Pulumi Cloud or check out our IDP documentation to learn more about building with components and workflows.

Pulumi Private Registry: The Source of Truth for Golden Paths

Pulumi IDP Team — Wed, 07 May 2025 00:00:00 +0000

As part of the Pulumi IDP announcement at PulumiUP, we introduced the Pulumi Private Registry. For years, we’ve worked with organizations that have built their own internal developer platforms on top of Pulumi. During that time, we identified what we believe is the best method for creating flexible golden paths – a bottom-up approach that utilizes a central source of truth to drive golden paths. Thanks to Pulumi Private Registry, this approach has never been simpler.

Codified Security and Compliance

Platform teams use Pulumi’s components and templates to standardize how resources and programs are shaped and provisioned. They use Pulumi ESC to automatically import secret dependencies and lease short-term credentials. They incorporate Pulumi CrossGuard policy as code to ensure that provisioned infrastructure remains compliant even when customized by developers. Publishing and consuming packages through the private registry guarantees platform teams can achieve the consistency, security, and compliance their business needs without sacrificing the flexibility their developers need.

Streamlined Publishing

The CLI publishing workflow prioritizes ergonomics, making it easy to use. Publishing a package is as simple as running a single CLI command, ensuring seamless integration in local or automated workflows. It supports publishing packages from public or private git repositories, package versioning, multiple organizations, and custom README paths.

Simplified Discovery

Once published, developers can discover standardized and compliant components and templates from a developer-friendly, centralized location – helping teams streamline infrastructure provisioning and avoid shadow workflows. Developers also get immediate context thanks to automatically generated API docs and READMEs.

Free Day 2 Context

Day 2 operations – maintaining, extending, and decommissioning infrastructure – comprise the bulk of the infrastructure lifecycle effort. Yet these tasks often feel like flying blind. Pulumi IDP takes a bottom-up approach, driving building block publishing, discovery, and consumption through the Private Registry. This also provides usage insights out of the box, enabling platform engineers to see where components are used and which versions are in play, making it easier to plan upgrades and safely decommission outdated packages.

Get Started Today

Pulumi IDP, including the Pulumi Private Registry, is now available in Public Preview for all users. Sign up for a free account to get started, learn more about Pulumi IDP, or start publishing packages to your private registry.

Pulumi Blog: Private registry