org.apache.hadoop.registry.client.api
Interface RegistryConstants

All Known Implementing Classes:

org.apache.hadoop.registry.client.impl.zk.CuratorService, RegistryOperationsClient, RegistryOperationsService

@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface RegistryConstants

Constants for the registry, including configuration keys and default values.

Field Summary

static String	DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT default client-side registry JAAS context: "Client"
static boolean	DEFAULT_REGISTRY_ENABLED Defaut value for enabling the registry in the RM: false
static boolean	DEFAULT_REGISTRY_SECURE Default registry security policy: false.
static String	DEFAULT_REGISTRY_SYSTEM_ACCOUNTS Default system accounts given global access to the registry: "sasl:yarn@, sasl:mapred@, sasl:hdfs@, sasl:hadoop@".
static String	DEFAULT_REGISTRY_USER_ACCOUNTS Default system acls: "".
static String	DEFAULT_REGISTRY_ZK_QUORUM The default zookeeper quorum binding for the registry: "localhost:2181"
static int	DEFAULT_ZK_CONNECTION_TIMEOUT The default ZK connection timeout: 15000.
static String	DEFAULT_ZK_REGISTRY_ROOT Default root of the yarn registry: "/registry"
static int	DEFAULT_ZK_RETRY_CEILING Default limit on retries: 60000.
static int	DEFAULT_ZK_RETRY_INTERVAL The default interval between connection retries: 1000.
static int	DEFAULT_ZK_RETRY_TIMES The default # of times to retry a ZK connection: 5.
static int	DEFAULT_ZK_SESSION_TIMEOUT The default ZK session timeout: 60000.
static String	KEY_REGISTRY_CLIENT_AUTH Registry client authentication policy.
static String	KEY_REGISTRY_CLIENT_AUTHENTICATION_ID Registry client authentication ID
static String	KEY_REGISTRY_CLIENT_AUTHENTICATION_PASSWORD Registry client authentication password.
static String	KEY_REGISTRY_CLIENT_JAAS_CONTEXT Key to define the JAAS context.
static String	KEY_REGISTRY_ENABLED flag to indicate whether or not the registry should be enabled in the RM: "hadoop.registry.rm.enabled"
static String	KEY_REGISTRY_KERBEROS_REALM The kerberos realm: "hadoop.registry.kerberos.realm".
static String	KEY_REGISTRY_SECURE Key to set if the registry is secure: "hadoop.registry.secure".
static 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".
static 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".
static String	KEY_REGISTRY_ZK_CONNECTION_TIMEOUT Zookeeper connection timeout in milliseconds: "hadoop.registry.zk.connection.timeout.ms".
static String	KEY_REGISTRY_ZK_QUORUM List of hostname:port pairs defining the zookeeper quorum binding for the registry "hadoop.registry.zk.quorum"
static String	KEY_REGISTRY_ZK_RETRY_CEILING Zookeeper retry limit in milliseconds, during exponential backoff: "hadoop.registry.zk.retry.ceiling.ms".
static String	KEY_REGISTRY_ZK_RETRY_INTERVAL Zookeeper connect interval in milliseconds: "hadoop.registry.zk.retry.interval.ms".
static String	KEY_REGISTRY_ZK_RETRY_TIMES Zookeeper connection retry count before failing: "hadoop.registry.zk.retry.times".
static String	KEY_REGISTRY_ZK_ROOT Root path in the ZK tree for the registry: "hadoop.registry.zk.root"
static String	KEY_REGISTRY_ZK_SESSION_TIMEOUT Zookeeper session timeout in milliseconds: "hadoop.registry.zk.session.timeout.ms"
static String	PATH_SYSTEM_SERVICES path to system services off the root : "/services/".
static String	PATH_USER_SERVICES path to system services under a user's home path : "/services/".
static String	PATH_USERS path to users off the root: "/users/".
static String	REGISTRY_CLIENT_AUTH_ANONYMOUS No authentication; client is anonymous
static String	REGISTRY_CLIENT_AUTH_DIGEST Username/password is the authentication mechanism.
static String	REGISTRY_CLIENT_AUTH_KERBEROS Registry client uses Kerberos: authentication is automatic from logged in user
static String	REGISTRY_PREFIX prefix for registry configuration options: "hadoop.registry.".
static String	SUBPATH_COMPONENTS path under a service record to point to components of that service: "/components/".
static String	ZK_PREFIX Prefix for zookeeper-specific options: "hadoop.registry.zk."

