DOCKER on Pigsty v5.0

Module: DOCKER

Mon, 01 Jan 0001 00:00:00 +0000

Docker is the most popular containerization platform, providing standardized software delivery capabilities.

Pigsty does not rely on Docker to deploy any of its components; instead, it provides the ability to deploy and install Docker — this is an optional module.

Pigsty offers a series of Docker software/tool/application templates for you to choose from as needed. This allows users to quickly spin up various containerized stateless software templates, adding extra functionality. You can use external, Pigsty-managed highly available database clusters while placing stateless applications inside containers.

Usage

Mon, 01 Jan 0001 00:00:00 +0000

Pigsty has built-in Docker support, which you can use to quickly deploy containerized applications.

Getting Started

Docker is an optional module. In Pigsty, whether Docker is installed is controlled by docker_enabled, which is disabled by default.

The docker-ce upstream repository belongs to the infra module. If you need to explicitly include Docker packages in the offline repository, use repo_extra_packages with the docker package alias (mapped to docker-ce and docker-compose-plugin).

Playbooks

Mon, 01 Jan 0001 00:00:00 +0000

The Docker module provides a default playbook docker.yml for installing Docker Daemon and Docker Compose.

`docker.yml`

Playbook source file: docker.yml

Running this playbook will install docker-ce and docker-compose-plugin on target nodes with the docker_enabled: true flag, and enable the dockerd service.

The following are the available task subsets in the docker.yml playbook:

