com.yahoo.vespa.hosted.provision.node.Allocation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of node-repository Show documentation

Keeps track of node assignment in a multi-application setup.

There is a newer version: 8.458.13

// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.provision.node;

import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.ClusterMembership;
import com.yahoo.vespa.hosted.provision.Node;

/**
 * The allocation of a node
 *
 * @author bratseth
 */
public class Allocation {

    private final ApplicationId owner;
    private final ClusterMembership clusterMembership;

    /**
     * Restart generation, see {@link com.yahoo.vespa.hosted.provision.node.Generation},
     * wanted is increased when a restart of the services on the node is needed, current is updated
     * when a restart has been done on the node.
     */
    private final Generation restartGeneration;

    /** This node can (and should) be removed from the cluster on the next deployment */
    private final boolean removable;

    public Allocation(ApplicationId owner, ClusterMembership clusterMembership,
                      Generation restartGeneration, boolean removable) {
        this.owner = owner;
        this.clusterMembership = clusterMembership;
        this.restartGeneration = restartGeneration;
        this.removable = removable;
    }

    /** Returns the id of the application this is allocated to */
    public ApplicationId owner() { return owner; }

    /** Returns the role this node is allocated to */
    public ClusterMembership membership() { return clusterMembership; }

    /** Returns the restart generation (wanted and current) of this */
    public Generation restartGeneration() { return restartGeneration; }

    /** Returns a copy of this which is retired */
    public Allocation retire() { return new Allocation(owner, clusterMembership.retire(), restartGeneration, removable); }

    /** Returns a copy of this which is not retired */
    public Allocation unretire() { return new Allocation(owner, clusterMembership.unretire(), restartGeneration, removable); }

    /** Return whether this node is ready to be removed from the application */
    public boolean isRemovable() { return removable; }

    /** Returns a copy of this with the current restart generation set to generation */
    public Allocation withRestart(Generation generation) {
        return new Allocation(owner, clusterMembership, generation, removable);
    }

    /** Returns a copy of this allocation where removable is set to true */
    public Allocation removable() {
        return new Allocation(owner, clusterMembership, restartGeneration, true);
    }

    public Allocation with(ClusterMembership newMembership) {
        return new Allocation(owner, newMembership, restartGeneration, removable);
    }

    @Override
    public String toString() { return "allocated to " + owner + " as '" + clusterMembership + "'"; }

}