Skip to main content
Version: 3.1.0 (Preview)

Kerberos Descriptor

A Kerberos Descriptor is Stack or service metadata that describes the identities and configuration required to secure a deployment. It is declarative metadata, not a place for passwords, private keys, keytab contents, or KDC administrator credentials.

Descriptor Structure

The top-level descriptor may contain properties, identities, auth-to-local-properties, configurations, and services. A service descriptor contains name, and may contain identities, auth-to-local-properties, configurations, and components. A component descriptor contains name and optional identity, auth-to-local, and configuration blocks.

Properties And Configurations

properties provides named values for controlled substitution. configurations provides configuration-type/property values for the secured service. Substitution is explicit and should be limited to known configuration fields; do not use it to inject secrets or arbitrary destinations. Configuration changes can mark components for restart through their declared dependencies.

Identities, Principals, And Keytabs

An identity has a stable name and may reference another identity by relative or absolute path. A principal describes its normalized name, type, configuration property, and optional local username mapping. A keytab describes the destination path, owner/group access, and configuration property. The descriptor may refer to a keytab path, but never contains the keytab bytes.

Use _HOST or the supported hostname substitution for service principals where the Stack contract requires it. Keep realm and principal variables in the descriptor; resolve their values through the selected cluster configuration and protected provisioning inputs.

Services And Components

The Stack descriptor declares shared identities and service entries. Service-level entries can be specialized by components, while component-level entries describe only that component. The inheritance model creates a resolved copy for the child; overriding a property does not mutate the parent definition.

Validation

The Server validates descriptor shape, identity references, supported configuration specifications, and service/component names before assigning work. Invalid descriptors are rejected as a candidate; the Agent keeps its last valid assignment. Test normal, HA, KDC, Active Directory, and manually prepared environments before enabling production security.

For the enabling workflow and credential handling, see Enabling Kerberos. For service configuration groups and restart behavior, see Kerberos Service.