-
Notifications
You must be signed in to change notification settings - Fork 567
/
api_server.go
153 lines (138 loc) · 6.07 KB
/
api_server.go
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
package server
import (
"context"
"fmt"
"time"
"go.uber.org/zap"
"google.golang.org/protobuf/proto"
"github.com/pachyderm/pachyderm/v2/src/admin"
"github.com/pachyderm/pachyderm/v2/src/auth"
"github.com/pachyderm/pachyderm/v2/src/internal/coredb"
"github.com/pachyderm/pachyderm/v2/src/internal/dbutil"
"github.com/pachyderm/pachyderm/v2/src/internal/errors"
"github.com/pachyderm/pachyderm/v2/src/internal/log"
"github.com/pachyderm/pachyderm/v2/src/internal/pachconfig"
"github.com/pachyderm/pachyderm/v2/src/internal/pachsql"
"github.com/pachyderm/pachyderm/v2/src/internal/weblinker"
"github.com/pachyderm/pachyderm/v2/src/pfs"
"github.com/pachyderm/pachyderm/v2/src/version"
"github.com/pachyderm/pachyderm/v2/src/version/versionpb"
)
// Env is the set of dependencies required by an APIServer
type Env struct {
ClusterID string
Config *pachconfig.Configuration
PFSServer pfs.APIServer
Paused bool
DB *pachsql.DB
}
// APIServer represents an APIServer
type APIServer interface {
admin.APIServer
}
// NewAPIServer returns a new admin.APIServer
func NewAPIServer(env Env) APIServer {
var host string
var tls bool
if pachd := env.Config.PachdSpecificConfiguration; pachd != nil {
host = pachd.ProxyHost
tls = pachd.ProxyTLS
}
l := &weblinker.Linker{
HTTPS: tls,
HostPort: host,
Version: version.Version,
}
return &apiServer{
clusterInfo: &admin.ClusterInfo{
Id: env.ClusterID,
DeploymentId: env.Config.DeploymentID,
WarningsOk: true,
ProxyHost: host,
ProxyTls: tls,
Paused: env.Paused,
WebResources: &admin.WebResource{
ArchiveDownloadBaseUrl: l.ArchiveDownloadBaseURL(),
CreatePipelineRequestJsonSchemaUrl: l.CreatePipelineRequestJSONSchemaURL(),
},
},
pfsServer: env.PFSServer,
db: env.DB,
}
}
type apiServer struct {
admin.UnsafeAPIServer
clusterInfo *admin.ClusterInfo
pfsServer pfs.APIServer
db *pachsql.DB
}
const (
msgNoVersionReq = "WARNING: The client used to connect to Pachyderm did not send its version, which means that it is likely too old. Please upgrade it."
msgClientTooOld = "WARNING: The client used to connect to Pachyderm is much older than the server; please upgrade the client."
msgServerTooOld = "WARNING: The client used to connect to Pachyderm is much newer than the server; please use a version of the client that matches the server."
fmtServerIsPreview = "WARNING: The client used to connect to Pachyderm is not the same version as the server; only %s is compatible because the server is running a pre-release version."
fmtClientIsPreview = "WARNING: The client used to connect to Pachyderm is a pre-release version not compatible with the server; please use a released version compatible with %s."
fmtInspectProjectError = "WARNING: Could not inspect project %q: %v"
fmtGetClusterMetadataError = "WARNING: Could not get cluster metadata: %v"
)
func (a *apiServer) InspectCluster(ctx context.Context, request *admin.InspectClusterRequest) (*admin.ClusterInfo, error) {
response := &admin.ClusterInfo{}
proto.Merge(response, a.clusterInfo)
serverVersion := version.Version
if serverVersion == nil {
// This is very much a "can't happen".
log.Error(ctx, "internal error: no version information set in version.Version; rebuild Pachyderm")
return response, nil
}
clientVersion := request.GetClientVersion()
if clientVersion == nil {
log.Info(ctx, "version skew: client called InspectCluster without sending its version; it is probably outdated and needs to be upgraded")
response.Warnings = append(response.Warnings, msgNoVersionReq)
clientVersion = serverVersion // now skip the rest of the version checks
}
if err := versionpb.IsCompatible(clientVersion, serverVersion); err != nil {
log.Info(ctx, "version skew: client is using an incompatible version", zap.Error(err), zap.String("clientVersion", clientVersion.Canonical()), zap.String("serverVersion", serverVersion.Canonical()))
if errors.Is(err, versionpb.ErrClientTooOld) {
response.Warnings = append(response.Warnings, msgClientTooOld)
}
if errors.Is(err, versionpb.ErrServerTooOld) {
response.Warnings = append(response.Warnings, msgServerTooOld)
}
if errors.Is(err, versionpb.ErrIncompatiblePreview) {
if serverVersion.Additional != "" {
response.Warnings = append(response.Warnings, fmt.Sprintf(fmtServerIsPreview, serverVersion.Canonical()))
} else if clientVersion.Additional != "" {
response.Warnings = append(response.Warnings, fmt.Sprintf(fmtClientIsPreview, serverVersion.Canonical()))
}
}
}
if n := request.GetCurrentProject().GetName(); n != "" {
if a.pfsServer == nil {
response.Warnings = append(response.Warnings, fmt.Sprintf("PFS server not running; cannot check existence of project %s", request.GetCurrentProject()))
} else if _, err := a.pfsServer.InspectProject(ctx, &pfs.InspectProjectRequest{Project: request.GetCurrentProject()}); err != nil && !(auth.IsErrNotSignedIn(err) || auth.IsErrBadToken(err) || auth.IsErrExpiredToken(err) || auth.IsErrNoMetadata(err)) {
// ErrNotSignedIn, ErrBadToken, ErrExpiredToken &
// ErrNoMetadata are ignored because they indicate that
// the project could not be checked for existence at
// all.
response.Warnings = append(response.Warnings, fmt.Sprintf(fmtInspectProjectError, request.GetCurrentProject(), err))
}
}
if a.db != nil {
if err := dbutil.WithTx(ctx, a.db, func(ctx context.Context, tx *pachsql.Tx) error {
// Since InspectCluster is on the critical path for every command, bound the
// time we spend waiting for the database.
ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()
md, err := coredb.GetClusterMetadata(ctx, tx)
if err != nil {
return errors.Wrap(err, "get cluster metadata")
}
response.Metadata = md
return nil
}); err != nil {
response.Metadata = nil // Since the transaction might have rolled back, we can't trust the metadata added above.
response.Warnings = append(response.Warnings, fmt.Sprintf(fmtGetClusterMetadataError, err))
}
}
return response, nil
}