1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.orchestrator;
import com.yahoo.config.provision.ApplicationId;
import com.yahoo.vespa.applicationmodel.ApplicationInstanceReference;
import com.yahoo.vespa.applicationmodel.HostName;
import com.yahoo.vespa.orchestrator.policy.BatchHostStateChangeDeniedException;
import com.yahoo.vespa.orchestrator.policy.HostStateChangeDeniedException;
import com.yahoo.vespa.orchestrator.status.ApplicationInstanceStatus;
import com.yahoo.vespa.orchestrator.status.HostInfo;
import com.yahoo.vespa.orchestrator.status.HostStatus;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
/**
* The orchestrator is used to coordinate the need of vespa services to restart or
* disconnect from normal operations for debugging or maintenance. We are not coordinating on the service
* level but rather on the granularity of host and application instance.
*
* (A host will have multiple services and an application will have multiple hots)
*
* A policy decides how many hosts can go down at the same time based on which services that runs
* on the hosts, the redundancy in the system, coverage requirements and potentially more
* (see policies for details).
*
* An application level suspend - enables all services to go down at the same time and bypasses the
* host level state and the host level policies.
* This is used for parallel upgrade and larger maintenance tasks.
*
* @author smorgrav
*/
public interface Orchestrator {
/**
* Get orchestrator information related to a host.
*/
Host getHost(HostName hostName) throws HostNameNotFoundException;
/**
* Get the status of a given node. If no state is recorded
* then this will return the status 'No Remarks'
*
* @param hostName The FQDN which are used in the noderepo.
* @return The enum describing the current state.
* @throws HostNameNotFoundException if hostName is not associated with any application
*/
HostStatus getNodeStatus(HostName hostName) throws HostNameNotFoundException;
/** Get host info for hostname in application, returning no-remarks if not in application. */
HostInfo getHostInfo(ApplicationInstanceReference reference, HostName hostname);
/**
* Returns a lambda, which when invoked with a hostname, returns its current host info.
*
* <p>When invoked multiple times, the hostname/host info mapping is not necessarily consistent.
* Prefer this to {@link #getNodeStatus(HostName)} when consistency is not required,
* and when doing bulk reads.</p>
*
* @return a mapping from host names to their statuses. Unknown hosts map to {@code Optional.empty()}.
*/
Function<HostName, Optional<HostInfo>> getHostResolver();
void setNodeStatus(HostName hostName, HostStatus state) throws OrchestrationException;
/**
* Resume normal operation for this host.
*
* @param hostName The FQDN
* @throws HostStateChangeDeniedException if the request cannot be meet due to policy constraints.
* @throws HostNameNotFoundException if the hostName is not recognized in the system (node repo)
*/
void resume(HostName hostName) throws HostStateChangeDeniedException, HostNameNotFoundException;
/**
* Suspend normal operations for this host.
*
* @param hostName The FQDN
* @throws HostStateChangeDeniedException if the request cannot be meet due to policy constraints.
* @throws HostNameNotFoundException if the hostName is not recognized in the system (node repo)
*/
void suspend(HostName hostName) throws HostStateChangeDeniedException, HostNameNotFoundException;
/**
* Acquire permission to remove a node permanently from the application, or otherwise throw
* {@link OrchestrationException}.
*/
void acquirePermissionToRemove(HostName hostName) throws OrchestrationException;
/**
* Suspend several hosts. On failure, all hosts are resumed before exiting the method with an exception.
*/
void suspendAll(HostName parentHostname, List<HostName> hostNames)
throws BatchInternalErrorException, BatchHostStateChangeDeniedException, BatchHostNameNotFoundException;
/**
* Get the orchestrator status of the application instance.
*
* @param appId Identifier of the application to check
* @return The enum describing the current state.
*/
ApplicationInstanceStatus getApplicationInstanceStatus(ApplicationId appId) throws ApplicationIdNotFoundException;
/**
* Returns all application instances that are suspended. The intention is to use this
* for visualization, informational and debugging purposes.
*
* @return A Map between the application instance and its status.
*/
Set<ApplicationId> getAllSuspendedApplications();
/**
* Resume normal orchestration for hosts belonging to this application.
*
* @param appId Identifier of the application to resume
*/
void resume(ApplicationId appId) throws ApplicationStateChangeDeniedException, ApplicationIdNotFoundException;
/**
* Suspend an application: All hosts will allow suspension in parallel.
* CAUTION: Only use this if the application is not in service.
*
* @param appId Identifier of the application to resume
*/
void suspend(ApplicationId appId) throws ApplicationStateChangeDeniedException, ApplicationIdNotFoundException;
/**
* Whether each content cluster is currently allowed to go down. This indicates the deployment is "in sync".
*/
default boolean isQuiescent(ApplicationId id) { return false; }
}
|
