Add NOTEs for exclusive management resources doc pages #4774
Conversation
t0yv0
requested review from
flostadler and
corymhall
and removed request for
corymhall
Does the PR have any schema changes?Looking good! No breaking changes found. Maintainer note: consult the runbook for dealing with any breaking changes. |
| @@ -0,0 +1,52 @@ | |||
| --- | |||
| subcategory: "IAM (Identity & Access Management)" | |||
There was a problem hiding this comment.
There's always the risk of missing docs updates from upstream, but I feel like this is the best way of ensuring we're injecting this not into the docs of those resources.
There was a problem hiding this comment.
I can ask @guineveresaenger if there's a better way to inject a note, I've not found quickly.
There was a problem hiding this comment.
Yeah! To shadow @flostadler's concern, doing it this way makes the doc instantly stale. Sometimes this is an OK choice; I don't know the context for this resource.
To inject a note, I recommend using Edit Rules. I'm happy to help but you can write a string or regex based find/replace that pins a note to the main text of the doc (the "Description" section in the schema).
With EditRules, you can also add a hard fail on schemagen in case your find/replace condition is a bit too fragile.
There was a problem hiding this comment.
This doesn't work because of a bridge bug: pulumi/pulumi-terraform-bridge#2633
t0yv0
force-pushed
the
t0yv0/add-docs-notices
branch
from
6091aea to
dadddf3
Compare
There was a problem hiding this comment.
I've got a sample for what I was suggesting here - it "fixes" the empty Document section by removing the "forbidden" word and replacing it with "Pulumi". Obviously not binding, just a suggestion!
If you want to go this route, I do ask that we use > instead of ->.
|
|
||
| Pulumi resource for maintaining exclusive management of inline policies assigned to an AWS IAM (Identity & Access Management) role. | ||
|
|
||
| -> **NOTE:** To reliably detect drift between customer managed inline policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with `pulumi up --refresh`. See [#4766](https://github.com/pulumi/pulumi-aws/issues/4766) for tracking making this work with regular `pulumi up` invocations. |
There was a problem hiding this comment.
To render with the expected indent bar like this, the markdown must read as follows:
| -> **NOTE:** To reliably detect drift between customer managed inline policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with `pulumi up --refresh`. See [#4766](https://github.com/pulumi/pulumi-aws/issues/4766) for tracking making this work with regular `pulumi up` invocations. | |
| > **NOTE:** To reliably detect drift between customer managed inline policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with `pulumi up --refresh`. See [#4766](https://github.com/pulumi/pulumi-aws/issues/4766) for tracking making this work with regular `pulumi up` invocations. |
|
|
||
| Pulumi resource for maintaining exclusive management of customer managed policies assigned to an AWS IAM (Identity & Access Management) role. | ||
|
|
||
| -> **NOTE:** To reliably detect drift between customer managed policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with `pulumi up --refresh`. See [#4766](https://github.com/pulumi/pulumi-aws/issues/4766) for tracking making this work with regular `pulumi up` invocations. |
There was a problem hiding this comment.
| -> **NOTE:** To reliably detect drift between customer managed policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with `pulumi up --refresh`. See [#4766](https://github.com/pulumi/pulumi-aws/issues/4766) for tracking making this work with regular `pulumi up` invocations. | |
| > **NOTE:** To reliably detect drift between customer managed policies listed in this resource and actual policies attached to the role in the cloud, you currently need to run Pulumi with `pulumi up --refresh`. See [#4766](https://github.com/pulumi/pulumi-aws/issues/4766) for tracking making this work with regular `pulumi up` invocations. |
|
That's brilliant, thank you! Trying it out. |
Exclusive Relationship Management Resources do not currently work as you would expect in Pulumi but require `pulumi up --refresh`. A NOTE is added with this information to the affected resources docs pages so that users are made aware of the problem. More context in: #4772
t0yv0
force-pushed
the
t0yv0/add-docs-notices
branch
from
dadddf3 to
0a18790
Compare
t0yv0
dismissed
guineveresaenger’s stale review
Addressed changes as requested
|
This PR has been shipped in release v6.61.0. |
Exclusive Relationship Management Resources do not currently work as you would expect in Pulumi but require
pulumi up --refresh. A NOTE is added with this information to the affected resources docs pages so that users are made aware of the problem.More context in: #4772