docs: document v2 components#212
Open
droguljic wants to merge 1 commit into
Open
Conversation
Documentation for v2, generated with the help of AI. Component specific documentation is moved into their respective folders, main `README.md` only references it. The `examples` folder is for now removed and replaced partially by the in documentation examples.
Member
|
I think the best test for the docs would be to have someone who hasn't worked much with icb, to try and deploy some of the components just using the docs. |
This was referenced May 6, 2026
mandryllo
reviewed
May 12, 2026
| - The primary subnet group always uses `vpc.isolatedSubnetIds`, and the database is always created with `publiclyAccessible: false`. | ||
| - The database security group allows TCP/5432 from the VPC CIDR block. | ||
| - The primary password is always managed through a nested `Password` component. If you omit `password`, that nested component generates a random password and stores it in Secrets Manager. | ||
| - `Database` creates replicas sequentially. Each replica depends on the previous primary/replica instance rather than creating all replicas in parallel. |
Collaborator
There was a problem hiding this comment.
Maybe add explanation why it need to create them sequentially?
| | `password` | `pulumi.Input<string>` | No | generated by `Password` | If omitted, a nested `Password` component generates and stores the secret. | | ||
| | `engineVersion` | `pulumi.Input<string>` | No | `'17.2'` | PostgreSQL engine version. | | ||
| | `multiAz` | `pulumi.Input<boolean>` | No | `false` | Multi-AZ toggle for the primary instance. | | ||
| | `instanceClass` | `pulumi.Input<string>` | No | `'db.t4g.micro'` | Primary instance class. | |
Collaborator
There was a problem hiding this comment.
Instance type of the RDS instance?
Comment on lines
+115
to
+118
| | `allowMajorVersionUpgrade` | `pulumi.Input<boolean>` | No | `false` | Passed through to the primary instance. | | ||
| | `autoMinorVersionUpgrade` | `pulumi.Input<boolean>` | No | `true` | Passed through to the primary instance. | | ||
| | `applyImmediately` | `pulumi.Input<boolean>` | No | `false` | Passed through to the primary instance. | | ||
| | `skipFinalSnapshot` | `pulumi.Input<boolean>` | No | `false` | Passed through to the primary instance. | |
Collaborator
There was a problem hiding this comment.
Add more specific description
Comment on lines
+300
to
+302
| | `applyImmediately` | `pulumi.Input<boolean>` | No | `false` | Passed through to the replica instance. | | ||
| | `allowMajorVersionUpgrade` | `pulumi.Input<boolean>` | No | `false` | Passed through to the replica instance. | | ||
| | `autoMinorVersionUpgrade` | `pulumi.Input<boolean>` | No | `true` | Passed through to the replica instance. | |
Collaborator
There was a problem hiding this comment.
Add more specific description
| | `parameterGroupName` | `pulumi.Input<string>` | No | none | Optional DB parameter group name for the primary instance. | | ||
| | `kmsKeyId` | `pulumi.Input<string>` | No | generated KMS key ARN | Override for storage encryption and encrypted snapshot copies. | | ||
| | `replicaConfigs` | `Map<string, Database.ReplicaConfig>` | No | none | Ordered map of replica names to configs. Replicas are created sequentially in insertion order. | | ||
| | `enableSSMConnect` | `pulumi.Input<boolean>` | No | `false` | Creates the nested `Ec2SSMConnect` helper when truthy. | |
Collaborator
There was a problem hiding this comment.
Maybe change the wording from helper to something else? It's used on multiple places in the file for Ec2SSMConnect
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation for v2, generated with the help of AI. Component specific documentation is moved into their respective folders, main
README.mdonly references it.The
examplesfolder is for now removed and replaced partially by the in documentation examples.