EgressPoint API reference

This topic provides reference information for the EgressPoint resource.

You can create the EgressPoint resource manually or through the UI. The resource is defined as follows:

apiVersion: networking.tanzu.vmware.com/v1alpha1
kind: EgressPoint
metadata:
  name: EGRESSPOINT-NAME
spec:
  sourceRef: #! Optional
    apiGroup: SOURCEREF-API-GROUP
    kind: SOURCEREF-KIND
    name: SOURCEREF-NAME
  targets:
  - hosts:
    - HOST
    port:
      number: TARGET-PORT
      protocol: TARGET-PROTOCOL

Where:

Variable	Description	Example
EGRESSPOINT-NAME	The name you want for your `EgressPoint` resource. It might be useful to name it something relevant to the off-cluster target you’re allowing access to.	`example-egress`
SOURCEREF-API-GROUP	The API group of the resource you want to target	Supported values: `apps.tanzu.vmware.com` `apps`
SOURCEREF-KIND	The kind of resource in the API group you want to target	Supported values: `ContainerApp` `Deployment`
SOURCEREF-NAME	The name of the `KIND.API-GROUP` resource you want to target	`my-app`
HOST	The host name of the off-cluster target you want to access	`www.example.com`
TARGET-PORT	The port that the target is listening on	`80`
TARGET-PROTOCOL	The protocol to access the target	`HTTP`

Note
The spec.sourceRef field is optional. If you provide it, the Egress rules defined in the EgressPoint resource only apply to that workload. The only supported values for kind.apiGroup are ContainerApp.apps.tanzu.vmware.com and Deployment.apps.