Package org.apache.hadoop.registry.client.api

Interface RegistryConstants

All Known Implementing Classes:
org.apache.hadoop.registry.client.impl.zk.CuratorService, RegistryOperationsClient, RegistryOperationsService
@Public @Evolving public interface RegistryConstants
Constants for the registry, including configuration keys and default values.

  • Field Details

    • REGISTRY_PREFIX

      static final String REGISTRY_PREFIX
      prefix for registry configuration options: "hadoop.registry.".
      See Also:

    • ZK_PREFIX

      static final String ZK_PREFIX
      Prefix for zookeeper-specific options: "hadoop.registry.zk."

      For clients using other protocols, these options are not supported.

      See Also:

    • DNS_PREFIX

      static final String DNS_PREFIX
      Prefix for dns-specific options: "hadoop.registry.dns."

      For clients using other protocols, these options are not supported.

      See Also:

    • KEY_DNS_ENABLED

      static final String KEY_DNS_ENABLED
      flag to indicate whether or not the registry should be enabled in the RM: "hadoop.registry.dns.enabled".
      See Also:

    • DEFAULT_DNS_ENABLED

      static final boolean DEFAULT_DNS_ENABLED
      Defaut value for enabling the DNS in the Registry: false.
      See Also:

    • KEY_DNS_DOMAIN

      static final String KEY_DNS_DOMAIN
      DNS domain name key.
      See Also:

    • MAX_FQDN_LABEL_LENGTH

      static final int MAX_FQDN_LABEL_LENGTH
      Max length of a label (node delimited by a dot in the FQDN).
      See Also:

    • KEY_DNS_BIND_ADDRESS

      static final String KEY_DNS_BIND_ADDRESS
      DNS bind address.
      See Also:

    • KEY_DNS_PORT

      static final String KEY_DNS_PORT
      DNS port number key.
      See Also:

    • DEFAULT_DNS_PORT

      static final int DEFAULT_DNS_PORT
      Default DNS port number.
      See Also:

    • KEY_DNSSEC_ENABLED

      static final String KEY_DNSSEC_ENABLED
      DNSSEC Enabled?
      See Also:

    • KEY_DNSSEC_PUBLIC_KEY

      static final String KEY_DNSSEC_PUBLIC_KEY
      DNSSEC Enabled?
      See Also:

    • KEY_DNSSEC_PRIVATE_KEY_FILE

      static final String KEY_DNSSEC_PRIVATE_KEY_FILE
      DNSSEC private key file.
      See Also:

    • DEFAULT_DNSSEC_PRIVATE_KEY_FILE

      static final String DEFAULT_DNSSEC_PRIVATE_KEY_FILE
      Default DNSSEC private key file path.
      See Also:

    • KEY_DNS_ZONE_SUBNET

      static final String KEY_DNS_ZONE_SUBNET
      Zone subnet.
      See Also:

    • KEY_DNS_ZONE_MASK

      static final String KEY_DNS_ZONE_MASK
      Zone subnet mask.
      See Also:

    • KEY_DNS_ZONE_IP_MIN

      static final String KEY_DNS_ZONE_IP_MIN
      Zone subnet IP min.
      See Also:

    • KEY_DNS_ZONE_IP_MAX

      static final String KEY_DNS_ZONE_IP_MAX
      Zone subnet IP max.
      See Also:

    • KEY_DNS_TTL

      static final String KEY_DNS_TTL
      DNS Record TTL.
      See Also:

    • KEY_DNS_ZONES_DIR

      static final String KEY_DNS_ZONES_DIR
      DNS Record TTL.
      See Also:

    • KEY_DNS_SPLIT_REVERSE_ZONE

      static final String KEY_DNS_SPLIT_REVERSE_ZONE
      Split Reverse Zone. It may be necessary to spit large reverse zone subnets into multiple zones to handle existing hosts collocated with containers.
      See Also:

    • DEFAULT_DNS_SPLIT_REVERSE_ZONE

      static final boolean DEFAULT_DNS_SPLIT_REVERSE_ZONE
      Default value for splitting the reverse zone.
      See Also:

    • KEY_DNS_SPLIT_REVERSE_ZONE_RANGE

      static final String KEY_DNS_SPLIT_REVERSE_ZONE_RANGE
      Split Reverse Zone IP Range. How many IPs should be part of each reverse zone split
      See Also:

    • KEY_REGISTRY_SECURE

      static final String KEY_REGISTRY_SECURE
      Key to set if the registry is secure: "hadoop.registry.secure". Turning it on changes the permissions policy from "open access" to restrictions on kerberos with the option of a user adding one or more auth key pairs down their own tree.
      See Also:

    • DEFAULT_REGISTRY_SECURE

      static final boolean DEFAULT_REGISTRY_SECURE
      Default registry security policy: false.
      See Also:

    • KEY_REGISTRY_ZK_ROOT

      static final String KEY_REGISTRY_ZK_ROOT
      Root path in the ZK tree for the registry: "hadoop.registry.zk.root".
      See Also:

    • DEFAULT_ZK_REGISTRY_ROOT

      static final String DEFAULT_ZK_REGISTRY_ROOT
      Default root of the Hadoop registry: "/registry".
      See Also:

    • KEY_REGISTRY_CLIENT_AUTH

      static final String KEY_REGISTRY_CLIENT_AUTH
      Registry client authentication policy.

      This is only used in secure clusters.

      If the Factory methods of RegistryOperationsFactory are used, this key does not need to be set: it is set up based on the factory method used.

      See Also:

    • REGISTRY_CLIENT_AUTH_KERBEROS

      static final String REGISTRY_CLIENT_AUTH_KERBEROS
      Registry client uses Kerberos: authentication is automatic from logged in user.
      See Also:

    • REGISTRY_CLIENT_AUTH_DIGEST

      static final String REGISTRY_CLIENT_AUTH_DIGEST
      Username/password is the authentication mechanism. If set then both KEY_REGISTRY_CLIENT_AUTHENTICATION_ID and KEY_REGISTRY_CLIENT_AUTHENTICATION_PASSWORD must be set.
      See Also:

    • REGISTRY_CLIENT_AUTH_ANONYMOUS

      static final String REGISTRY_CLIENT_AUTH_ANONYMOUS
      No authentication; client is anonymous.
      See Also:

    • REGISTRY_CLIENT_AUTH_SIMPLE

      static final String REGISTRY_CLIENT_AUTH_SIMPLE
      See Also:

    • KEY_REGISTRY_CLIENT_AUTHENTICATION_ID

      static final String KEY_REGISTRY_CLIENT_AUTHENTICATION_ID
      Registry client authentication ID.

      This is only used in secure clusters with KEY_REGISTRY_CLIENT_AUTH set to REGISTRY_CLIENT_AUTH_DIGEST

      See Also:

    • KEY_REGISTRY_CLIENT_AUTHENTICATION_PASSWORD

      static final String KEY_REGISTRY_CLIENT_AUTHENTICATION_PASSWORD
      Registry client authentication password.

      This is only used in secure clusters with the client set to use digest (not SASL or anonymouse) authentication.

      Specifically, KEY_REGISTRY_CLIENT_AUTH set to REGISTRY_CLIENT_AUTH_DIGEST

      See Also:

    • KEY_REGISTRY_ZK_QUORUM

      static final String KEY_REGISTRY_ZK_QUORUM
      List of hostname:port pairs defining the zookeeper quorum binding for the registry "hadoop.registry.zk.quorum".
      See Also:

    • DEFAULT_REGISTRY_ZK_QUORUM

      static final String DEFAULT_REGISTRY_ZK_QUORUM
      The default zookeeper quorum binding for the registry: "localhost:2181".
      See Also:

    • KEY_REGISTRY_ZK_SESSION_TIMEOUT

      static final String KEY_REGISTRY_ZK_SESSION_TIMEOUT
      Zookeeper session timeout in milliseconds: "hadoop.registry.zk.session.timeout.ms".
      See Also:

    • DEFAULT_ZK_SESSION_TIMEOUT

      static final int DEFAULT_ZK_SESSION_TIMEOUT
      The default ZK session timeout: 60000.
      See Also:

    • KEY_REGISTRY_ZK_CONNECTION_TIMEOUT

      static final String KEY_REGISTRY_ZK_CONNECTION_TIMEOUT
      Zookeeper connection timeout in milliseconds: "hadoop.registry.zk.connection.timeout.ms".
      See Also:

    • DEFAULT_ZK_CONNECTION_TIMEOUT

      static final int DEFAULT_ZK_CONNECTION_TIMEOUT
      The default ZK connection timeout: 15000.
      See Also:

    • KEY_REGISTRY_ZK_RETRY_TIMES

      static final String KEY_REGISTRY_ZK_RETRY_TIMES
      Zookeeper connection retry count before failing: "hadoop.registry.zk.retry.times".
      See Also:

    • DEFAULT_ZK_RETRY_TIMES

      static final int DEFAULT_ZK_RETRY_TIMES
      The default # of times to retry a ZK connection: 5.
      See Also:

    • KEY_REGISTRY_ZK_RETRY_INTERVAL

      static final String KEY_REGISTRY_ZK_RETRY_INTERVAL
      Zookeeper connect interval in milliseconds: "hadoop.registry.zk.retry.interval.ms".
      See Also:

    • DEFAULT_ZK_RETRY_INTERVAL

      static final int DEFAULT_ZK_RETRY_INTERVAL
      The default interval between connection retries: 1000.
      See Also:

    • KEY_REGISTRY_ZK_RETRY_CEILING

      static final String KEY_REGISTRY_ZK_RETRY_CEILING
      Zookeeper retry limit in milliseconds, during exponential backoff: "hadoop.registry.zk.retry.ceiling.ms". This places a limit even if the retry times and interval limit, combined with the backoff policy, result in a long retry period
      See Also:

    • DEFAULT_ZK_RETRY_CEILING

      static final int DEFAULT_ZK_RETRY_CEILING
      Default limit on retries: 60000.
      See Also:

    • KEY_REGISTRY_SYSTEM_ACCOUNTS

      static final String KEY_REGISTRY_SYSTEM_ACCOUNTS
      A comma separated list of Zookeeper ACL identifiers with system access to the registry in a secure cluster: "hadoop.registry.system.accounts". These are given full access to all entries. If there is an "@" at the end of an entry it instructs the registry client to append the kerberos realm as derived from the login and KEY_REGISTRY_KERBEROS_REALM.
      See Also:

    • DEFAULT_REGISTRY_SYSTEM_ACCOUNTS

      static final String DEFAULT_REGISTRY_SYSTEM_ACCOUNTS
      Default system accounts given global access to the registry: "sasl:yarn@, sasl:mapred@, sasl:hdfs@, sasl:hadoop@".
      See Also:

    • KEY_REGISTRY_USER_ACCOUNTS

      static final String KEY_REGISTRY_USER_ACCOUNTS
      A comma separated list of Zookeeper ACL identifiers with system access to the registry in a secure cluster: "hadoop.registry.user.accounts". These are given full access to all entries. If there is an "@" at the end of an entry it instructs the registry client to append the default kerberos domain.
      See Also:

    • DEFAULT_REGISTRY_USER_ACCOUNTS

      static final String DEFAULT_REGISTRY_USER_ACCOUNTS
      Default system acls: "".
      See Also:

    • KEY_REGISTRY_KERBEROS_REALM

      static final String KEY_REGISTRY_KERBEROS_REALM
      The kerberos realm: "hadoop.registry.kerberos.realm". This is used to set the realm of system principals which do not declare their realm, and any other accounts that need the value. If empty, the default realm of the running process is used. If neither are known and the realm is needed, then the registry service/client will fail.
      See Also:

    • KEY_REGISTRY_CLIENT_JAAS_CONTEXT

      static final String KEY_REGISTRY_CLIENT_JAAS_CONTEXT
      Key to define the JAAS context. Used in secure registries: "hadoop.registry.jaas.context".
      See Also:

    • DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT

      static final String DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT
      default client-side registry JAAS context: "Client".
      See Also:

    • PATH_USERS

      static final String PATH_USERS
      path to users off the root: "/users/".
      See Also:

    • PATH_SYSTEM_SERVICES

      static final String PATH_SYSTEM_SERVICES
      path to system services off the root : "/services/".
      See Also:

    • PATH_USER_SERVICES

      static final String PATH_USER_SERVICES
      path to system services under a user's home path : "/services/".
      See Also:

    • SUBPATH_COMPONENTS

      static final String SUBPATH_COMPONENTS
      path under a service record to point to components of that service: "/components/".
      See Also: