view release on metacpan or  search on metacpan

lib/API/Docker/Type/SystemInfo.pm  view on Meta::CPAN

Version of the host's operating system

> B<Note>: The information returned in this field, including its > very
existence, and the formatting of values, should not be considered > stable,
and may change without notice. Serialised as C<OSVersion> -- spelled out,
because deriving it from the Perl name would produce C<OsVersion>.

=head2 os_type

Generic type of the operating system of the host, as returned by the Go
runtime (C<GOOS>).

Currently returned values are "linux" and "windows". A full list of possible
values can be found in the L<Go
documentation|https://go.dev/doc/install/source#environment>. Serialised as
C<OSType> -- spelled out, because deriving it from the Perl name would
produce C<OsType>.

=head2 architecture

Hardware architecture of the host, as returned by the operating system. This
is equivalent to the output of C<uname -m> on Linux.

Unlike C<Arch> (from C</version>), this reports the machine's native
architecture, which can differ from the Go runtime architecture when running
a binary compiled for a different architecture (for example, a 32-bit binary
running on 64-bit hardware).

=head2 n_cpu

The number of logical CPUs usable by the daemon.

The number of available CPUs is checked by querying the operating system
when the daemon starts. Changes to operating system CPU allocation after the
daemon is started are not reflected. Serialised as C<NCPU> -- spelled out,
because deriving it from the Perl name would produce C<NCpu>.

=head2 mem_total

Total amount of physical memory available on the host, in bytes.

=head2 index_server_address

Address / URL of the index server that is used for image search, and as a
default for user authentication for Docker Hub and Docker Cloud.

=head2 registry_config

RegistryServiceConfig stores daemon registry services configuration. See
L<API::Docker::Type::RegistryServiceConfig>.

=head2 generic_resources

User-defined resources can be either Integer resources (e.g, C<SSD=3>) or
String resources (e.g, C<GPU=UUID1>). See
L<API::Docker::Type::GenericResource>.

=head2 http_proxy

HTTP-proxy configured for the daemon. This value is obtained from the
L<C<HTTP_PROXY>|https://www.gnu.org/software/wget/manual/html_node/Proxies.html>
environment variable. Credentials (L<user info
component|https://tools.ietf.org/html/rfc3986#section-3.2.1>) in the proxy
URL are masked in the API response.

Containers do not automatically inherit this configuration.

=head2 https_proxy

HTTPS-proxy configured for the daemon. This value is obtained from the
L<C<HTTPS_PROXY>|https://www.gnu.org/software/wget/manual/html_node/Proxies.html>
environment variable. Credentials (L<user info
component|https://tools.ietf.org/html/rfc3986#section-3.2.1>) in the proxy
URL are masked in the API response.

Containers do not automatically inherit this configuration.

=head2 no_proxy

Comma-separated list of domain extensions for which no proxy should be used.
This value is obtained from the
L<C<NO_PROXY>|https://www.gnu.org/software/wget/manual/html_node/Proxies.html>
environment variable.

Containers do not automatically inherit this configuration.

=head2 name

Hostname of the host.

=head2 labels

User-defined labels (key/value metadata) as set on the daemon.

> B<Note>: When part of a Swarm, nodes can both have I<daemon> labels, > set
through the daemon configuration, and I<node> labels, set from a > manager
node in the Swarm. Node labels are not included in this > field. Node labels
can be retrieved using the C</nodes/(id)> endpoint > on a manager node in
the Swarm.

=head2 experimental_build

Indicates if experimental features are enabled on the daemon.

=head2 server_version

Version string of the daemon.

=head2 runtimes

List of L<OCI compliant|https://github.com/opencontainers/runtime-spec>
runtimes configured on the daemon. Keys hold the "name" used to reference
the runtime.

The Docker daemon relies on an OCI compliant runtime (invoked via the
C<containerd> daemon) as its interface to the Linux kernel namespaces,
cgroups, and SELinux.

The default runtime is C<runc>, and automatically configured. Additional
runtimes can be configured by the user and will be listed here. See
L<API::Docker::Type::Runtime>. B<The keys are the caller's data> and are
never translated.

=head2 default_runtime

Name of the default OCI runtime that is used when starting containers.

The default can be overridden per-container at create time.

=head2 swarm

Represents generic information about swarm. See
L<API::Docker::Type::SwarmInfo>.

=head2 live_restore_enabled

Indicates if live restore is enabled.

If enabled, containers are kept running when the daemon is shutdown or upon
daemon start if running containers are detected. The daemon defaults it to
false.

=head2 isolation

Represents the isolation technology to use as a default for containers. The
supported values are platform-specific.

If no isolation value is specified on daemon start, on Windows client, the
default is C<hyperv>, and on Windows server, the default is C<process>.

This option is currently not used on other platforms.

=head2 init_binary

Name and, optional, path of the C<docker-init> binary.

If the path is omitted, the daemon searches the host's C<$PATH> for the
binary and uses the first result.

=head2 containerd_commit

Commit holds the Git-commit (SHA1) that a binary was built from, as reported
in the version-string of external tools, such as C<containerd>, or C<runC>.
See L<API::Docker::Type::Commit>.

=head2 runc_commit

Commit holds the Git-commit (SHA1) that a binary was built from, as reported
in the version-string of external tools, such as C<containerd>, or C<runC>.
See L<API::Docker::Type::Commit>.

=head2 init_commit

Commit holds the Git-commit (SHA1) that a binary was built from, as reported
in the version-string of external tools, such as C<containerd>, or C<runC>.
See L<API::Docker::Type::Commit>.

=head2 security_options

List of security features that are enabled on the daemon, such as apparmor,