Unable to handle unstructured CRDs

[SamuelCabralCruz]

What happened?

Since version 1.5+ there seems to be a bug with the handling of plural kinds where only the plural kind will be exported and not the singular type or maybe it is only a problem with the ordering of the types export.

Example

Use crd2pulumi with version 1.5.3 on ratelimitconfigs.ratelimit.solo.io.

npm error code 1
npm error path /Users/Samuel.Cabralcruz/Documents/ticketmaster/crds/crds/gloo
npm error command failed
npm error command sh -c node ./scripts/postinstall.js
npm error Command failed: tsc: ratelimit/v1alpha1/rateLimitConfigList.ts(9,9): error TS2724: '"./index"' has no exported member named 'RateLimitConfig'. Did you mean 'RateLimitConfigList'?
npm error types/input.ts(8,9): error TS2724: '"../ratelimit/v1alpha1"' has no exported member named 'RateLimitConfig'. Did you mean 'RateLimitConfigList'?
npm error types/output.ts(8,9): error TS2724: '"../ratelimit/v1alpha1"' has no exported member named 'RateLimitConfig'. Did you mean 'RateLimitConfigList'?

Output of pulumi about

CLI
Version 3.113.3
Go Version go1.22.2
Go Compiler gc

Host
OS darwin
Version 15.3.1
Arch arm64

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

[rquitales]

@SamuelCabralCruz Would you be able to provide a sample of the CRDs that is causing this error. Without a reproducible manifest, it is hard for us to determine the issue. Thanks.

[SamuelCabralCruz]

mkdir -p tmp
cd tmp
kubectl get crd ratelimitconfigs.ratelimit.solo.io -o yaml > definition.yaml
crd2pulumi -n definition.yaml

You should get the normal output: Successfully generated nodejs code.
However, if you give a look at the outputted code, you can see there are type errors:

tmp/crds/nodejs/ratelimit/v1alpha1/rateLimitConfigList.ts

import {RateLimitConfig} from "./index"; will be in error because the RateLimitConfig type does not exist.

[SamuelCabralCruz]

definition.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    kubectl.kubernetes.io/last-applied-configuration: |
      {"apiVersion":"apiextensions.k8s.io/v1","kind":"CustomResourceDefinition","metadata":{"annotations":{},"name":"ratelimitconfigs.ratelimit.solo.io"},"spec":{"group":"ratelimit.solo.io","names":{"kind":"RateLimitConfig","listKind":"RateLimitConfigList","plural":"ratelimitconfigs","shortNames":["rlc","grlc"],"singular":"ratelimitconfig"},"scope":"Namespaced","versions":[{"name":"v1alpha1","schema":{"openAPIV3Schema":{"type":"object","x-kubernetes-preserve-unknown-fields":true}},"served":true,"storage":true,"subresources":{"status":{}}}]}}
  creationTimestamp: "2023-10-30T21:46:28Z"
  generation: 1
  name: ratelimitconfigs.ratelimit.solo.io
  resourceVersion: "5929609126"
  uid: a93fb204-51f6-461c-acd9-b0532885ebf6
spec:
  conversion:
    strategy: None
  group: ratelimit.solo.io
  names:
    kind: RateLimitConfig
    listKind: RateLimitConfigList
    plural: ratelimitconfigs
    shortNames:
    - rlc
    - grlc
    singular: ratelimitconfig
  scope: Namespaced
  versions:
  - name: v1alpha1
    schema:
      openAPIV3Schema:
        type: object
        x-kubernetes-preserve-unknown-fields: true
    served: true
    storage: true
    subresources:
      status: {}
status:
  acceptedNames:
    kind: RateLimitConfig
    listKind: RateLimitConfigList
    plural: ratelimitconfigs
    shortNames:
    - rlc
    - grlc
    singular: ratelimitconfig
  conditions:
  - lastTransitionTime: "2023-10-30T21:46:28Z"
    message: no conflicts found
    reason: NoConflicts
    status: "True"
    type: NamesAccepted
  - lastTransitionTime: "2023-10-30T21:46:28Z"
    message: the initial names have been accepted
    reason: InitialNamesAccepted
    status: "True"
    type: Established
  storedVersions:
  - v1alpha1

[rquitales]

Thanks for providing the sample CRD. The issue stems from the CRD essentially being unstructured. Notice the schema being defined as:

  - name: v1alpha1
    schema:
      openAPIV3Schema:
        type: object
        x-kubernetes-preserve-unknown-fields: true

If you remove the x-kubernetes-preserve-unknown-fields: true line, crd2pulumi will generate a valid SDK. We'll add this to our backlog to resolve.