Field Detail

REGISTRY_PREFIX

static final String REGISTRY_PREFIX

prefix for registry configuration options: "hadoop.registry.". Why hadoop. and not YARN? It can live outside YARN

See Also:

Constant Field Values

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:

Constant Field Values

KEY_REGISTRY_ENABLED

static final String KEY_REGISTRY_ENABLED

flag to indicate whether or not the registry should be enabled in the RM: "hadoop.registry.rm.enabled"

See Also:

Constant Field Values

DEFAULT_REGISTRY_ENABLED

static final boolean DEFAULT_REGISTRY_ENABLED

Defaut value for enabling the registry in the RM: false

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_REGISTRY_SECURE

static final boolean DEFAULT_REGISTRY_SECURE

Default registry security policy: false.

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_ZK_REGISTRY_ROOT

static final String DEFAULT_ZK_REGISTRY_ROOT

Default root of the yarn registry: "/registry"

See Also:

Constant Field Values

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:

Constant Field Values

REGISTRY_CLIENT_AUTH_KERBEROS

static final String REGISTRY_CLIENT_AUTH_KERBEROS

Registry client uses Kerberos: authentication is automatic from logged in user

See Also:

Constant Field Values

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:

Constant Field Values

REGISTRY_CLIENT_AUTH_ANONYMOUS

static final String REGISTRY_CLIENT_AUTH_ANONYMOUS

No authentication; client is anonymous

See Also:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

DEFAULT_REGISTRY_ZK_QUORUM

static final String DEFAULT_REGISTRY_ZK_QUORUM

The default zookeeper quorum binding for the registry: "localhost:2181"

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_ZK_SESSION_TIMEOUT

static final int DEFAULT_ZK_SESSION_TIMEOUT

The default ZK session timeout: 60000.

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_ZK_CONNECTION_TIMEOUT

static final int DEFAULT_ZK_CONNECTION_TIMEOUT

The default ZK connection timeout: 15000.

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_ZK_RETRY_TIMES

static final int DEFAULT_ZK_RETRY_TIMES

The default # of times to retry a ZK connection: 5.

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_ZK_RETRY_INTERVAL

static final int DEFAULT_ZK_RETRY_INTERVAL

The default interval between connection retries: 1000.

See Also:

Constant Field Values

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:

Constant Field Values

DEFAULT_ZK_RETRY_CEILING

static final int DEFAULT_ZK_RETRY_CEILING

Default limit on retries: 60000.

See Also:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

DEFAULT_REGISTRY_USER_ACCOUNTS

static final String DEFAULT_REGISTRY_USER_ACCOUNTS

Default system acls: "".

See Also:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT

static final String DEFAULT_REGISTRY_CLIENT_JAAS_CONTEXT

default client-side registry JAAS context: "Client"

See Also:

Constant Field Values

PATH_USERS

static final String PATH_USERS

path to users off the root: "/users/".

See Also:

Constant Field Values

PATH_SYSTEM_SERVICES

static final String PATH_SYSTEM_SERVICES

path to system services off the root : "/services/".

See Also:

Constant Field Values

PATH_USER_SERVICES

static final String PATH_USER_SERVICES

path to system services under a user's home path : "/services/".

See Also:

Constant Field Values

SUBPATH_COMPONENTS

static final String SUBPATH_COMPONENTS

path under a service record to point to components of that service: "/components/".

See Also:

Constant Field Values