Skip to content

Commit 87cf444

Browse files
committed
docs: Document conflict resolution between installCRDs and crds.enabled fields
1 parent f3bd681 commit 87cf444

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Pulumi Cert Manager Component
1+
## Pulumi Cert Manager Component
22

33
This repo contains the Pulumi Cert Manager component for Kubernetes. This add-on automates the
44
management and issuance of TLS certificates from various issuing sources. It ensures certificates
@@ -50,6 +50,7 @@ const cm = new certmanager.CertManager("cert-manager-deployment", {
5050
},
5151

5252
// Option 2: Using deprecated option (not recommended)
53+
// When both installCRDs and crds.enabled are specified, crds.enabled takes precedence
5354
// installCRDs: true,
5455

5556
helmOptions: {
@@ -79,6 +80,7 @@ cm = certmanager.CertManager("cert-manager-deployment",
7980
},
8081

8182
# Option 2: Using deprecated option (not recommended)
83+
# When both install_crds and crds.enabled are specified, crds.enabled takes precedence
8284
# install_crds=True,
8385

8486
helm_options={
@@ -122,6 +124,7 @@ func main() {
122124
},
123125

124126
// Option 2: Using deprecated option (not recommended)
127+
// When both InstallCRDs and Crds.Enabled are specified, Crds.Enabled takes precedence
125128
// InstallCRDs: pulumi.BoolPtr(enabled),
126129

127130
HelmOptions: &helmv3.ReleaseArgs{
@@ -145,4 +148,4 @@ if you need to override them, you may do so using the `helmOptions` parameter. R
145148
[the API docs for the `kubernetes:helm/v3:Release` Pulumi type](
146149
https://www.pulumi.com/docs/reference/pkg/kubernetes/helm/v3/release/#inputs) for a full set of choices.
147150

148-
For complete details, refer to the Pulumi Package details within the Pulumi Registry.
151+
For complete details, refer to the Pulumi Package details within the Pulumi Registry.

provider/cmd/pulumi-resource-kubernetes-cert-manager/schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
},
9191
"installCRDs": {
9292
"type": "boolean",
93-
"description": "⚠️ Deprecated: Use crds.enabled instead."
93+
"description": "⚠️ Deprecated: Use crds.enabled instead. When both installCRDs and crds.enabled are specified, crds.enabled takes precedence."
9494
},
9595
"crds": {
9696
"$ref": "#/types/kubernetes-cert-manager:index:CertManagerCrds",

provider/pkg/provider/chart.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ func (c *CertManager) DefaultRepoURL() string { return "https
3737
// CertManager contains the set of arguments for creating a CertManager component resource.
3838
type CertManagerArgs struct {
3939
Global kcm.CertManagerGlobalPtrInput `pulumi:"global"`
40+
// Deprecated: Use crds.enabled instead.
41+
// When both installCRDs and crds.enabled are specified, crds.enabled takes precedence.
4042
InstallCRDs *bool `pulumi:"installCRDs"`
4143
Crds kcm.CertManagerCrdsPtrInput `pulumi:"crds"`
4244
ReplicaCount *int `pulumi:"replicaCount"`

sdk/go/kubernetes-cert-manager/certManager.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)