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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.yahoo.config.provision.AthenzDomain accessControlDomain()
      Return the system Athenz domain
      java.net.URI apiUrl()
      Returns a URL to the controller's api endpoint
      java.net.URI badgeUrl()
      Returns a URL used to generate flashy badges from strings.
      java.net.URI dashboardUrl()
      Returns a URL where an informative dashboard can be found.
      java.net.URI dashboardUrl​(com.yahoo.config.provision.ApplicationId id)
      Returns a URL which displays information about the given application.
      java.net.URI dashboardUrl​(RunId id)
      Returns a URL which displays information about the given job run.
      java.util.List<java.net.URI> getConfigServerApiUris​(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns all possible API endpoints of all known config servers and config server VIPs in the given zone
      com.yahoo.vespa.athenz.api.AthenzIdentity getConfigServerHttpsIdentity​(com.yahoo.config.provision.zone.ZoneId zoneId)
      Return the configserver's Athenz service identity
      java.util.List<java.net.URI> getConfigServerUris​(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns the API endpoints of all known config servers in the given zone
      java.net.URI getConfigServerVipUri​(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns the URI for the config server VIP in the given zone
      java.util.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
      java.util.Optional<java.time.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
      java.net.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
      boolean hasZone​(com.yahoo.config.provision.zone.ZoneId zoneId)
      Returns whether the system of this registry contains the given zone
      java.util.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
      java.util.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
      java.net.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.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 Detail

      • 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

        java.util.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

      • getConfigServerUris

        java.util.List<java.net.URI> getConfigServerUris​(com.yahoo.config.provision.zone.ZoneId zoneId)
        Returns the API endpoints of all known config servers in the given zone

      • getConfigServerVipUri

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

      • getConfigServerApiUris

        java.util.List<java.net.URI> getConfigServerApiUris​(com.yahoo.config.provision.zone.ZoneId zoneId)
        Returns all possible API endpoints of all known config servers and config server VIPs in the given zone

      • getDeploymentTimeToLive

        java.util.Optional<java.time.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

        java.net.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

      • 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

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

      • routingMethods

        java.util.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

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

      • dashboardUrl

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

      • dashboardUrl

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

      • supportUrl

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

      • badgeUrl

        java.net.URI badgeUrl()
        Returns a URL used to generate flashy badges from strings.

      • apiUrl

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