docker_install : Install Docker and Docker Compose packages on the node
docker_admin : Add specified users to the Docker admin user group
docker_dir : Create Docker related directories
docker_config : Generate Docker daemon service configuration file
docker_launch : Start the Docker daemon service
docker_register : Register Docker daemon as a monitoring target (alias tags: register / add_metrics)
docker_image : Attempt to load pre-cached image tarballs from /tmp/docker/*.tgz (if they exist)

The Docker module does not provide a dedicated uninstall playbook. If you need to uninstall Docker, you can manually stop Docker and then remove it:

Metrics

Mon, 01 Jan 0001 00:00:00 +0000

This snapshot records 123 monitoring metric families for the DOCKER module. The metrics present at runtime vary with package version, enabled collectors, and target state.

Metric Name	Type	Labels	Description
builder_builds_failed_total	counter	`ip`, `cls`, `reason`, `ins`, `job`, `instance`	Number of failed image builds
builder_builds_triggered_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Number of triggered image builds
docker_up	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
engine_daemon_container_actions_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`, `action`	N/A
engine_daemon_container_actions_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `action`	N/A
engine_daemon_container_actions_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `action`	N/A
engine_daemon_container_states_containers	gauge	`ip`, `cls`, `ins`, `job`, `instance`, `state`	The count of containers in various states
engine_daemon_engine_cpus_cpus	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of cpus that the host system of the engine has
engine_daemon_engine_info	gauge	`ip`, `cls`, `architecture`, `ins`, `job`, `instance`, `os_version`, `kernel`, `version`, `graphdriver`, `os`, `daemon_id`, `commit`, `os_type`	The information related to the engine and the OS it is running on
engine_daemon_engine_memory_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of bytes of memory that the host system of the engine has
engine_daemon_events_subscribers_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of current subscribers to events
engine_daemon_events_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	The number of events logged
engine_daemon_health_checks_failed_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	The total number of failed health checks
engine_daemon_health_check_start_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
engine_daemon_health_check_start_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
engine_daemon_health_check_start_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
engine_daemon_health_checks_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	The total number of health checks
engine_daemon_host_info_functions_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`, `function`	N/A
engine_daemon_host_info_functions_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `function`	N/A
engine_daemon_host_info_functions_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `function`	N/A
engine_daemon_image_actions_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`, `action`	N/A
engine_daemon_image_actions_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `action`	N/A
engine_daemon_image_actions_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `action`	N/A
engine_daemon_network_actions_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`, `action`	N/A
engine_daemon_network_actions_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `action`	N/A
engine_daemon_network_actions_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `action`	N/A
etcd_debugging_snap_save_marshalling_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
etcd_debugging_snap_save_marshalling_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_debugging_snap_save_marshalling_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_debugging_snap_save_total_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
etcd_debugging_snap_save_total_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_debugging_snap_save_total_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_disk_wal_fsync_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
etcd_disk_wal_fsync_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_disk_wal_fsync_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_disk_wal_write_bytes_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Total number of bytes written in WAL.
etcd_snap_db_fsync_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
etcd_snap_db_fsync_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_snap_db_fsync_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_snap_db_save_total_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
etcd_snap_db_save_total_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_snap_db_save_total_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_snap_fsync_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
etcd_snap_fsync_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
etcd_snap_fsync_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
go_gc_duration_seconds	summary	`ip`, `cls`, `ins`, `job`, `instance`, `quantile`	A summary of the pause duration of garbage collection cycles.
go_gc_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
go_gc_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
go_goroutines	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of goroutines that currently exist.
go_info	gauge	`ip`, `cls`, `ins`, `job`, `version`, `instance`	Information about the Go environment.
go_memstats_alloc_bytes	counter	`ip`, `cls`, `ins`, `job`, `instance`	Total number of bytes allocated, even if freed.
go_memstats_alloc_bytes_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Total number of bytes allocated, even if freed.
go_memstats_buck_hash_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes used by the profiling bucket hash table.
go_memstats_frees_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Total number of frees.
go_memstats_gc_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes used for garbage collection system metadata.
go_memstats_heap_alloc_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of heap bytes allocated and still in use.
go_memstats_heap_idle_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of heap bytes waiting to be used.
go_memstats_heap_inuse_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of heap bytes that are in use.
go_memstats_heap_objects	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of allocated objects.
go_memstats_heap_released_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of heap bytes released to OS.
go_memstats_heap_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of heap bytes obtained from system.
go_memstats_last_gc_time_seconds	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of seconds since 1970 of last garbage collection.
go_memstats_lookups_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Total number of pointer lookups.
go_memstats_mallocs_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Total number of mallocs.
go_memstats_mcache_inuse_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes in use by mcache structures.
go_memstats_mcache_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes used for mcache structures obtained from system.
go_memstats_mspan_inuse_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes in use by mspan structures.
go_memstats_mspan_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes used for mspan structures obtained from system.
go_memstats_next_gc_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of heap bytes when next garbage collection will take place.
go_memstats_other_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes used for other system allocations.
go_memstats_stack_inuse_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes in use by the stack allocator.
go_memstats_stack_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes obtained from system for stack allocator.
go_memstats_sys_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of bytes obtained from system.
go_threads	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of OS threads created.
logger_log_entries_size_greater_than_buffer_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Number of log entries which are larger than the log buffer
logger_log_read_operations_failed_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Number of log reads from container stdio that failed
logger_log_write_operations_failed_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Number of log write operations that failed
process_cpu_seconds_total	counter	`ip`, `cls`, `ins`, `job`, `instance`	Total user and system CPU time spent in seconds.
process_max_fds	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Maximum number of open file descriptors.
process_open_fds	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Number of open file descriptors.
process_resident_memory_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Resident memory size in bytes.
process_start_time_seconds	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Start time of the process since unix epoch in seconds.
process_virtual_memory_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Virtual memory size in bytes.
process_virtual_memory_max_bytes	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Maximum amount of virtual memory available in bytes.
promhttp_metric_handler_requests_in_flight	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Current number of scrapes being served.
promhttp_metric_handler_requests_total	counter	`ip`, `cls`, `ins`, `job`, `instance`, `code`	Total number of scrapes by HTTP status code.
scrape_duration_seconds	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
scrape_samples_post_metric_relabeling	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
scrape_samples_scraped	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
scrape_series_added	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_dispatcher_scheduling_delay_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_dispatcher_scheduling_delay_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_dispatcher_scheduling_delay_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_manager_configs_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of configs in the cluster object store
swarm_manager_leader	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Indicates if this manager node is a leader
swarm_manager_networks_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of networks in the cluster object store
swarm_manager_nodes	gauge	`ip`, `cls`, `ins`, `job`, `instance`, `state`	The number of nodes
swarm_manager_secrets_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of secrets in the cluster object store
swarm_manager_services_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`	The number of services in the cluster object store
swarm_manager_tasks_total	gauge	`ip`, `cls`, `ins`, `job`, `instance`, `state`	The number of tasks in the cluster object store
swarm_node_manager	gauge	`ip`, `cls`, `ins`, `job`, `instance`	Whether this node is a manager or not
swarm_raft_snapshot_latency_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_raft_snapshot_latency_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_raft_snapshot_latency_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_raft_transaction_latency_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_raft_transaction_latency_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_raft_transaction_latency_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_batch_latency_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_store_batch_latency_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_batch_latency_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_lookup_latency_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_store_lookup_latency_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_lookup_latency_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_memory_store_lock_duration_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_store_memory_store_lock_duration_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_memory_store_lock_duration_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_read_tx_latency_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_store_read_tx_latency_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_read_tx_latency_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_write_tx_latency_seconds_bucket	Unknown	`ip`, `cls`, `ins`, `job`, `instance`, `le`	N/A
swarm_store_write_tx_latency_seconds_count	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
swarm_store_write_tx_latency_seconds_sum	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A
up	Unknown	`ip`, `cls`, `ins`, `job`, `instance`	N/A

FAQ

Mon, 01 Jan 0001 00:00:00 +0000

Who Can Run Docker Commands?

By default, Pigsty adds both the management user running the playbook on the remote node (i.e., the SSH login user on the target node) and the admin user specified in the node_admin_username parameter to the Docker operating system group. All users in this group (docker) can manage Docker using the docker CLI command.

If you want other users to be able to run Docker commands, add that OS user to the docker group: