Skip to content

Vhost

A name-based virtual host (vhost) exposes the applications and services in your tenant to the public internet or to a Virtual Private Cloud:

  • If you deploy an application from the App Catalog or a service, then the DSH adds a vhost for them automatically.
  • Some services, such as the Kafka Proxy, require multiple vhosts.

  • For your custom services, you can also request your own vhost from a platform administrator. In the service definition of a custom service, you can then define the following properties of a vhost:

    • Authentication method
    • Routing mode
    • Whitelist of IP addresses
    • Allowed paths
    • Group of services attached to the vhost

    See Vhost configuration for more information.

Tip

It’s strongly recommended that you add one or more certificates for all your vhosts. See Adding a certificate for more information.

Managing vhosts

You can manage your vhosts in the DSH Console.

Adding a vhost

The DSH adds vhosts automatically when it deploys a service or an application from the App Catalog for your tenant. If you want to add a vhost for your own custom service, then you need to request it from a platform administrator.

If you request a new vhost, then you only need to request the subdomains under the platform’s domain name. For example:

  • ‘example.kpn-dsh.com’ is your platform.
  • ‘yourservice.yourtenant.example.kpn.dsh.com’ is the vhost that you need.
  • ‘yourservice.yourtenant’ is the subdomain that you request.

The requested subdomain must adhere to the following rules:

  • If the subdomain contains multiple parts, then they are separated by a period ..
  • Each part of the subdomain starts and ends with a lowercase letter (a–z), or a number (0–9).
  • Each part can contain hyphens (-), lowercase letters (a–z), or numbers (0–9).
  • Each part has a maximum length of 63 characters.
  • The complete requested subdomain can’t be longer than 64 characters.

Tip

The DSH approves vhosts automatically if they are subdomains of your tenant’s name. For example:

  • ‘tenant-a’ is your tenant’s name.
  • You request the subdomain ‘my-service.tenant-a’.
  • The DSH approves the request automatically, because it follows the rules above, and it’s a subdomain of ‘tenant-a’.

Take the following steps to request a vhost:

  1. Click “Resources” > “Vhosts” in the menu bar of the DSH Console.
  2. Click the “+ Vhost” button to request a new vhost. Fill out the following fields:
    • DNS hosted zone: On some platforms, you can choose between:
      • A public hosted zone, which allows traffic from the public internet
      • A private hosted zone, which only allows traffic from your Virtual Private Cloud
    • Subdomain: The subdomain that you want to request. Make sure that the format follows the rules mentioned above.
    • Comments (Optional): Any comments for the platform administrator.
  3. Click the “Request vhost” button. A platform administrator will process your request, which appears as a ticket in the Support Portal.

Tip

See Vhost configuration for more information about configuring the vhost in the service definition:

  • Authentication method
  • Routing mode
  • Whitelist of IP addresses
  • Allowed paths
  • Group of services attached to the vhost

Inspecting a vhost

Take the following steps to inspect a vhost:

  1. Click “Resources” > “Vhosts”.
  2. The overview page provides information about your vhost:
    • Name: The complete domain name of the vhost.
    • Zone: Indicates whether the DNS hosted zone is public (open to the internet) or private (open to your Virtual Private Cloud only).
    • Derived from: If the DSH created the vhost as part of a service or application, then the name of the service is mentioned under “Derived from”. Click the link to inspect the application or service in question.

You can also navigate to the vhost’s certificate or address:

  • If the vhost is secured by one of your certificates, then the DSH displays a “Certificate” label. Click it to inspect the certificate in question.
  • If you hover over the vhost’s name, then a blue icon appears. Click it to navigate to the vhost’s address in a new browser tab.

Deleting a vhost

Take the following steps to delete a vhost:

  1. Click “Resources” > “Vhosts”
  2. Click the “Delete” button for the vhost that you want to delete, and click “Yes, delete” to confirm.

Note

If the DSH created the vhost as part of a service or application, then you can only delete the vhost by deleting the service or application in question.