Kubernetes Extensibility core/Service@v1 has incorrect type for targetPort in VS Code extension

[AaronCrawfis]

Bicep version

Bicep VSCode extension: v0.13.1
Bicep binary: Bicep CLI version 0.13.1 (e3ac80d678)

Describe the bug

spec.ports.targetPort has an incorrect type. It expects a string, however it should be an int instead.

Here's a valid template that deploys correctly:

import '[email protected]' with {
  kubeConfig: kubeConfig
  namespace: 'default'
}

resource frontendService 'core/Service@v1' = {
  metadata: {
    name: 'frontend'
    labels: {
      app: 'frontend'
    }
  }
  spec: {
    selector: {
      app: 'frontend'
    }
    ports: [
      {
        port: 80
        targetPort: 80 // The tooling expects this to be a string instead of an int
        protocol: 'TCP'
      }
    ]
    type: 'LoadBalancer'
  }
}

However I get the following warning:

When a string is used for deployment as suggested by the tooling, the following error is returned:

ERROR: ***"status":"Failed","error":***"code":"DeploymentFailed","message":"At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/arm-deployment-operations for usage details.","details":[***"code":"BadRequest","message":"***\r\n  \"error\": ***\r\n    \"code\": \"InvalidTemplateDeployment\",\r\n    \"message\": \"The template deployment 'frontend' is not valid according to the validation procedure. The tracking id is 'ecb95883-861b-45f5-a8f4-057e19cd5e5a'. See inner errors for details.\",\r\n    \"details\": [\r\n      ***\r\n        \"code\": \"UnprocessableEntity\",\r\n        \"target\": \"/resources/frontendService\",\r\n        \"message\": \"***\\\"kind\\\":\\\"Status\\\",\\\"apiVersion\\\":\\\"v1\\\",\\\"metadata\\\":***,\\\"status\\\":\\\"Failure\\\",\\\"message\\\":\\\"Service \\\\\\\"frontend\\\\\\\" is invalid: spec.ports[0].targetPort: Invalid value: \\\\\\\"80\\\\\\\": must contain at least one letter or number (a-z, 0-9)\\\",\\\"reason\\\":\\\"Invalid\\\",\\\"details\\\":***\\\"name\\\":\\\"frontend\\\",\\\"kind\\\":\\\"Service\\\",\\\"causes\\\":[***\\\"reason\\\":\\\"FieldValueInvalid\\\",\\\"message\\\":\\\"Invalid value: \\\\\\\"80\\\\\\\": must contain at least one letter or number (a-z, 0-9)\\\",\\\"field\\\":\\\"spec.ports[0].targetPort\\\"***]***,\\\"code\\\":422***\\n\"\r\n      ***\r\n    ]\r\n  ***\r\n***"***]***

To Reproduce

Paste the above Bicep into VSCode and see the warning

Additional context
Add any other context about the problem here.

[alex-frankel]

@shenglol / @anthony-c-martin / @rynowak -- is this because the type definitions we get from kubernetes is incorrect? If so, what would the process be for correcting that?

[rynowak]

This is actually a gap in either Bicep or the tools to extract the types and put them in Bicep. I don't remember which, I think I mentioned it in this issue: Azure/bicep-types#153

The actual type is intorstring a special type that Kubernetes defines as a union of int or string. See ports.targetPort in the official docs https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/#ServiceSpec

[rynowak]

ints are more common than strings for this usecase so if someone is blocked, we should tweak the definition to mandate an int. However both are valid.

[justinmchase]

Where can I read more about this kubernetes import? Is this publicly available?

[shenglol]

@justinmchase We'll announce public preview for the k8s provider next week. Documentations will be published. Stay tuned 🙂.

[justinmchase]

I was just wondering if it would be possible to put kubernetes resources in via bicep, came here looking for some clues only to find you're literally about to release it. You're like a mind reader! gj

[shenglol]

Unfortunately, the current limitations of the OpenAPI spec v2 and Bicep prevent us from resolving the issue with the IntOrString problem at this time. The union type int | string cannot be directly expressed in the OpenAPI spec v2, and it is also not allowed in Bicep.