-
Notifications
You must be signed in to change notification settings - Fork 258
Pulumi Platform Security Whitepaper #16811
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Documentation ReviewThank you for updating the Pulumi Platform Security Whitepaper! This is a comprehensive document that provides detailed technical information about the platform's security architecture. I've reviewed the changes and have some feedback on style and content. Critical Issues1. Missing comma on line 47 The sentence "In fully managed cloud deployments the platform is deployed..." is missing a comma after the introductory phrase. 2. Missing article on line 403 Line 403: "demonstrates mature approach" should be "demonstrates a mature approach" Style and Clarity Concerns3. Overly complex sentence structure throughout While this is a technical whitepaper, many sentences are extremely long and complex, making them difficult to parse. The Google Developer Documentation Style Guide (which this repo falls back to) recommends shorter, clearer sentences. Several examples:
Consider breaking these into shorter, more digestible sentences. For example, lines 10-13 could be split: 4. Inconsistent terminology: "application programming interface" vs "API" Throughout the document, you spell out "application programming interface" in full rather than using the widely-known acronym "API". This makes the text unnecessarily verbose. Lines 26, 52, 60, 66, 116, etc. all use the full form. Per the style guide, widely known acronyms like API don't need expansion. Consider using "API" throughout for better readability. 5. Passive voice usage Several sections use passive voice when active voice would be clearer:
Per the documentation style guide, avoid passive voice for clarity. 6. Meta description length Line 3: The meta description "A whitepaper of security topics and how they relate to the Pulumi Platform." could be more descriptive and SEO-friendly. Consider: "Technical whitepaper covering Pulumi platform architecture, cryptographic security, operational commitments, and SOC 2 Type II compliance." 7. Missing trailing newline The file should end with a trailing newline after line 411 (per AGENTS.md requirement that all new files end with a newline). Content Observations8. Update date accuracy Line 6 states "Last updated: December 2025" - please verify this is the intended date. At the time of this review, it's December 2025, so this appears correct if the intent is to reflect when this version was finalized. 9. Index page updates The changes to content/security/_index.md look good. The updated language is more concise and the link now points to the markdown version rather than the PDF. 10. Moved file handling The PR shows that pulumi-cloud-security-whitepaper.pdf is being deleted (0 additions/deletions). Per AGENTS.md requirements for moved/deleted files:
SummaryThis is a thorough and well-structured security whitepaper. The main issues are:
The content itself is comprehensive and appropriate for the technical/security audience. Once the style issues are addressed, this will be an excellent resource for customers evaluating Pulumi's security posture. Mention me (@claude) if you'd like me to help with any edits or if you want additional review after making changes! |
|
Your site preview for commit 8fb53ff is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-8fb53fff.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit a4caf00 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-a4caf009.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit fded8ba is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-fded8bae.s3-website.us-west-2.amazonaws.com. |
tehsis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Content looks great, I'd approve it grammatically but might need a review from someone with more experience 👍 good job!
Documentation ReviewI've reviewed PR #16811 which adds an updated security whitepaper as markdown content. Overall, the content is well-structured and comprehensive. Here are my findings: ✅ Strengths
Issues Found1. Grammar: Missing article (line 25)Line 25 has awkward phrasing: Should be: Or better yet, simplify: 2. Inconsistent terminology (throughout document)The document switches between "Pulumi Cloud platform," "the platform," "Pulumi platform," and "Pulumi Cloud." For consistency and clarity, I recommend:
This is particularly noticeable in:
3. Index page update needed (content/security/_index.md:12)The link text on the index page needs updating for clarity: Should specify that it's now an embedded page, not a PDF: (Minor: removed "please" for conciseness per style guide preference for direct language) 4. SCSS change not explained (theme/src/scss/_code.scss:50)The diff shows a change to line 50 in the SCSS file, but the change isn't visible in the diff output. This change should be verified and explained in the PR description or commit message if it's intentional. 5. PDF file handlingThe PR shows the PDF file in the files list but with 0 additions/deletions. Please clarify:
Per AGENTS.md, when files are deleted or moved, redirects should be created. If users have bookmarked Recommendations
Style Compliance✅ Proper heading hierarchy (H1 in title, H2+ in sentence case) Great work on converting this important document to markdown format! The embedded approach will make it easier to maintain and update. If you'd like me to help with any of the suggestions above or need additional review after making changes, feel free to mention me (@claude). |
|
Your site preview for commit f80346f is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-f80346f1.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 1045f9b is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-1045f9bb.s3-website.us-west-2.amazonaws.com. |
| storage resources are further isolated in dedicated network zones. Restrictive access controls allow only | ||
| authorized application connections. | ||
|
|
||
| In fully managed cloud deployments, the platform is deployed into distinct cloud provider tenants and virtual private |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just making sure - fully managed cloud deployments means the Pulumi Cloud PaaS as deployed by Pulumi in our internal AWS account? distinct cloud provider tenants means for ex. AWS accounts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exactly. Yes the idea is to give a more high level view of the overall platform without mentioning exact implementation/deployment details.
| The platform's API service forms the central hub for all platform operations, handling authentication, authorization, | ||
| resource management, and coordinating with specialized subsystems. This service maintains the primary data model | ||
| representing organizations, projects, stacks, deployment history, and configuration state. It implements comprehensive | ||
| role-based access control ensuring that all operations respect organizational access policies and user permissions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
on Friday it will include attribute based access I think? but we can update this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes as this is now available as markdown it will be much easier to update it accordingly.
| maintain visibility into their infrastructure posture and enforce governance requirements across their cloud | ||
| environments. | ||
|
|
||
| Workflow integration provides continuous deployment capabilities by connecting to source control systems and executing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Workflow integration refers to the Deployments platform feature, yes? Should we be explicit about that, or are we being more general on purpose? I kind of prefer workflow integration as a feature name personally, but that is not what it is called now, and it is a little confusing since you also mention Deployment Orchestration above, which I think just refers to running core pulumi operations like update without Deployment runners.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that's confusing. I merged the Deployment orchestration and Workflow integration sections. So this should basically represent the architecture of the whole Deployments feature.
| infrastructure operations in response to repository events. A pool management component maintains a fleet of execution | ||
| environments that can be rapidly allocated to handle workflow jobs. These environments are pre-configured with necessary | ||
| tooling and credentials, reducing job startup latency while maintaining isolation between executions. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mention AI-powered assistance in the diagram above - is that not a core feature?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is :) Added a paragraph.
| history, and access control policies resides in a managed relational database service. The platform deploys the database | ||
| in a highly available configuration with automatic failover capabilities and read replicas to scale query workloads. | ||
|
|
||
| All connections to the database utilize transport layer security with enforced minimum protocol versions. The platform |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what does provider-managed mean in the context of encryption services?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provider managed means that the provider of the platform needs to maintain an encryption service which is responsible to encrypt data at rest. In case of Pulumi Cloud we are the provider and we are using AWS KMS to encrypt data at rest. This might defer for self-hosted installations.
| ### Client Architecture | ||
|
|
||
| The command-line interface provides the primary user interface for interacting with infrastructure as code. The client | ||
| implements a plugin-based architecture where resource providers are loaded dynamically based on the resources defined in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think command-line interface and the client are both referring to the CLI but the client is an overloaded enough term that I had to read this twice
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed and changed
| decrypt protected content. | ||
|
|
||
| The third tier consists of the encrypted content itself, which includes user secrets, configuration values, and other | ||
| sensitive data. Each piece of content is encrypted using a data encryption key and a randomly generated initialization |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the randomly generated initialization vector is a cool detail
|
In general this version seems like it is going for a more cloud service agnostic description than the previous one, which could be valuable as a additional layer of description, but without the specific service implementation details, it makes it seem like we might be hiding the actual implementation on purpose, which seems counter to the intent of a security whitepaper, where we are trying to build confidence by being transparent. I also miss the color diagrams of the cloud architecture with specific AWS services from the previous version. |
Regarding the level of detail I have updated the PR description.
|
|
Your site preview for commit 12941dd is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16811-12941dd9.s3-website.us-west-2.amazonaws.com. |
This PR adds an updated version of the Pulumi platform security whitepaper. We are now embedding the whitepaper as markdown into the website directly instead of having a separate pdf.
The level of detail is intentionally kept at a high level. Instead of describing specific technologies or deployment configurations, the focus is on presenting a holistic view of the platform. This includes explaining how the different components interact with each other and outlining the security measures that are in place. The goal is to give readers a clear understanding of how the platform is designed to operate securely and maintain its intended state.
Resolves: #16654