bug: `ports.targetPort` should be of type `IntOrString` but is of type string

[Anmol1696]

Overview

Service ports.targetPort needs to be of type IntOrString but the type itself is set to just string:

export type IntOrString = string;

Here is the reference of the type Service ports: https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/#ServiceSpec

[Anmol1696]

In the swagger we have the type as a reference to:

"targetPort": {
          "description": "Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service",
          "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
        }

and the defination of the IntOrString is here:

"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
      "description": "IntOrString is a type that can hold an int32 or a string.  When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type.  This allows you to have, for example, a JSON field that can accept a name or number.",
      "type": "string",
      "format": "int-or-string"
    },

But when we go ahead and apply (kubectl apply) a service with targetPort as a string, we get an error:

Error from server (Invalid): error when creating "two-chain/cosmoshub/genesis-service.yaml": Service "cosmoshub-4-genesis" is invalid: [spec.ports[0].targetPort: Invalid value: "26656": must contain at least one letter (a-z), spec.ports[1].targetPort: Invalid value: "26658": must contain at least one letter (a-z), spec.ports[2].targetPort: Invalid value: "9090": must contain at least one letter (a-z), spec.ports[3].targetPort: Invalid value: "9091": must contain at least one letter (a-z), spec.ports[4].targetPort: Invalid value: "1317": must contain at least one letter (a-z), spec.ports[5].targetPort: Invalid value: "26657": must contain at least one letter (a-z), spec.ports[6].targetPort: Invalid value: "26660": must contain at least one letter (a-z), spec.ports[7].targetPort: Invalid value: "8081": must contain at least one letter (a-z), spec.ports[8].targetPort: Invalid value: "8000": must contain at least one letter (a-z)]

In the yaml that is created it need to be an Int. if it is a string, it would need to be a name.

Maybe we should have a way in which we can have it as:

export type IntOrString = string | int;

[Anmol1696]

Same exact issue also present in: Probe for liveiness and readinessProbe.

export interface HTTPGetAction {
    host?: string;
    httpHeaders?: HTTPHeader[];
    path?: string;
    port: IntOrString;
    scheme?: string;
}

Error i see from applying this is:

* spec.template.spec.containers[0].livenessProbe.httpGet.port: Invalid value: "8080": must contain at least one letter (a-z)

[pyramation]

cool! I'm on it!

[pyramation]

hyperweb-io/schema-typescript#5

[pyramation]

which becomes

export type IntOrString = string | number;

out of curiosity, should it actually become just number? or is this good enough?

[pyramation]

Successfully published:
 - @kubernetesjs/cli@0.3.1
 - kubernetesjs@0.7.1
 - @kubernetesjs/react@0.7.1

[Anmol1696]

It needs to be string or int, cuz we can have a named port.
Something like this:

apiVersion: v1
kind: Service
metadata:
  name: nginx-service
spec:
  selector:
    app.kubernetes.io/name: proxy
  ports:
  - name: name-of-service-port
    protocol: TCP
    port: 80
    targetPort: http-web-svc

Then the named port can be used in the hitting the port.

Thanks for solving, i will have a look at the PR as well, to figure out how to do this in the future if needed.