Differential D25007 Diff 23 src/docs/user/userguide/almanac.diviner

Changeset View

Standalone View

src/docs/user/userguide/almanac.diviner

	@title Almanac User Guide			@title Almanac User Guide
	@group userguide			@group userguide

	Using Almanac to manage devices and services.			Using Almanac to manage devices and services.

	Overview			Overview
	========			========

	Almanac is a device and service inventory application. It allows you to create			Almanac is a device and service inventory application. It allows you to create
	lists of //devices// and //services// that humans and other applications can			lists of //devices// and //services// that humans and other applications can
	use to keep track of what is running where.			use to keep track of what is running where.

	Almanac is an infrastructure application that will normally be used by			Almanac is an infrastructure application that will normally be used by
	administrators to configure advanced Phabricator features. In most cases,			administrators to configure advanced Phorge features. In most cases,
	normal users will very rarely interact with Almanac directly.			normal users will very rarely interact with Almanac directly.

	At a very high level, Almanac can be thought of as a bit like a DNS server.			At a very high level, Almanac can be thought of as a bit like a DNS server.
	Callers ask it for information about services, and it responds with details			Callers ask it for information about services, and it responds with details
	about which devices host those services. However, it can respond to a broader			about which devices host those services. However, it can respond to a broader
	range of queries and provide more detailed responses than DNS alone can.			range of queries and provide more detailed responses than DNS alone can.

	Today, the primary use cases for Almanac are internal to Phabricator:			Today, the primary use cases for Almanac are internal to Phorge:

	- Providing a list of build servers to Drydock so it can run build and			- Providing a list of build servers to Drydock so it can run build and
	integration tasks.			integration tasks.
	- Configuring Phabricator to operate in a cluster setup.			- Configuring Phorge to operate in a cluster setup.

	Beyond internal uses, Almanac is a general-purpose service and device inventory			Beyond internal uses, Almanac is a general-purpose service and device inventory
	application and can be used to configure and manage other types of service and			application and can be used to configure and manage other types of service and
	hardware inventories, but these use cases are currently considered experimental			hardware inventories, but these use cases are currently considered experimental
	and you should be exercise caution in pursuing them.			and you should be exercise caution in pursuing them.


	Example: Drydock Build Pool			Example: Drydock Build Pool
	▲ Show 20 Lines • Show All 148 Lines • Show Last 20 Lines