Interface Services

interface Services {
    create(
        serviceReference: ServiceReference,
        labels: Record<string, string>,
        servicePort: number,
        podTargetPort: number,
    ): Promise<Service>;
    list(namespace: NamespaceName, labels?: string[]): Promise<Service[]>;
    read(namespace: NamespaceName, name: string): Promise<Service>;
}

Implemented by

K8ClientServices

Index

Methods

create list read

Methods

create

create(
    serviceReference: ServiceReference,
    labels: Record<string, string>,
    servicePort: number,
    podTargetPort: number,
): Promise<Service>
Create a service
Parameters
- serviceReference: ServiceReference
- labels: Record<string, string>
  the labels for the service
- servicePort: number
  the service port
- podTargetPort: number
  the target port
Returns Promise<Service>
the service

Throws
if the service could not be created
- Defined in src/integration/kube/resources/service/services.ts:31

list

list(namespace: NamespaceName, labels?: string[]): Promise<Service[]>
List all services in a namespace
Parameters
- namespace: NamespaceName
  namespace
- Optionallabels: string[]
  labels
Returns Promise<Service[]>
- Defined in src/integration/kube/resources/service/services.ts:20

read

read(namespace: NamespaceName, name: string): Promise<Service>
Get a svc by name
Parameters
- namespace: NamespaceName
  namespace
- name: string
  service name
Returns Promise<Service>
- Defined in src/integration/kube/resources/service/services.ts:13

Interface Services

Implemented by

Index

Methods

Methods

create

Parameters

Returns Promise<Service>

Throws

list

Parameters

Returns Promise<Service[]>

read

Parameters

Returns Promise<Service>

Settings

On This Page