Package com.yahoo.vespa.hosted.controller.api.integration.zone

Interface ZoneRegistry

public interface ZoneRegistry
Provides information about zones in a hosted Vespa system, and about the system.
Author:
mpolden

  • Method Summary

    Modifier and Type
    Method
    Description
    com.yahoo.config.provision.AthenzDomain
    accessControlDomain()
    Return the system Athenz domain
    URI
    apiUrl()
    Returns a URL to the controller's api endpoint
    URI
    dashboardUrl()
    Returns a URL where an informative dashboard can be found.
    URI
    dashboardUrl(com.yahoo.config.provision.ApplicationId id)
    Returns a URL which displays information about the given application.
    URI
    dashboardUrl(RunId id)
    Returns a URL which displays information about the given job run.
    com.yahoo.vespa.athenz.api.AthenzIdentity
    getConfigServerHttpsIdentity(com.yahoo.config.provision.zone.ZoneId zoneId)
    Return the configserver's Athenz service identity
    URI
    getConfigServerVipUri(com.yahoo.config.provision.zone.ZoneId zoneId)
    Returns the URI for the config server VIP in the given zone
    Optional<com.yahoo.config.provision.RegionName>
    getDefaultRegion(com.yahoo.config.provision.Environment environment)
    Returns the default region for the given environment, if one is configured
    Optional<Duration>
    getDeploymentTimeToLive(com.yahoo.config.provision.zone.ZoneId zoneId)
    Returns the time to live for deployments in the given zone, or empty if this is infinite
    URI
    getMonitoringSystemUri(DeploymentId deploymentId)
    Returns the monitoring system URL for the given deployment
    com.yahoo.vespa.athenz.api.AthenzIdentity
    getNodeAthenzIdentity(com.yahoo.config.provision.zone.ZoneId zoneId, com.yahoo.config.provision.NodeType nodeType)
    Return the Athenz service identity for a given node type
    Optional<String>
    getVipHostname(com.yahoo.config.provision.zone.ZoneId zoneId)
    Returns the VIP hostname for the shared routing layer in given zone, if any
    boolean
    hasZone(com.yahoo.config.provision.zone.ZoneId zoneId)
    Returns whether the system of this registry contains the given zone
    List<com.yahoo.config.provision.zone.UpgradePolicy>
    osUpgradePolicies()
    Returns all OS upgrade policies
    com.yahoo.config.provision.zone.UpgradePolicy
    osUpgradePolicy(com.yahoo.config.provision.CloudName cloud)
    Returns the OS upgrade policy to use for zones belonging to given cloud, in this registry
    List<com.yahoo.config.provision.zone.RoutingMethod>
    routingMethods(com.yahoo.config.provision.zone.ZoneId zone)
    Returns the routing methods supported by given zone, with the most preferred method appearing first
    URI
    supportUrl()
    Returns a URL used to request support from the Vespa team.
    com.yahoo.config.provision.SystemName
    system()
    Returns the system of this registry
    com.yahoo.config.provision.zone.ZoneApi
    systemZone()
    Returns the system of this registry as a zone
    Optional<String>
    tenantDeveloperRoleArn(com.yahoo.config.provision.TenantName tenant)
    IAM tenant developer role ARN
    com.yahoo.config.provision.zone.UpgradePolicy
    upgradePolicy()
    Returns the Vespa upgrade policy to use for zones in this registry
    com.yahoo.config.provision.zone.ZoneFilter
    zones()
    Returns a list containing the id of all zones in this registry

  • Method Details

    • hasZone

      boolean hasZone(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns whether the system of this registry contains the given zone

    • zones

      com.yahoo.config.provision.zone.ZoneFilter zones()
      Returns a list containing the id of all zones in this registry

    • getDefaultRegion

      Optional<com.yahoo.config.provision.RegionName> getDefaultRegion(com.yahoo.config.provision.Environment environment)
      Returns the default region for the given environment, if one is configured

    • getConfigServerVipUri

      URI getConfigServerVipUri(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns the URI for the config server VIP in the given zone

    • getVipHostname

      Optional<String> getVipHostname(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns the VIP hostname for the shared routing layer in given zone, if any

    • getDeploymentTimeToLive

      Optional<Duration> getDeploymentTimeToLive(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns the time to live for deployments in the given zone, or empty if this is infinite

    • getMonitoringSystemUri

      URI getMonitoringSystemUri(DeploymentId deploymentId)
      Returns the monitoring system URL for the given deployment

    • system

      com.yahoo.config.provision.SystemName system()
      Returns the system of this registry

    • systemZone

      com.yahoo.config.provision.zone.ZoneApi systemZone()
      Returns the system of this registry as a zone

    • getConfigServerHttpsIdentity

      com.yahoo.vespa.athenz.api.AthenzIdentity getConfigServerHttpsIdentity(com.yahoo.config.provision.zone.ZoneId zoneId)
      Return the configserver's Athenz service identity

    • getNodeAthenzIdentity

      com.yahoo.vespa.athenz.api.AthenzIdentity getNodeAthenzIdentity(com.yahoo.config.provision.zone.ZoneId zoneId, com.yahoo.config.provision.NodeType nodeType)
      Return the Athenz service identity for a given node type

    • accessControlDomain

      com.yahoo.config.provision.AthenzDomain accessControlDomain()
      Return the system Athenz domain

    • upgradePolicy

      com.yahoo.config.provision.zone.UpgradePolicy upgradePolicy()
      Returns the Vespa upgrade policy to use for zones in this registry

    • osUpgradePolicy

      com.yahoo.config.provision.zone.UpgradePolicy osUpgradePolicy(com.yahoo.config.provision.CloudName cloud)
      Returns the OS upgrade policy to use for zones belonging to given cloud, in this registry

    • osUpgradePolicies

      List<com.yahoo.config.provision.zone.UpgradePolicy> osUpgradePolicies()
      Returns all OS upgrade policies

    • routingMethods

      List<com.yahoo.config.provision.zone.RoutingMethod> routingMethods(com.yahoo.config.provision.zone.ZoneId zone)
      Returns the routing methods supported by given zone, with the most preferred method appearing first

    • dashboardUrl

      URI dashboardUrl()
      Returns a URL where an informative dashboard can be found.

    • dashboardUrl

      URI dashboardUrl(com.yahoo.config.provision.ApplicationId id)
      Returns a URL which displays information about the given application.

    • dashboardUrl

      URI dashboardUrl(RunId id)
      Returns a URL which displays information about the given job run.

    • supportUrl

      URI supportUrl()
      Returns a URL used to request support from the Vespa team.

    • apiUrl

      URI apiUrl()
      Returns a URL to the controller's api endpoint

    • tenantDeveloperRoleArn

      Optional<String> tenantDeveloperRoleArn(com.yahoo.config.provision.TenantName tenant)
      IAM tenant developer role ARN