-
Notifications
You must be signed in to change notification settings - Fork 42
/
api.go
308 lines (258 loc) · 9 KB
/
api.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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
// Copyright Nitric Pty Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package deploy
import (
"encoding/base64"
"fmt"
"net/http"
"strings"
"github.com/nitrictech/nitric/cloud/common/deploy/resources"
"github.com/nitrictech/nitric/core/pkg/help"
deploymentspb "github.com/nitrictech/nitric/core/pkg/proto/deployments/v1"
"github.com/getkin/kin-openapi/openapi2"
"github.com/getkin/kin-openapi/openapi2conv"
"github.com/getkin/kin-openapi/openapi3"
"github.com/pkg/errors"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/apigateway"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/cloudrun"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
common "github.com/nitrictech/nitric/cloud/common/deploy/tags"
"github.com/nitrictech/nitric/cloud/common/deploy/utils"
)
type nameUrlPair struct {
name string
invokeUrl string
}
func (p *NitricGcpPulumiProvider) Api(ctx *pulumi.Context, parent pulumi.Resource, name string, apiConfig *deploymentspb.Api) error {
opts := append([]pulumi.ResourceOption{}, pulumi.Parent(parent))
if apiConfig.GetOpenapi() == "" {
return fmt.Errorf("gcp provider can only deploy OpenAPI specs")
}
openapiDoc := &openapi3.T{}
err := openapiDoc.UnmarshalJSON([]byte(apiConfig.GetOpenapi()))
if err != nil {
return fmt.Errorf("invalid document supplied for api: %s", name)
}
// augment document with security definitions
for sn, sd := range openapiDoc.Components.SecuritySchemes {
if sd.Value.Type == "openIdConnect" {
// We need to extract audience values from the extensions
// the extension is type of []interface and cannot be converted to []string directly
audiences, err := utils.GetAudiencesFromExtension(sd.Value.Extensions)
if err != nil {
return err
}
oidConf, err := utils.GetOpenIdConnectConfig(sd.Value.OpenIdConnectUrl)
if err != nil {
return err
}
openapiDoc.Components.SecuritySchemes[sn] = &openapi3.SecuritySchemeRef{
Value: &openapi3.SecurityScheme{
Type: "oauth2",
Flows: &openapi3.OAuthFlows{
Implicit: &openapi3.OAuthFlow{
AuthorizationURL: oidConf.AuthEndpoint,
},
},
Extensions: map[string]interface{}{
"x-google-issuer": oidConf.Issuer,
"x-google-jwks_uri": oidConf.JwksUri,
"x-google-audiences": strings.Join(audiences, ","),
},
},
}
} else {
return fmt.Errorf("unsupported security definition supplied")
}
}
v2doc, err := openapi2conv.FromV3(openapiDoc)
if err != nil {
return err
}
// Get service targets for IAM binding
services := p.CloudRunServices
for _, pi := range v2doc.Paths {
for _, m := range []string{http.MethodGet, http.MethodPatch, http.MethodDelete, http.MethodPost, http.MethodPut} {
if pi.GetOperation(m) == nil {
continue
}
name, ok := keepOperation(pi.GetOperation(m).Extensions)
if !ok {
return fmt.Errorf("found operation missing nitric target property: %+v", pi.GetOperation(m).Extensions)
}
if _, ok := p.CloudRunServices[name]; !ok {
return fmt.Errorf("unable to find target service %s in %+v", name, p.CloudRunServices)
}
services[name] = p.CloudRunServices[name]
break
}
}
nameUrlPairs := make([]interface{}, 0, len(services))
// collect name arn pairs for output iteration
for k, v := range services {
nameUrlPairs = append(nameUrlPairs, pulumi.All(k, v.Url).ApplyT(func(args []interface{}) (nameUrlPair, error) {
name, nameOk := args[0].(string)
url, urlOk := args[1].(string)
if !nameOk || !urlOk {
return nameUrlPair{}, fmt.Errorf("invalid data %T %v", args, args)
}
return nameUrlPair{
name: name,
invokeUrl: url,
}, nil
}))
}
// Now we need to create the document provided and interpolate the deployed service targets
// i.e. their Urls...
// Replace Nitric API Extensions with google api gateway extensions
doc := pulumi.All(nameUrlPairs...).ApplyT(func(pairs []interface{}) (string, error) {
naps := make(map[string]string)
for _, p := range pairs {
if pair, ok := p.(nameUrlPair); ok {
naps[pair.name] = pair.invokeUrl
} else {
return "", fmt.Errorf("failed to resolve Cloud Run container URL for api %s, invalid name URL pair value %T %v, %s", name, p, p, help.BugInNitricHelpText())
}
}
for k, p := range v2doc.Paths {
p.Get = gcpOperation(name, p.Get, naps)
p.Post = gcpOperation(name, p.Post, naps)
p.Patch = gcpOperation(name, p.Patch, naps)
p.Put = gcpOperation(name, p.Put, naps)
p.Delete = gcpOperation(name, p.Delete, naps)
p.Options = gcpOperation(name, p.Options, naps)
v2doc.Paths[k] = p
}
b, err := v2doc.MarshalJSON()
if err != nil {
return "", err
}
return base64.StdEncoding.EncodeToString(b), nil
}).(pulumi.StringOutput)
resourceLabels := common.Tags(p.StackId, name, resources.API)
api, err := apigateway.NewApi(ctx, name, &apigateway.ApiArgs{
ApiId: pulumi.String(name),
Labels: pulumi.ToStringMap(resourceLabels),
}, p.WithDefaultResourceOptions(opts...)...)
if err != nil {
return errors.WithMessage(err, "api "+name)
}
svcAcct, err := NewServiceAccount(ctx, name+"-api-invoker", &GcpIamServiceAccountArgs{
AccountId: name + "-api",
}, p.WithDefaultResourceOptions(opts...)...)
if err != nil {
return errors.WithMessage(err, "api serviceaccount "+name)
}
// Bind that IAM account as a member of all available service targets
for _, serv := range services {
iamName := fmt.Sprintf("%s-%s-binding", name, serv.Name)
_, err = cloudrun.NewIamMember(ctx, iamName, &cloudrun.IamMemberArgs{
Service: serv.Service.Name,
Location: serv.Service.Location,
Member: pulumi.Sprintf("serviceAccount:%s", svcAcct.ServiceAccount.Email),
Role: pulumi.String("roles/run.invoker"),
}, p.WithDefaultResourceOptions(opts...)...)
if err != nil {
return errors.WithMessage(err, "api iamMember "+iamName)
}
}
// Deploy the config
config, err := apigateway.NewApiConfig(ctx, name+"-config", &apigateway.ApiConfigArgs{
Project: pulumi.String(p.GcpConfig.ProjectId),
Api: api.ApiId,
DisplayName: pulumi.String(name + "-config"),
OpenapiDocuments: apigateway.ApiConfigOpenapiDocumentArray{
apigateway.ApiConfigOpenapiDocumentArgs{
Document: apigateway.ApiConfigOpenapiDocumentDocumentArgs{
Path: pulumi.String("openapi.json"),
Contents: doc,
},
},
},
GatewayConfig: apigateway.ApiConfigGatewayConfigArgs{
BackendConfig: apigateway.ApiConfigGatewayConfigBackendConfigArgs{
// Add the service account for the invoker here...
GoogleServiceAccount: svcAcct.ServiceAccount.Email,
},
},
Labels: pulumi.ToStringMap(resourceLabels),
}, p.WithDefaultResourceOptions(append(opts, pulumi.ReplaceOnChanges([]string{"*"}))...)...)
if err != nil {
return errors.WithMessage(err, "api config")
}
// Deploy the gateway
p.ApiGateways[name], err = apigateway.NewGateway(ctx, name+"-gateway", &apigateway.GatewayArgs{
DisplayName: pulumi.String(name + "-gateway"),
GatewayId: pulumi.String(name + "-gateway"),
ApiConfig: pulumi.Sprintf("projects/%s/locations/global/apis/%s/configs/%s", p.GcpConfig.ProjectId, api.ApiId, config.ApiConfigId),
Labels: pulumi.ToStringMap(resourceLabels),
}, p.WithDefaultResourceOptions(opts...)...)
if err != nil {
return errors.WithMessage(err, "api gateway")
}
// url := res.Gateway.DefaultHostname.ApplyT(func(hn string) string { return "https://" + hn })
// ctx.Export("api:"+name, url)
return nil
}
func keepOperation(opExt map[string]interface{}) (string, bool) {
if opExt == nil {
return "", false
}
name := ""
if v, ok := opExt["x-nitric-target"]; ok {
targetMap, isMap := v.(map[string]interface{})
if isMap {
name, _ = targetMap["name"].(string)
}
}
if name == "" {
return "", false
}
return name, true
}
func gcpOperation(apiName string, op *openapi2.Operation, urls map[string]string) *openapi2.Operation {
if op == nil {
return nil
}
name, ok := keepOperation(op.Extensions)
if !ok {
return nil
}
if _, ok := urls[name]; !ok {
return nil
}
if s, ok := op.Extensions["x-nitric-security"]; ok {
secName, isString := s.(string)
if isString {
op.Security = &openapi2.SecurityRequirements{
{
secName: {},
},
}
}
}
for i, r := range op.Responses {
if r.Description == "" {
op.Responses[i].Description = name
}
}
op.Extensions["x-google-backend"] = map[string]string{
// Append the name of the target origin api gateway to the target address
"address": fmt.Sprintf("%s/x-nitric-api/%s", urls[name], apiName),
"path_translation": "APPEND_PATH_TO_ADDRESS",
}
return op
}