NetScaler ingress controller

Support for external name service across namespaces

December 31, 2023

Contributed by:

Namespaces are used to isolate resources within a Kubernetes cluster. Sometimes, services in a different namespace might have to access a service located in another namespace. In such scenarios, you can use the ExternalName service provided by Kubernetes. An ExternalName service is a special service that does not have selectors and instead uses DNS names.

In the service definition, the externalName field must point to the namespace and also to the service which we are trying to access on that namespace. Citrix ingress controller supports services of type ExternalName when you have to access services within the cluster.

When you create the ExternalName service, the following criteria must be met:

The externalName field in the service definition must follow the format: svc: <name-of-the-service>.<namespace-of-the-service>.svc.cluster.local
The port number in the ExternalName service must exactly match the port number of the targeted service.

Note:

When the service of an application is outside the Kubernetes cluster and you have created an ExternalName service, you can resolve the domain name using the Traffic management for external services feature.

Sample ExternalName service

In this example, a mysql service is running in the default namespace and a sample ExternalName service is created to access the mysql service from the namespace1 namespace.

The following is a sample service definition for a MySQL service running in the default namespace.

apiVersion: v1
kind: Service
metadata:
  name: mysql
  namespace: default
spec:
  clusterIP: None
  ports:
  - port: 3306
    protocol: TCP
    targetPort: 3306
  selector:
    app: mysql
  type: ClusterIP

<!--NeedCopy-->

The following is a sample ExternalName service definition to access the mysql service from the namespace1 namespace.

kind: Service
apiVersion: v1
metadata:
  name: dbservice
  namespace: namespace1
spec:
  type: ExternalName
  externalName: mysql.default.svc.cluster.local
  ports:
  - port: 3306
    protocol: TCP
    targetPort: 3306
<!--NeedCopy-->

In the example, the service points to the namespace where mysql is deployed as specified in the field externalName: mysql.default.svc.cluster.local. Here mysql is the service name and default is the namespace. You can see that the port name is also the same as the mysql service.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Support for external name service across namespaces

December 31, 2023

Contributed by:

December 31, 2023

Contributed by:

Support for external name service across namespaces

Sample ExternalName service

In this article