com.yahoo.config.provision.HostSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-provisioning Show documentation
Provisioning APIs.
There is a newer version: 8.441.21
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.provision;

import com.yahoo.component.Version;

import java.util.Objects;
import java.util.Optional;

/**
 * A specification of a host and its role.
 * Equality and order is determined by the host name.
 *
 * @author hmusum
 */
public class HostSpec implements Comparable {

    /** The name of this host */
    private final String hostname;

    private final NodeResources realResources;
    private final NodeResources advertisedResources;
    private final NodeResources requestedResources;

    /** The current membership role of this host in the cluster it belongs to */
    private final Optional membership;

    private final Optional version;

    private final Optional dockerImageRepo;

    private final Optional networkPorts;

    /** Create a host in a non-cloud system, where hosts are specified in config */
    public HostSpec(String hostname, Optional networkPorts) {
        this(hostname,
             NodeResources.unspecified(), NodeResources.unspecified(), NodeResources.unspecified(),
             Optional.empty(), Optional.empty(), networkPorts, Optional.empty());
    }

    /** Create a host in a hosted system */
    public HostSpec(String hostname,
                    NodeResources realResources,
                    NodeResources advertisedResources,
                    NodeResources requestedResources,
                    ClusterMembership membership,
                    Optional version,
                    Optional networkPorts,
                    Optional dockerImageRepo) {
        this(hostname,
             realResources,
             advertisedResources,
             requestedResources,
             Optional.of(membership),
             version,
             networkPorts,
             dockerImageRepo);
    }

    private HostSpec(String hostname,
                     NodeResources realResources,
                     NodeResources advertisedResurces,
                     NodeResources requestedResources,
                     Optional membership,
                     Optional version,
                     Optional networkPorts,
                     Optional dockerImageRepo) {
        if (hostname == null || hostname.isEmpty()) throw new IllegalArgumentException("Hostname must be specified");
        this.hostname = hostname;
        this.realResources = Objects.requireNonNull(realResources);
        this.advertisedResources = Objects.requireNonNull(advertisedResurces);
        this.requestedResources = Objects.requireNonNull(requestedResources, "RequestedResources cannot be null");
        this.membership = Objects.requireNonNull(membership);
        this.version = Objects.requireNonNull(version, "Version cannot be null but can be empty");
        this.networkPorts = Objects.requireNonNull(networkPorts, "Network ports cannot be null but can be empty");
        this.dockerImageRepo = Objects.requireNonNull(dockerImageRepo, "Docker image repo cannot be null but can be empty");
    }

    /** Returns the name identifying this host */
    public String hostname() { return hostname; }

    /** The real resources available for Vespa processes on this node, after subtracting infrastructure overhead. */
    public NodeResources realResources() { return realResources; }

    /** The total advertised resources of this node, typically matching what's requested. */
    public NodeResources advertisedResources() { return advertisedResources; }

    /** Returns the current version of Vespa running on this node, or empty if not known */
    public Optional version() { return version; }

    /** Returns the membership of this host, or an empty value if not present */
    public Optional membership() { return membership; }

    /** Returns the network port allocations on this host, or empty if not present */
    public Optional networkPorts() { return networkPorts; }

    /** Returns the requested resources leading to this host being provisioned, or empty if unspecified */
    public Optional requestedResources() { return requestedResources.asOptional(); }

    public Optional dockerImageRepo() { return dockerImageRepo; }

    public HostSpec withPorts(Optional ports) {
        return new HostSpec(hostname, realResources, advertisedResources, requestedResources, membership, version, ports, dockerImageRepo);
    }

    @Override
    public String toString() {
        return hostname +
               (membership.isPresent() ? " (membership: " + membership.get() + ")" : " (no membership)");
    }

    @Override
    public boolean equals(Object other) {
        if (other == this) return true;
        if ( ! (other instanceof HostSpec)) return false;

        return ((HostSpec)other).hostname.equals(this.hostname);
    }

    @Override
    public int hashCode() {
        return hostname.hashCode();
    }

    @Override
    public int compareTo(HostSpec other) {
        return hostname.compareTo(other.hostname);
    }

}