@backstage/plugin-catalog-backend-module-aws 0.1.19-next.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/alpha/package.json +1 -1
- package/dist/alpha.cjs.js +4 -2
- package/dist/alpha.cjs.js.map +1 -1
- package/dist/cjs/{AwsS3EntityProvider-ff893453.cjs.js → AwsS3EntityProvider-16db03d3.cjs.js} +31 -54
- package/dist/cjs/AwsS3EntityProvider-16db03d3.cjs.js.map +1 -0
- package/dist/index.cjs.js +44 -31
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +13 -6
- package/package.json +18 -13
- package/dist/cjs/AwsS3EntityProvider-ff893453.cjs.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-aws
|
|
2
2
|
|
|
3
|
+
## 0.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 1a3b5f1e390: **BREAKING**: AwsOrganizationCloudAccountProcessor.fromConfig now returns a promise instead of the instance directly.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @backstage/backend-common@0.18.5
|
|
13
|
+
- @backstage/integration@1.4.5
|
|
14
|
+
- @backstage/integration-aws-node@0.1.3
|
|
15
|
+
- @backstage/plugin-kubernetes-common@0.6.3
|
|
16
|
+
- @backstage/backend-tasks@0.5.2
|
|
17
|
+
- @backstage/plugin-catalog-node@1.3.6
|
|
18
|
+
- @backstage/backend-plugin-api@0.5.2
|
|
19
|
+
- @backstage/catalog-model@1.3.0
|
|
20
|
+
- @backstage/config@1.0.7
|
|
21
|
+
- @backstage/errors@1.1.5
|
|
22
|
+
- @backstage/types@1.0.2
|
|
23
|
+
- @backstage/plugin-catalog-common@1.0.13
|
|
24
|
+
|
|
3
25
|
## 0.1.19-next.2
|
|
4
26
|
|
|
5
27
|
### Patch Changes
|
package/alpha/package.json
CHANGED
package/dist/alpha.cjs.js
CHANGED
|
@@ -5,12 +5,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
5
5
|
var backendCommon = require('@backstage/backend-common');
|
|
6
6
|
var backendPluginApi = require('@backstage/backend-plugin-api');
|
|
7
7
|
var alpha = require('@backstage/plugin-catalog-node/alpha');
|
|
8
|
-
var AwsS3EntityProvider = require('./cjs/AwsS3EntityProvider-
|
|
8
|
+
var AwsS3EntityProvider = require('./cjs/AwsS3EntityProvider-16db03d3.cjs.js');
|
|
9
9
|
require('@backstage/integration');
|
|
10
10
|
require('@backstage/plugin-catalog-node');
|
|
11
|
-
require('aws-sdk');
|
|
12
11
|
require('@backstage/backend-tasks');
|
|
12
|
+
require('@aws-sdk/client-s3');
|
|
13
13
|
require('uuid');
|
|
14
|
+
require('@aws-sdk/middleware-endpoint');
|
|
15
|
+
require('@backstage/integration-aws-node');
|
|
14
16
|
|
|
15
17
|
const catalogModuleAwsS3EntityProvider = backendPluginApi.createBackendModule({
|
|
16
18
|
pluginId: "catalog",
|
package/dist/alpha.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alpha.cjs.js","sources":["../src/module/catalogModuleAwsS3EntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { AwsS3EntityProvider } from '../providers';\n\n/**\n * Registers the AwsS3EntityProvider with the catalog processing extension point.\n *\n * @alpha\n */\nexport const catalogModuleAwsS3EntityProvider = createBackendModule({\n pluginId: 'catalog',\n moduleId: 'awsS3EntityProvider',\n register(env) {\n env.registerInit({\n deps: {\n config: coreServices.config,\n catalog: catalogProcessingExtensionPoint,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n async init({ config, catalog, logger, scheduler }) {\n catalog.addEntityProvider(\n AwsS3EntityProvider.fromConfig(config, {\n logger: loggerToWinstonLogger(logger),\n scheduler,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","AwsS3EntityProvider","loggerToWinstonLogger"],"mappings":"
|
|
1
|
+
{"version":3,"file":"alpha.cjs.js","sources":["../src/module/catalogModuleAwsS3EntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n coreServices,\n createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { AwsS3EntityProvider } from '../providers';\n\n/**\n * Registers the AwsS3EntityProvider with the catalog processing extension point.\n *\n * @alpha\n */\nexport const catalogModuleAwsS3EntityProvider = createBackendModule({\n pluginId: 'catalog',\n moduleId: 'awsS3EntityProvider',\n register(env) {\n env.registerInit({\n deps: {\n config: coreServices.config,\n catalog: catalogProcessingExtensionPoint,\n logger: coreServices.logger,\n scheduler: coreServices.scheduler,\n },\n async init({ config, catalog, logger, scheduler }) {\n catalog.addEntityProvider(\n AwsS3EntityProvider.fromConfig(config, {\n logger: loggerToWinstonLogger(logger),\n scheduler,\n }),\n );\n },\n });\n },\n});\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","AwsS3EntityProvider","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;AA6BO,MAAM,mCAAmCA,oCAAoB,CAAA;AAAA,EAClE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,qBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,OAAS,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNE,uCAAA,CAAoB,WAAW,MAAQ,EAAA;AAAA,YACrC,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,YACpC,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
|
package/dist/cjs/{AwsS3EntityProvider-ff893453.cjs.js → AwsS3EntityProvider-16db03d3.cjs.js}
RENAMED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
var integration = require('@backstage/integration');
|
|
4
4
|
var pluginCatalogNode = require('@backstage/plugin-catalog-node');
|
|
5
|
-
var AWS = require('aws-sdk');
|
|
6
5
|
var backendTasks = require('@backstage/backend-tasks');
|
|
6
|
+
var clientS3 = require('@aws-sdk/client-s3');
|
|
7
7
|
var uuid = require('uuid');
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
var middlewareEndpoint = require('@aws-sdk/middleware-endpoint');
|
|
9
|
+
var integrationAwsNode = require('@backstage/integration-aws-node');
|
|
10
10
|
|
|
11
11
|
function _interopNamespace(e) {
|
|
12
12
|
if (e && e.__esModule) return e;
|
|
@@ -26,42 +26,8 @@ function _interopNamespace(e) {
|
|
|
26
26
|
return Object.freeze(n);
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
var AWS__default = /*#__PURE__*/_interopDefaultLegacy(AWS);
|
|
30
29
|
var uuid__namespace = /*#__PURE__*/_interopNamespace(uuid);
|
|
31
30
|
|
|
32
|
-
class AwsCredentials {
|
|
33
|
-
/**
|
|
34
|
-
* If accessKeyId and secretAccessKey are missing, the DefaultAWSCredentialsProviderChain will be used:
|
|
35
|
-
* https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html
|
|
36
|
-
*/
|
|
37
|
-
static create(config, roleSessionName) {
|
|
38
|
-
if (!config) {
|
|
39
|
-
return void 0;
|
|
40
|
-
}
|
|
41
|
-
const accessKeyId = config.accessKeyId;
|
|
42
|
-
const secretAccessKey = config.secretAccessKey;
|
|
43
|
-
let explicitCredentials;
|
|
44
|
-
if (accessKeyId && secretAccessKey) {
|
|
45
|
-
explicitCredentials = new AWS.Credentials({
|
|
46
|
-
accessKeyId,
|
|
47
|
-
secretAccessKey
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
const roleArn = config.roleArn;
|
|
51
|
-
if (roleArn) {
|
|
52
|
-
return new AWS__default["default"].ChainableTemporaryCredentials({
|
|
53
|
-
masterCredentials: explicitCredentials,
|
|
54
|
-
params: {
|
|
55
|
-
RoleArn: roleArn,
|
|
56
|
-
RoleSessionName: roleSessionName,
|
|
57
|
-
ExternalId: config.externalId
|
|
58
|
-
}
|
|
59
|
-
});
|
|
60
|
-
}
|
|
61
|
-
return explicitCredentials;
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
|
|
65
31
|
const DEFAULT_PROVIDER_ID = "default";
|
|
66
32
|
function readAwsS3Configs(config) {
|
|
67
33
|
const configs = [];
|
|
@@ -93,21 +59,13 @@ function readAwsS3Config(id, config) {
|
|
|
93
59
|
}
|
|
94
60
|
|
|
95
61
|
class AwsS3EntityProvider {
|
|
96
|
-
constructor(config, integration, logger, taskRunner) {
|
|
62
|
+
constructor(config, integration, awsCredentialsManager, logger, taskRunner) {
|
|
97
63
|
this.config = config;
|
|
64
|
+
this.integration = integration;
|
|
65
|
+
this.awsCredentialsManager = awsCredentialsManager;
|
|
98
66
|
this.logger = logger.child({
|
|
99
67
|
target: this.getProviderName()
|
|
100
68
|
});
|
|
101
|
-
this.s3 = new AWS.S3({
|
|
102
|
-
apiVersion: "2006-03-01",
|
|
103
|
-
credentials: AwsCredentials.create(
|
|
104
|
-
integration.config,
|
|
105
|
-
"backstage-aws-s3-provider"
|
|
106
|
-
),
|
|
107
|
-
endpoint: integration.config.endpoint,
|
|
108
|
-
region: this.config.region,
|
|
109
|
-
s3ForcePathStyle: integration.config.s3ForcePathStyle
|
|
110
|
-
});
|
|
111
69
|
this.scheduleFn = this.createScheduleFn(taskRunner);
|
|
112
70
|
}
|
|
113
71
|
static fromConfig(configRoot, options) {
|
|
@@ -126,10 +84,12 @@ class AwsS3EntityProvider {
|
|
|
126
84
|
`No schedule provided neither via code nor config for awsS3-provider:${providerConfig.id}.`
|
|
127
85
|
);
|
|
128
86
|
}
|
|
87
|
+
const awsCredentialsManager = integrationAwsNode.DefaultAwsCredentialsManager.fromConfig(configRoot);
|
|
129
88
|
const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
|
|
130
89
|
return new AwsS3EntityProvider(
|
|
131
90
|
providerConfig,
|
|
132
91
|
integration$1,
|
|
92
|
+
awsCredentialsManager,
|
|
133
93
|
options.logger,
|
|
134
94
|
taskRunner
|
|
135
95
|
);
|
|
@@ -162,6 +122,23 @@ class AwsS3EntityProvider {
|
|
|
162
122
|
/** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
|
|
163
123
|
async connect(connection) {
|
|
164
124
|
this.connection = connection;
|
|
125
|
+
const credProvider = await this.awsCredentialsManager.getCredentialProvider();
|
|
126
|
+
this.s3 = new clientS3.S3({
|
|
127
|
+
apiVersion: "2006-03-01",
|
|
128
|
+
credentialDefaultProvider: () => credProvider.sdkCredentialProvider,
|
|
129
|
+
endpoint: this.integration.config.endpoint,
|
|
130
|
+
region: this.config.region,
|
|
131
|
+
forcePathStyle: this.integration.config.s3ForcePathStyle
|
|
132
|
+
});
|
|
133
|
+
const endpoint = await middlewareEndpoint.getEndpointFromInstructions(
|
|
134
|
+
{
|
|
135
|
+
Bucket: this.config.bucketName
|
|
136
|
+
},
|
|
137
|
+
clientS3.ListObjectsV2Command,
|
|
138
|
+
this.s3.config
|
|
139
|
+
);
|
|
140
|
+
if (endpoint == null ? void 0 : endpoint.url)
|
|
141
|
+
this.endpoint = endpoint.url.href.endsWith("/") ? endpoint.url.href : `${endpoint.url.href}/`;
|
|
165
142
|
await this.scheduleFn();
|
|
166
143
|
}
|
|
167
144
|
async refresh(logger) {
|
|
@@ -184,16 +161,18 @@ class AwsS3EntityProvider {
|
|
|
184
161
|
logger.info(`Committed ${locations.length} Locations for AWS S3 objects`);
|
|
185
162
|
}
|
|
186
163
|
async listAllObjectKeys() {
|
|
164
|
+
if (!this.s3) {
|
|
165
|
+
throw new Error("Not initialized");
|
|
166
|
+
}
|
|
187
167
|
const keys = [];
|
|
188
168
|
let continuationToken = void 0;
|
|
189
169
|
let output;
|
|
190
170
|
do {
|
|
191
|
-
|
|
171
|
+
output = await this.s3.listObjectsV2({
|
|
192
172
|
Bucket: this.config.bucketName,
|
|
193
173
|
ContinuationToken: continuationToken,
|
|
194
174
|
Prefix: this.config.prefix
|
|
195
175
|
});
|
|
196
|
-
output = await request.promise();
|
|
197
176
|
if (output.Contents) {
|
|
198
177
|
output.Contents.forEach((item) => {
|
|
199
178
|
if (item.Key && !item.Key.endsWith("/")) {
|
|
@@ -213,11 +192,9 @@ class AwsS3EntityProvider {
|
|
|
213
192
|
};
|
|
214
193
|
}
|
|
215
194
|
createObjectUrl(key) {
|
|
216
|
-
|
|
217
|
-
const endpoint = this.s3.endpoint.href;
|
|
218
|
-
return encodeURI(`${endpoint}${bucketName}/${key}`);
|
|
195
|
+
return new URL(key, this.endpoint).href;
|
|
219
196
|
}
|
|
220
197
|
}
|
|
221
198
|
|
|
222
199
|
exports.AwsS3EntityProvider = AwsS3EntityProvider;
|
|
223
|
-
//# sourceMappingURL=AwsS3EntityProvider-
|
|
200
|
+
//# sourceMappingURL=AwsS3EntityProvider-16db03d3.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AwsS3EntityProvider-16db03d3.cjs.js","sources":["../../src/providers/config.ts","../../src/providers/AwsS3EntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { AwsS3Config } from './types';\n\nconst DEFAULT_PROVIDER_ID = 'default';\n\nexport function readAwsS3Configs(config: Config): AwsS3Config[] {\n const configs: AwsS3Config[] = [];\n\n const providerConfigs = config.getOptionalConfig('catalog.providers.awsS3');\n if (!providerConfigs) {\n return configs;\n }\n\n if (providerConfigs.has('bucketName')) {\n // simple/single config variant\n configs.push(readAwsS3Config(DEFAULT_PROVIDER_ID, providerConfigs));\n\n return configs;\n }\n\n for (const id of providerConfigs.keys()) {\n configs.push(readAwsS3Config(id, providerConfigs.getConfig(id)));\n }\n\n return configs;\n}\n\nfunction readAwsS3Config(id: string, config: Config): AwsS3Config {\n const bucketName = config.getString('bucketName');\n const region = config.getOptionalString('region');\n const prefix = config.getOptionalString('prefix');\n\n const schedule = config.has('schedule')\n ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n : undefined;\n\n return {\n id,\n bucketName,\n region,\n prefix,\n schedule,\n };\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { AwsS3Integration, ScmIntegrations } from '@backstage/integration';\nimport {\n EntityProvider,\n EntityProviderConnection,\n locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { readAwsS3Configs } from './config';\nimport { AwsS3Config } from './types';\nimport {\n ListObjectsV2Command,\n ListObjectsV2Output,\n S3,\n} from '@aws-sdk/client-s3';\nimport * as uuid from 'uuid';\nimport { Logger } from 'winston';\nimport { getEndpointFromInstructions } from '@aws-sdk/middleware-endpoint';\nimport {\n AwsCredentialsManager,\n DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\n\n// TODO: event-based updates using S3 events (+ queue like SQS)?\n/**\n * Provider which discovers catalog files (any name) within an S3 bucket.\n *\n * Use `AwsS3EntityProvider.fromConfig(...)` to create instances.\n *\n * @public\n */\nexport class AwsS3EntityProvider implements EntityProvider {\n private readonly logger: Logger;\n private s3?: S3;\n private readonly scheduleFn: () => Promise<void>;\n private connection?: EntityProviderConnection;\n private endpoint?: string;\n\n static fromConfig(\n configRoot: Config,\n options: {\n logger: Logger;\n schedule?: TaskRunner;\n scheduler?: PluginTaskScheduler;\n },\n ): AwsS3EntityProvider[] {\n const providerConfigs = readAwsS3Configs(configRoot);\n\n // Even though the awsS3 integration allows a config array\n // there is no *real* support for multiple configs.\n // Usually, there will be just the integration for the default host.\n // In case, a custom endpoint is used, the host from this endpoint\n // will be extracted and used as host (e.g., localhost when used with LocalStack)\n // and the default integration will be added as second integration.\n // In this case, we still want the first one though, but have no means to select it\n // just from the bucket name (and region).\n const integration = ScmIntegrations.fromConfig(configRoot).awsS3.list()[0];\n if (!integration) {\n throw new Error('No integration found for awsS3');\n }\n\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n return providerConfigs.map(providerConfig => {\n if (!options.schedule && !providerConfig.schedule) {\n throw new Error(\n `No schedule provided neither via code nor config for awsS3-provider:${providerConfig.id}.`,\n );\n }\n const awsCredentialsManager =\n DefaultAwsCredentialsManager.fromConfig(configRoot);\n const taskRunner =\n options.schedule ??\n options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n return new AwsS3EntityProvider(\n providerConfig,\n integration,\n awsCredentialsManager,\n options.logger,\n taskRunner,\n );\n });\n }\n\n private constructor(\n private readonly config: AwsS3Config,\n private readonly integration: AwsS3Integration,\n private readonly awsCredentialsManager: AwsCredentialsManager,\n logger: Logger,\n taskRunner: TaskRunner,\n ) {\n this.logger = logger.child({\n target: this.getProviderName(),\n });\n\n this.scheduleFn = this.createScheduleFn(taskRunner);\n }\n\n private createScheduleFn(taskRunner: TaskRunner): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class: AwsS3EntityProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(`${this.getProviderName()} refresh failed`, error);\n }\n },\n });\n };\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n getProviderName(): string {\n return `awsS3-provider:${this.config.id}`;\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n const credProvider =\n await this.awsCredentialsManager.getCredentialProvider();\n this.s3 = new S3({\n apiVersion: '2006-03-01',\n credentialDefaultProvider: () => credProvider.sdkCredentialProvider,\n endpoint: this.integration.config.endpoint,\n region: this.config.region,\n forcePathStyle: this.integration.config.s3ForcePathStyle,\n });\n\n // https://github.com/aws/aws-sdk-js-v3/issues/4122#issuecomment-1298968804\n const endpoint = await getEndpointFromInstructions(\n {\n Bucket: this.config.bucketName,\n },\n ListObjectsV2Command,\n this.s3.config as unknown as Record<string, unknown>,\n );\n if (endpoint?.url)\n this.endpoint = endpoint.url.href.endsWith('/')\n ? endpoint.url.href\n : `${endpoint.url.href}/`;\n await this.scheduleFn();\n }\n\n async refresh(logger: Logger) {\n if (!this.connection) {\n throw new Error('Not initialized');\n }\n\n logger.info('Discovering AWS S3 objects');\n\n const keys = await this.listAllObjectKeys();\n logger.info(`Discovered ${keys.length} AWS S3 objects`);\n\n const locations = keys.map(key => this.createLocationSpec(key));\n\n await this.connection.applyMutation({\n type: 'full',\n entities: locations.map(location => {\n return {\n locationKey: this.getProviderName(),\n entity: locationSpecToLocationEntity({ location }),\n };\n }),\n });\n\n logger.info(`Committed ${locations.length} Locations for AWS S3 objects`);\n }\n\n private async listAllObjectKeys(): Promise<string[]> {\n if (!this.s3) {\n throw new Error('Not initialized');\n }\n\n const keys: string[] = [];\n\n let continuationToken: string | undefined = undefined;\n let output: ListObjectsV2Output;\n do {\n output = await this.s3.listObjectsV2({\n Bucket: this.config.bucketName,\n ContinuationToken: continuationToken,\n Prefix: this.config.prefix,\n });\n\n if (output.Contents) {\n output.Contents.forEach(item => {\n if (item.Key && !item.Key.endsWith('/')) {\n keys.push(item.Key);\n }\n });\n }\n continuationToken = output.NextContinuationToken;\n } while (continuationToken);\n\n return keys;\n }\n\n private createLocationSpec(key: string): LocationSpec {\n return {\n type: 'url',\n target: this.createObjectUrl(key),\n presence: 'required',\n };\n }\n\n private createObjectUrl(key: string): string {\n return new URL(key, this.endpoint).href;\n }\n}\n"],"names":["readTaskScheduleDefinitionFromConfig","integration","ScmIntegrations","DefaultAwsCredentialsManager","uuid","S3","getEndpointFromInstructions","ListObjectsV2Command","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,MAAM,mBAAsB,GAAA,SAAA,CAAA;AAErB,SAAS,iBAAiB,MAA+B,EAAA;AAC9D,EAAA,MAAM,UAAyB,EAAC,CAAA;AAEhC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,yBAAyB,CAAA,CAAA;AAC1E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,YAAY,CAAG,EAAA;AAErC,IAAA,OAAA,CAAQ,IAAK,CAAA,eAAA,CAAgB,mBAAqB,EAAA,eAAe,CAAC,CAAA,CAAA;AAElE,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,eAAgB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA,CAAA;AAAA,GACjE;AAEA,EAAO,OAAA,OAAA,CAAA;AACT,CAAA;AAEA,SAAS,eAAA,CAAgB,IAAY,MAA6B,EAAA;AAChE,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,SAAA,CAAU,YAAY,CAAA,CAAA;AAChD,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA,CAAA;AAChD,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA,CAAA;AAEhD,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCA,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,UAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF;;ACZO,MAAM,mBAA8C,CAAA;AAAA,EAwDjD,WACW,CAAA,MAAA,EACA,WACA,EAAA,qBAAA,EACjB,QACA,UACA,EAAA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA,CAAA;AACA,IAAA,IAAA,CAAA,qBAAA,GAAA,qBAAA,CAAA;AAIjB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AAED,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EA7DA,OAAO,UACL,CAAA,UAAA,EACA,OAKuB,EAAA;AACvB,IAAM,MAAA,eAAA,GAAkB,iBAAiB,UAAU,CAAA,CAAA;AAUnD,IAAM,MAAAC,aAAA,GAAcC,4BAAgB,UAAW,CAAA,UAAU,EAAE,KAAM,CAAA,IAAA,GAAO,CAAC,CAAA,CAAA;AACzE,IAAA,IAAI,CAACD,aAAa,EAAA;AAChB,MAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA,CAAA;AAAA,KAClD;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAO,OAAA,eAAA,CAAgB,IAAI,CAAkB,cAAA,KAAA;AAlFjD,MAAA,IAAA,EAAA,CAAA;AAmFM,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,uEAAuE,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SACxF,CAAA;AAAA,OACF;AACA,MAAM,MAAA,qBAAA,GACJE,+CAA6B,CAAA,UAAA,CAAW,UAAU,CAAA,CAAA;AACpD,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAA,OAAO,IAAI,mBAAA;AAAA,QACT,cAAA;AAAA,QACAF,aAAA;AAAA,QACA,qBAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,QACR,UAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAgBQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,mBAAoB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YACjD,MAAA;AAAA,YACA,cAAA,EAAgBG,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,KAAM,CAAA,CAAA,EAAG,IAAK,CAAA,eAAA,qBAAoC,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,eAAA,EAAkB,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,YACJ,GAAA,MAAM,IAAK,CAAA,qBAAA,CAAsB,qBAAsB,EAAA,CAAA;AACzD,IAAK,IAAA,CAAA,EAAA,GAAK,IAAIC,WAAG,CAAA;AAAA,MACf,UAAY,EAAA,YAAA;AAAA,MACZ,yBAAA,EAA2B,MAAM,YAAa,CAAA,qBAAA;AAAA,MAC9C,QAAA,EAAU,IAAK,CAAA,WAAA,CAAY,MAAO,CAAA,QAAA;AAAA,MAClC,MAAA,EAAQ,KAAK,MAAO,CAAA,MAAA;AAAA,MACpB,cAAA,EAAgB,IAAK,CAAA,WAAA,CAAY,MAAO,CAAA,gBAAA;AAAA,KACzC,CAAA,CAAA;AAGD,IAAA,MAAM,WAAW,MAAMC,8CAAA;AAAA,MACrB;AAAA,QACE,MAAA,EAAQ,KAAK,MAAO,CAAA,UAAA;AAAA,OACtB;AAAA,MACAC,6BAAA;AAAA,MACA,KAAK,EAAG,CAAA,MAAA;AAAA,KACV,CAAA;AACA,IAAA,IAAI,QAAU,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAA,GAAA;AACZ,MAAA,IAAA,CAAK,QAAW,GAAA,QAAA,CAAS,GAAI,CAAA,IAAA,CAAK,QAAS,CAAA,GAAG,CAC1C,GAAA,QAAA,CAAS,GAAI,CAAA,IAAA,GACb,CAAG,EAAA,QAAA,CAAS,GAAI,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA;AACtB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,QAAQ,MAAgB,EAAA;AAC5B,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAA,CAAO,KAAK,4BAA4B,CAAA,CAAA;AAExC,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,iBAAkB,EAAA,CAAA;AAC1C,IAAO,MAAA,CAAA,IAAA,CAAK,CAAc,WAAA,EAAA,IAAA,CAAK,MAAuB,CAAA,eAAA,CAAA,CAAA,CAAA;AAEtD,IAAA,MAAM,YAAY,IAAK,CAAA,GAAA,CAAI,SAAO,IAAK,CAAA,kBAAA,CAAmB,GAAG,CAAC,CAAA,CAAA;AAE9D,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAY,QAAA,KAAA;AAClC,QAAO,OAAA;AAAA,UACL,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,UAClC,MAAQ,EAAAC,8CAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,SACnD,CAAA;AAAA,OACD,CAAA;AAAA,KACF,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,IAAA,CAAK,CAAa,UAAA,EAAA,SAAA,CAAU,MAAqC,CAAA,6BAAA,CAAA,CAAA,CAAA;AAAA,GAC1E;AAAA,EAEA,MAAc,iBAAuC,GAAA;AACnD,IAAI,IAAA,CAAC,KAAK,EAAI,EAAA;AACZ,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAM,OAAiB,EAAC,CAAA;AAExB,IAAA,IAAI,iBAAwC,GAAA,KAAA,CAAA,CAAA;AAC5C,IAAI,IAAA,MAAA,CAAA;AACJ,IAAG,GAAA;AACD,MAAS,MAAA,GAAA,MAAM,IAAK,CAAA,EAAA,CAAG,aAAc,CAAA;AAAA,QACnC,MAAA,EAAQ,KAAK,MAAO,CAAA,UAAA;AAAA,QACpB,iBAAmB,EAAA,iBAAA;AAAA,QACnB,MAAA,EAAQ,KAAK,MAAO,CAAA,MAAA;AAAA,OACrB,CAAA,CAAA;AAED,MAAA,IAAI,OAAO,QAAU,EAAA;AACnB,QAAO,MAAA,CAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AAC9B,UAAA,IAAI,KAAK,GAAO,IAAA,CAAC,KAAK,GAAI,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACvC,YAAK,IAAA,CAAA,IAAA,CAAK,KAAK,GAAG,CAAA,CAAA;AAAA,WACpB;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AACA,MAAA,iBAAA,GAAoB,MAAO,CAAA,qBAAA,CAAA;AAAA,KACpB,QAAA,iBAAA,EAAA;AAET,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,mBAAmB,GAA2B,EAAA;AACpD,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA,EAAQ,IAAK,CAAA,eAAA,CAAgB,GAAG,CAAA;AAAA,MAChC,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AAAA,EAEQ,gBAAgB,GAAqB,EAAA;AAC3C,IAAA,OAAO,IAAI,GAAA,CAAI,GAAK,EAAA,IAAA,CAAK,QAAQ,CAAE,CAAA,IAAA,CAAA;AAAA,GACrC;AACF;;;;"}
|
package/dist/index.cjs.js
CHANGED
|
@@ -3,25 +3,35 @@
|
|
|
3
3
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
4
|
|
|
5
5
|
var pluginKubernetesCommon = require('@backstage/plugin-kubernetes-common');
|
|
6
|
-
var
|
|
6
|
+
var clientEks = require('@aws-sdk/client-eks');
|
|
7
|
+
var integrationAwsNode = require('@backstage/integration-aws-node');
|
|
7
8
|
var pluginCatalogNode = require('@backstage/plugin-catalog-node');
|
|
9
|
+
var clientOrganizations = require('@aws-sdk/client-organizations');
|
|
8
10
|
var errors = require('@backstage/errors');
|
|
9
11
|
var limiterFactory = require('p-limit');
|
|
10
|
-
var AwsS3EntityProvider = require('./cjs/AwsS3EntityProvider-
|
|
12
|
+
var AwsS3EntityProvider = require('./cjs/AwsS3EntityProvider-16db03d3.cjs.js');
|
|
11
13
|
require('@backstage/integration');
|
|
12
14
|
require('@backstage/backend-tasks');
|
|
15
|
+
require('@aws-sdk/client-s3');
|
|
13
16
|
require('uuid');
|
|
17
|
+
require('@aws-sdk/middleware-endpoint');
|
|
14
18
|
|
|
15
19
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
16
20
|
|
|
17
|
-
var AWS__default = /*#__PURE__*/_interopDefaultLegacy(AWS);
|
|
18
21
|
var limiterFactory__default = /*#__PURE__*/_interopDefaultLegacy(limiterFactory);
|
|
19
22
|
|
|
20
23
|
const ACCOUNTID_ANNOTATION$1 = "amazonaws.com/account-id";
|
|
21
24
|
const ARN_ANNOTATION$1 = "amazonaws.com/arn";
|
|
22
25
|
class AwsEKSClusterProcessor {
|
|
26
|
+
static fromConfig(configRoot) {
|
|
27
|
+
const awsCredentaislManager = integrationAwsNode.DefaultAwsCredentialsManager.fromConfig(configRoot);
|
|
28
|
+
return new AwsEKSClusterProcessor({
|
|
29
|
+
credentialsManager: awsCredentaislManager
|
|
30
|
+
});
|
|
31
|
+
}
|
|
23
32
|
constructor(options) {
|
|
24
33
|
this.credentialsFactory = options.credentialsFactory;
|
|
34
|
+
this.credentialsManager = options.credentialsManager;
|
|
25
35
|
}
|
|
26
36
|
getProcessorName() {
|
|
27
37
|
return "aws-eks";
|
|
@@ -43,12 +53,20 @@ class AwsEKSClusterProcessor {
|
|
|
43
53
|
if (this.credentialsFactory) {
|
|
44
54
|
credentials = await this.credentialsFactory(accountId);
|
|
45
55
|
}
|
|
46
|
-
|
|
47
|
-
|
|
56
|
+
let providerFunction;
|
|
57
|
+
if (this.credentialsManager) {
|
|
58
|
+
const credentialsProvider = await this.credentialsManager.getCredentialProvider({ accountId });
|
|
59
|
+
providerFunction = () => credentialsProvider.sdkCredentialProvider;
|
|
60
|
+
}
|
|
61
|
+
const eksClient = new clientEks.EKS({
|
|
62
|
+
credentials,
|
|
63
|
+
credentialDefaultProvider: providerFunction
|
|
64
|
+
});
|
|
65
|
+
const clusters = await eksClient.listClusters({});
|
|
48
66
|
if (clusters.clusters === void 0) {
|
|
49
67
|
return true;
|
|
50
68
|
}
|
|
51
|
-
const results = clusters.clusters.map((cluster) => eksClient.describeCluster({ name: cluster })
|
|
69
|
+
const results = clusters.clusters.map((cluster) => eksClient.describeCluster({ name: cluster })).map(async (describedClusterPromise) => {
|
|
52
70
|
var _a;
|
|
53
71
|
const describedCluster = await describedClusterPromise;
|
|
54
72
|
if (describedCluster.cluster) {
|
|
@@ -97,42 +115,37 @@ const ACCOUNTID_ANNOTATION = "amazonaws.com/account-id";
|
|
|
97
115
|
const ARN_ANNOTATION = "amazonaws.com/arn";
|
|
98
116
|
const ORGANIZATION_ANNOTATION = "amazonaws.com/organization-id";
|
|
99
117
|
class AwsOrganizationCloudAccountProcessor {
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
provider: c ? readAwsOrganizationConfig(c) : {}
|
|
118
|
+
constructor(credProvider, logger) {
|
|
119
|
+
this.credProvider = credProvider;
|
|
120
|
+
this.logger = logger == null ? void 0 : logger.child({
|
|
121
|
+
target: this.getProcessorName()
|
|
105
122
|
});
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
if (!roleArn) {
|
|
110
|
-
return void 0;
|
|
111
|
-
}
|
|
112
|
-
return new AWS__default["default"].ChainableTemporaryCredentials({
|
|
113
|
-
params: {
|
|
114
|
-
RoleSessionName: "backstage-aws-organization-processor",
|
|
115
|
-
RoleArn: roleArn
|
|
116
|
-
}
|
|
123
|
+
this.organizations = new clientOrganizations.Organizations({
|
|
124
|
+
credentialDefaultProvider: () => this.credProvider.sdkCredentialProvider,
|
|
125
|
+
region: AWS_ORGANIZATION_REGION
|
|
117
126
|
});
|
|
118
127
|
}
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
const
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
credentials,
|
|
126
|
-
region: AWS_ORGANIZATION_REGION
|
|
128
|
+
static async fromConfig(config, options) {
|
|
129
|
+
const c = config.getOptionalConfig("catalog.processors.awsOrganization");
|
|
130
|
+
const orgConfig = c ? readAwsOrganizationConfig(c) : void 0;
|
|
131
|
+
const awsCredentialsManager = integrationAwsNode.DefaultAwsCredentialsManager.fromConfig(config);
|
|
132
|
+
const credProvider = await awsCredentialsManager.getCredentialProvider({
|
|
133
|
+
arn: orgConfig == null ? void 0 : orgConfig.roleArn
|
|
127
134
|
});
|
|
135
|
+
return new AwsOrganizationCloudAccountProcessor(
|
|
136
|
+
credProvider,
|
|
137
|
+
options.logger
|
|
138
|
+
);
|
|
128
139
|
}
|
|
129
140
|
getProcessorName() {
|
|
130
141
|
return "AwsOrganizationCloudAccountProcessor";
|
|
131
142
|
}
|
|
132
143
|
async readLocation(location, _optional, emit) {
|
|
144
|
+
var _a;
|
|
133
145
|
if (location.type !== LOCATION_TYPE) {
|
|
134
146
|
return false;
|
|
135
147
|
}
|
|
148
|
+
(_a = this.logger) == null ? void 0 : _a.info("Discovering AWS Organization Account objects");
|
|
136
149
|
(await this.getAwsAccounts()).map((account) => this.mapAccountToComponent(account)).filter((entity) => {
|
|
137
150
|
if (location.target !== "") {
|
|
138
151
|
if (entity.metadata.annotations) {
|
|
@@ -162,7 +175,7 @@ class AwsOrganizationCloudAccountProcessor {
|
|
|
162
175
|
let nextToken = void 0;
|
|
163
176
|
while (isInitialAttempt || nextToken) {
|
|
164
177
|
isInitialAttempt = false;
|
|
165
|
-
const orgAccounts = await this.organizations.listAccounts({ NextToken: nextToken })
|
|
178
|
+
const orgAccounts = await this.organizations.listAccounts({ NextToken: nextToken });
|
|
166
179
|
if (orgAccounts.Accounts) {
|
|
167
180
|
awsAccounts = awsAccounts.concat(orgAccounts.Accounts);
|
|
168
181
|
}
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/processors/AwsEKSClusterProcessor.ts","../src/awsOrganization/config.ts","../src/processors/AwsOrganizationCloudAccountProcessor.ts","../src/processors/AwsS3DiscoveryProcessor.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n ANNOTATION_KUBERNETES_API_SERVER,\n ANNOTATION_KUBERNETES_API_SERVER_CA,\n ANNOTATION_KUBERNETES_AUTH_PROVIDER,\n} from '@backstage/plugin-kubernetes-common';\nimport { Credentials, EKS } from 'aws-sdk';\nimport { AWSCredentialFactory } from '../types';\n\nconst ACCOUNTID_ANNOTATION: string = 'amazonaws.com/account-id';\nconst ARN_ANNOTATION: string = 'amazonaws.com/arn';\n\n/**\n * A processor for automatic discovery of resources from EKS clusters. Handles the\n * `aws-eks` location type, and target accounts/regions of the form\n * `<accountId>/<region>`.\n *\n * @public\n */\nexport class AwsEKSClusterProcessor implements CatalogProcessor {\n private credentialsFactory?: AWSCredentialFactory;\n\n constructor(options: { credentialsFactory?: AWSCredentialFactory }) {\n this.credentialsFactory = options.credentialsFactory;\n }\n\n getProcessorName(): string {\n return 'aws-eks';\n }\n\n normalizeName(name: string): string {\n return name\n .trim()\n .toLocaleLowerCase('en-US')\n .replace(/[^a-zA-Z0-9\\-]/g, '-');\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'aws-eks') {\n return false;\n }\n\n // location target is of format \"account-id/region\"\n const [accountId, region] = location.target.split('/');\n\n if (!accountId || !region) {\n throw new Error(\n 'AWS EKS location specified without account or region information',\n );\n }\n\n let credentials: Credentials | undefined;\n\n if (this.credentialsFactory) {\n credentials = await this.credentialsFactory(accountId);\n }\n\n const eksClient = new EKS({ credentials, region });\n const clusters = await eksClient.listClusters({}).promise();\n if (clusters.clusters === undefined) {\n return true;\n }\n\n const results = clusters.clusters\n .map(cluster => eksClient.describeCluster({ name: cluster }).promise())\n .map(async describedClusterPromise => {\n const describedCluster = await describedClusterPromise;\n if (describedCluster.cluster) {\n const entity = {\n apiVersion: 'backstage.io/v1alpha1',\n kind: 'Resource',\n metadata: {\n annotations: {\n [ACCOUNTID_ANNOTATION]: accountId,\n [ARN_ANNOTATION]: describedCluster.cluster.arn || '',\n [ANNOTATION_KUBERNETES_API_SERVER]:\n describedCluster.cluster.endpoint || '',\n [ANNOTATION_KUBERNETES_API_SERVER_CA]:\n describedCluster.cluster.certificateAuthority?.data || '',\n [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: 'aws',\n },\n name: this.normalizeName(describedCluster.cluster.name as string),\n namespace: 'default',\n },\n spec: {\n type: 'kubernetes-cluster',\n owner: 'unknown',\n },\n };\n emit({\n type: 'entity',\n entity,\n location,\n });\n }\n });\n await Promise.all(results);\n return true;\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\n\n/**\n * The configuration parameters for a single AWS Organization Processor\n */\nexport type AwsOrganizationProviderConfig = {\n /**\n * The role to assume for the processor.\n */\n roleArn?: string;\n};\n\nexport function readAwsOrganizationConfig(\n config: Config,\n): AwsOrganizationProviderConfig {\n const providerConfig = config.getOptionalConfig('provider');\n\n const roleArn = providerConfig?.getOptionalString('roleArn');\n return {\n roleArn,\n };\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ResourceEntityV1alpha1 } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport AWS, { Credentials, Organizations } from 'aws-sdk';\nimport { Account, ListAccountsResponse } from 'aws-sdk/clients/organizations';\nimport { Logger } from 'winston';\nimport {\n AwsOrganizationProviderConfig,\n readAwsOrganizationConfig,\n} from '../awsOrganization/config';\n\nconst AWS_ORGANIZATION_REGION = 'us-east-1';\nconst LOCATION_TYPE = 'aws-cloud-accounts';\n\nconst ACCOUNTID_ANNOTATION = 'amazonaws.com/account-id';\nconst ARN_ANNOTATION = 'amazonaws.com/arn';\nconst ORGANIZATION_ANNOTATION = 'amazonaws.com/organization-id';\n\n/**\n * A processor for ingesting AWS Accounts from AWS Organizations.\n *\n * If custom authentication is needed, it can be achieved by configuring the\n * global AWS.credentials object.\n *\n * @public\n */\nexport class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {\n private readonly organizations: Organizations;\n private readonly provider: AwsOrganizationProviderConfig;\n\n static fromConfig(config: Config, options: { logger: Logger }) {\n const c = config.getOptionalConfig('catalog.processors.awsOrganization');\n return new AwsOrganizationCloudAccountProcessor({\n ...options,\n provider: c ? readAwsOrganizationConfig(c) : {},\n });\n }\n\n private static buildCredentials(\n config: AwsOrganizationProviderConfig,\n ): Credentials | undefined {\n const roleArn = config.roleArn;\n if (!roleArn) {\n return undefined;\n }\n\n return new AWS.ChainableTemporaryCredentials({\n params: {\n RoleSessionName: 'backstage-aws-organization-processor',\n RoleArn: roleArn,\n },\n });\n }\n\n private constructor(options: { provider: AwsOrganizationProviderConfig }) {\n this.provider = options.provider;\n const credentials = AwsOrganizationCloudAccountProcessor.buildCredentials(\n this.provider,\n );\n this.organizations = new AWS.Organizations({\n credentials,\n region: AWS_ORGANIZATION_REGION,\n }); // Only available in us-east-1\n }\n\n getProcessorName(): string {\n return 'AwsOrganizationCloudAccountProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== LOCATION_TYPE) {\n return false;\n }\n\n (await this.getAwsAccounts())\n .map(account => this.mapAccountToComponent(account))\n .filter(entity => {\n if (location.target !== '') {\n if (entity.metadata.annotations) {\n return (\n entity.metadata.annotations[ORGANIZATION_ANNOTATION] ===\n location.target\n );\n }\n return false;\n }\n return true;\n })\n .forEach(entity => {\n emit(processingResult.entity(location, entity));\n });\n\n return true;\n }\n\n private normalizeName(name: string): string {\n return name\n .trim()\n .toLocaleLowerCase('en-US')\n .replace(/[^a-zA-Z0-9\\-]/g, '-');\n }\n\n private extractInformationFromArn(arn: string): {\n accountId: string;\n organizationId: string;\n } {\n const parts = arn.split('/');\n\n return {\n accountId: parts[parts.length - 1],\n organizationId: parts[parts.length - 2],\n };\n }\n\n private async getAwsAccounts(): Promise<Account[]> {\n let awsAccounts: Account[] = [];\n let isInitialAttempt = true;\n let nextToken = undefined;\n while (isInitialAttempt || nextToken) {\n isInitialAttempt = false;\n const orgAccounts: ListAccountsResponse = await this.organizations\n .listAccounts({ NextToken: nextToken })\n .promise();\n if (orgAccounts.Accounts) {\n awsAccounts = awsAccounts.concat(orgAccounts.Accounts);\n }\n nextToken = orgAccounts.NextToken;\n }\n\n return awsAccounts;\n }\n\n private mapAccountToComponent(account: Account): ResourceEntityV1alpha1 {\n const { accountId, organizationId } = this.extractInformationFromArn(\n account.Arn as string,\n );\n return {\n apiVersion: 'backstage.io/v1alpha1',\n kind: 'Resource',\n metadata: {\n annotations: {\n [ACCOUNTID_ANNOTATION]: accountId,\n [ARN_ANNOTATION]: account.Arn || '',\n [ORGANIZATION_ANNOTATION]: organizationId,\n },\n name: this.normalizeName(account.Name || ''),\n namespace: 'default',\n },\n spec: {\n type: 'cloud-account',\n owner: 'unknown',\n },\n };\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { UrlReader } from '@backstage/backend-common';\nimport { isError } from '@backstage/errors';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n CatalogProcessorParser,\n processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport limiterFactory from 'p-limit';\n\n/**\n * A processor for automatic discovery of entities from S3 buckets. Handles the\n * `s3-discovery` location type, and target bucket URLs e.g. on the form\n * `https://testbucket.s3.us-east-2.amazonaws.com`.\n *\n * @public\n * @deprecated Use the `AwsS3EntityProvider` instead (see https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-aws/CHANGELOG.md#014).\n */\nexport class AwsS3DiscoveryProcessor implements CatalogProcessor {\n constructor(private readonly reader: UrlReader) {}\n\n getProcessorName(): string {\n return 'AwsS3DiscoveryProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n optional: boolean,\n emit: CatalogProcessorEmit,\n parser: CatalogProcessorParser,\n ): Promise<boolean> {\n if (location.type !== 's3-discovery') {\n return false;\n }\n\n try {\n const output = await this.doRead(location.target);\n for (const item of output) {\n for await (const parseResult of parser({\n data: item.data,\n location: { type: location.type, target: item.url },\n })) {\n emit(parseResult);\n }\n }\n } catch (error) {\n const message = `Unable to read ${location.type}, ${error}`;\n\n if (isError(error) && error.name === 'NotFoundError') {\n if (!optional) {\n emit(processingResult.notFoundError(location, message));\n }\n } else {\n emit(processingResult.generalError(location, message));\n }\n }\n return true;\n }\n\n private async doRead(\n location: string,\n ): Promise<{ data: Buffer; url: string }[]> {\n const limiter = limiterFactory(5);\n const response = await this.reader.readTree(location);\n const responseFiles = await response.files();\n const output = responseFiles.map(async file => ({\n url: file.path,\n data: await limiter(file.content),\n }));\n return Promise.all(output);\n }\n}\n"],"names":["ACCOUNTID_ANNOTATION","ARN_ANNOTATION","EKS","ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_KUBERNETES_API_SERVER_CA","ANNOTATION_KUBERNETES_AUTH_PROVIDER","AWS","processingResult","isError","limiterFactory"],"mappings":";;;;;;;;;;;;;;;;;;;AA6BA,MAAMA,sBAA+B,GAAA,0BAAA,CAAA;AACrC,MAAMC,gBAAyB,GAAA,mBAAA,CAAA;AASxB,MAAM,sBAAmD,CAAA;AAAA,EAG9D,YAAY,OAAwD,EAAA;AAClE,IAAA,IAAA,CAAK,qBAAqB,OAAQ,CAAA,kBAAA,CAAA;AAAA,GACpC;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,cAAc,IAAsB,EAAA;AAClC,IAAO,OAAA,IAAA,CACJ,MACA,CAAA,iBAAA,CAAkB,OAAO,CACzB,CAAA,OAAA,CAAQ,mBAAmB,GAAG,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,SAAW,EAAA;AAC/B,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAGA,IAAA,MAAM,CAAC,SAAW,EAAA,MAAM,IAAI,QAAS,CAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AAErD,IAAI,IAAA,CAAC,SAAa,IAAA,CAAC,MAAQ,EAAA;AACzB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,kEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAI,IAAA,WAAA,CAAA;AAEJ,IAAA,IAAI,KAAK,kBAAoB,EAAA;AAC3B,MAAc,WAAA,GAAA,MAAM,IAAK,CAAA,kBAAA,CAAmB,SAAS,CAAA,CAAA;AAAA,KACvD;AAEA,IAAA,MAAM,YAAY,IAAIC,OAAA,CAAI,EAAE,WAAA,EAAa,QAAQ,CAAA,CAAA;AACjD,IAAA,MAAM,WAAW,MAAM,SAAA,CAAU,aAAa,EAAE,EAAE,OAAQ,EAAA,CAAA;AAC1D,IAAI,IAAA,QAAA,CAAS,aAAa,KAAW,CAAA,EAAA;AACnC,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,UAAU,QAAS,CAAA,QAAA,CACtB,GAAI,CAAA,CAAA,OAAA,KAAW,UAAU,eAAgB,CAAA,EAAE,IAAM,EAAA,OAAA,EAAS,CAAE,CAAA,OAAA,EAAS,CACrE,CAAA,GAAA,CAAI,OAAM,uBAA2B,KAAA;AAzF5C,MAAA,IAAA,EAAA,CAAA;AA0FQ,MAAA,MAAM,mBAAmB,MAAM,uBAAA,CAAA;AAC/B,MAAA,IAAI,iBAAiB,OAAS,EAAA;AAC5B,QAAA,MAAM,MAAS,GAAA;AAAA,UACb,UAAY,EAAA,uBAAA;AAAA,UACZ,IAAM,EAAA,UAAA;AAAA,UACN,QAAU,EAAA;AAAA,YACR,WAAa,EAAA;AAAA,cACX,CAACF,sBAAoB,GAAG,SAAA;AAAA,cACxB,CAACC,gBAAc,GAAG,gBAAA,CAAiB,QAAQ,GAAO,IAAA,EAAA;AAAA,cAClD,CAACE,uDAAgC,GAC/B,gBAAA,CAAiB,QAAQ,QAAY,IAAA,EAAA;AAAA,cACvC,CAACC,0DAAmC,GAAA,CAAA,CAClC,sBAAiB,OAAQ,CAAA,oBAAA,KAAzB,mBAA+C,IAAQ,KAAA,EAAA;AAAA,cACzD,CAACC,0DAAmC,GAAG,KAAA;AAAA,aACzC;AAAA,YACA,IAAM,EAAA,IAAA,CAAK,aAAc,CAAA,gBAAA,CAAiB,QAAQ,IAAc,CAAA;AAAA,YAChE,SAAW,EAAA,SAAA;AAAA,WACb;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,IAAM,EAAA,oBAAA;AAAA,YACN,KAAO,EAAA,SAAA;AAAA,WACT;AAAA,SACF,CAAA;AACA,QAAK,IAAA,CAAA;AAAA,UACH,IAAM,EAAA,QAAA;AAAA,UACN,MAAA;AAAA,UACA,QAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AACH,IAAM,MAAA,OAAA,CAAQ,IAAI,OAAO,CAAA,CAAA;AACzB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;AC/FO,SAAS,0BACd,MAC+B,EAAA;AAC/B,EAAM,MAAA,cAAA,GAAiB,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AAE1D,EAAM,MAAA,OAAA,GAAU,iDAAgB,iBAAkB,CAAA,SAAA,CAAA,CAAA;AAClD,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF;;ACLA,MAAM,uBAA0B,GAAA,WAAA,CAAA;AAChC,MAAM,aAAgB,GAAA,oBAAA,CAAA;AAEtB,MAAM,oBAAuB,GAAA,0BAAA,CAAA;AAC7B,MAAM,cAAiB,GAAA,mBAAA,CAAA;AACvB,MAAM,uBAA0B,GAAA,+BAAA,CAAA;AAUzB,MAAM,oCAAiE,CAAA;AAAA,EAI5E,OAAO,UAAW,CAAA,MAAA,EAAgB,OAA6B,EAAA;AAC7D,IAAM,MAAA,CAAA,GAAI,MAAO,CAAA,iBAAA,CAAkB,oCAAoC,CAAA,CAAA;AACvE,IAAA,OAAO,IAAI,oCAAqC,CAAA;AAAA,MAC9C,GAAG,OAAA;AAAA,MACH,QAAU,EAAA,CAAA,GAAI,yBAA0B,CAAA,CAAC,IAAI,EAAC;AAAA,KAC/C,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,OAAe,iBACb,MACyB,EAAA;AACzB,IAAA,MAAM,UAAU,MAAO,CAAA,OAAA,CAAA;AACvB,IAAA,IAAI,CAAC,OAAS,EAAA;AACZ,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAEA,IAAO,OAAA,IAAIC,wBAAI,6BAA8B,CAAA;AAAA,MAC3C,MAAQ,EAAA;AAAA,QACN,eAAiB,EAAA,sCAAA;AAAA,QACjB,OAAS,EAAA,OAAA;AAAA,OACX;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,YAAY,OAAsD,EAAA;AACxE,IAAA,IAAA,CAAK,WAAW,OAAQ,CAAA,QAAA,CAAA;AACxB,IAAA,MAAM,cAAc,oCAAqC,CAAA,gBAAA;AAAA,MACvD,IAAK,CAAA,QAAA;AAAA,KACP,CAAA;AACA,IAAK,IAAA,CAAA,aAAA,GAAgB,IAAIA,uBAAA,CAAI,aAAc,CAAA;AAAA,MACzC,WAAA;AAAA,MACA,MAAQ,EAAA,uBAAA;AAAA,KACT,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,sCAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,aAAe,EAAA;AACnC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAA,CAAC,MAAM,IAAA,CAAK,cAAe,EAAA,EACxB,GAAI,CAAA,CAAA,OAAA,KAAW,IAAK,CAAA,qBAAA,CAAsB,OAAO,CAAC,CAClD,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA;AAChB,MAAI,IAAA,QAAA,CAAS,WAAW,EAAI,EAAA;AAC1B,QAAI,IAAA,MAAA,CAAO,SAAS,WAAa,EAAA;AAC/B,UAAA,OACE,MAAO,CAAA,QAAA,CAAS,WAAY,CAAA,uBAAuB,MACnD,QAAS,CAAA,MAAA,CAAA;AAAA,SAEb;AACA,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAO,OAAA,IAAA,CAAA;AAAA,KACR,CACA,CAAA,OAAA,CAAQ,CAAU,MAAA,KAAA;AACjB,MAAA,IAAA,CAAKC,kCAAiB,CAAA,MAAA,CAAO,QAAU,EAAA,MAAM,CAAC,CAAA,CAAA;AAAA,KAC/C,CAAA,CAAA;AAEH,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,cAAc,IAAsB,EAAA;AAC1C,IAAO,OAAA,IAAA,CACJ,MACA,CAAA,iBAAA,CAAkB,OAAO,CACzB,CAAA,OAAA,CAAQ,mBAAmB,GAAG,CAAA,CAAA;AAAA,GACnC;AAAA,EAEQ,0BAA0B,GAGhC,EAAA;AACA,IAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAE3B,IAAO,OAAA;AAAA,MACL,SAAW,EAAA,KAAA,CAAM,KAAM,CAAA,MAAA,GAAS,CAAC,CAAA;AAAA,MACjC,cAAgB,EAAA,KAAA,CAAM,KAAM,CAAA,MAAA,GAAS,CAAC,CAAA;AAAA,KACxC,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,cAAqC,GAAA;AACjD,IAAA,IAAI,cAAyB,EAAC,CAAA;AAC9B,IAAA,IAAI,gBAAmB,GAAA,IAAA,CAAA;AACvB,IAAA,IAAI,SAAY,GAAA,KAAA,CAAA,CAAA;AAChB,IAAA,OAAO,oBAAoB,SAAW,EAAA;AACpC,MAAmB,gBAAA,GAAA,KAAA,CAAA;AACnB,MAAM,MAAA,WAAA,GAAoC,MAAM,IAAA,CAAK,aAClD,CAAA,YAAA,CAAa,EAAE,SAAW,EAAA,SAAA,EAAW,CAAA,CACrC,OAAQ,EAAA,CAAA;AACX,MAAA,IAAI,YAAY,QAAU,EAAA;AACxB,QAAc,WAAA,GAAA,WAAA,CAAY,MAAO,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AAAA,OACvD;AACA,MAAA,SAAA,GAAY,WAAY,CAAA,SAAA,CAAA;AAAA,KAC1B;AAEA,IAAO,OAAA,WAAA,CAAA;AAAA,GACT;AAAA,EAEQ,sBAAsB,OAA0C,EAAA;AACtE,IAAA,MAAM,EAAE,SAAA,EAAW,cAAe,EAAA,GAAI,IAAK,CAAA,yBAAA;AAAA,MACzC,OAAQ,CAAA,GAAA;AAAA,KACV,CAAA;AACA,IAAO,OAAA;AAAA,MACL,UAAY,EAAA,uBAAA;AAAA,MACZ,IAAM,EAAA,UAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAAC,oBAAoB,GAAG,SAAA;AAAA,UACxB,CAAC,cAAc,GAAG,OAAA,CAAQ,GAAO,IAAA,EAAA;AAAA,UACjC,CAAC,uBAAuB,GAAG,cAAA;AAAA,SAC7B;AAAA,QACA,IAAM,EAAA,IAAA,CAAK,aAAc,CAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA;AAAA,QAC3C,SAAW,EAAA,SAAA;AAAA,OACb;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,eAAA;AAAA,QACN,KAAO,EAAA,SAAA;AAAA,OACT;AAAA,KACF,CAAA;AAAA,GACF;AACF;;AChJO,MAAM,uBAAoD,CAAA;AAAA,EAC/D,YAA6B,MAAmB,EAAA;AAAnB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAAoB;AAAA,EAEjD,gBAA2B,GAAA;AACzB,IAAO,OAAA,yBAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,QAAA,EACA,MACA,MACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,cAAgB,EAAA;AACpC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAI,IAAA;AACF,MAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,MAAM,CAAA,CAAA;AAChD,MAAA,KAAA,MAAW,QAAQ,MAAQ,EAAA;AACzB,QAAA,WAAA,MAAiB,eAAe,MAAO,CAAA;AAAA,UACrC,MAAM,IAAK,CAAA,IAAA;AAAA,UACX,UAAU,EAAE,IAAA,EAAM,SAAS,IAAM,EAAA,MAAA,EAAQ,KAAK,GAAI,EAAA;AAAA,SACnD,CAAG,EAAA;AACF,UAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAAA,SAClB;AAAA,OACF;AAAA,aACO,KAAP,EAAA;AACA,MAAM,MAAA,OAAA,GAAU,CAAkB,eAAA,EAAA,QAAA,CAAS,IAAS,CAAA,EAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAEpD,MAAA,IAAIC,cAAQ,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AACpD,QAAA,IAAI,CAAC,QAAU,EAAA;AACb,UAAA,IAAA,CAAKD,kCAAiB,CAAA,aAAA,CAAc,QAAU,EAAA,OAAO,CAAC,CAAA,CAAA;AAAA,SACxD;AAAA,OACK,MAAA;AACL,QAAA,IAAA,CAAKA,kCAAiB,CAAA,YAAA,CAAa,QAAU,EAAA,OAAO,CAAC,CAAA,CAAA;AAAA,OACvD;AAAA,KACF;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAc,OACZ,QAC0C,EAAA;AAC1C,IAAM,MAAA,OAAA,GAAUE,mCAAe,CAAC,CAAA,CAAA;AAChC,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,QAAQ,CAAA,CAAA;AACpD,IAAM,MAAA,aAAA,GAAgB,MAAM,QAAA,CAAS,KAAM,EAAA,CAAA;AAC3C,IAAA,MAAM,MAAS,GAAA,aAAA,CAAc,GAAI,CAAA,OAAM,IAAS,MAAA;AAAA,MAC9C,KAAK,IAAK,CAAA,IAAA;AAAA,MACV,IAAM,EAAA,MAAM,OAAQ,CAAA,IAAA,CAAK,OAAO,CAAA;AAAA,KAChC,CAAA,CAAA,CAAA;AACF,IAAO,OAAA,OAAA,CAAQ,IAAI,MAAM,CAAA,CAAA;AAAA,GAC3B;AACF;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/processors/AwsEKSClusterProcessor.ts","../src/awsOrganization/config.ts","../src/processors/AwsOrganizationCloudAccountProcessor.ts","../src/processors/AwsS3DiscoveryProcessor.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n ANNOTATION_KUBERNETES_API_SERVER,\n ANNOTATION_KUBERNETES_API_SERVER_CA,\n ANNOTATION_KUBERNETES_AUTH_PROVIDER,\n} from '@backstage/plugin-kubernetes-common';\nimport { EKS } from '@aws-sdk/client-eks';\nimport { AWSCredentialFactory } from '../types';\nimport { AwsCredentialIdentity, Provider } from '@aws-sdk/types';\nimport {\n AwsCredentialsManager,\n DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\nimport { Config } from '@backstage/config';\n\nconst ACCOUNTID_ANNOTATION: string = 'amazonaws.com/account-id';\nconst ARN_ANNOTATION: string = 'amazonaws.com/arn';\n\n/**\n * A processor for automatic discovery of resources from EKS clusters. Handles the\n * `aws-eks` location type, and target accounts/regions of the form\n * `<accountId>/<region>`.\n *\n * @public\n */\nexport class AwsEKSClusterProcessor implements CatalogProcessor {\n private credentialsFactory?: AWSCredentialFactory;\n private credentialsManager?: AwsCredentialsManager;\n\n static fromConfig(configRoot: Config): AwsEKSClusterProcessor {\n const awsCredentaislManager =\n DefaultAwsCredentialsManager.fromConfig(configRoot);\n return new AwsEKSClusterProcessor({\n credentialsManager: awsCredentaislManager,\n });\n }\n\n constructor(options: {\n credentialsFactory?: AWSCredentialFactory;\n credentialsManager?: AwsCredentialsManager;\n }) {\n this.credentialsFactory = options.credentialsFactory;\n this.credentialsManager = options.credentialsManager;\n }\n\n getProcessorName(): string {\n return 'aws-eks';\n }\n\n normalizeName(name: string): string {\n return name\n .trim()\n .toLocaleLowerCase('en-US')\n .replace(/[^a-zA-Z0-9\\-]/g, '-');\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== 'aws-eks') {\n return false;\n }\n\n // location target is of format \"account-id/region\"\n const [accountId, region] = location.target.split('/');\n\n if (!accountId || !region) {\n throw new Error(\n 'AWS EKS location specified without account or region information',\n );\n }\n\n let credentials: AwsCredentialIdentity | undefined;\n\n if (this.credentialsFactory) {\n credentials = await this.credentialsFactory(accountId);\n }\n\n let providerFunction: (() => Provider<AwsCredentialIdentity>) | undefined;\n if (this.credentialsManager) {\n const credentialsProvider =\n await this.credentialsManager.getCredentialProvider({ accountId });\n providerFunction = () => credentialsProvider.sdkCredentialProvider;\n }\n\n const eksClient = new EKS({\n credentials,\n credentialDefaultProvider: providerFunction,\n });\n const clusters = await eksClient.listClusters({});\n if (clusters.clusters === undefined) {\n return true;\n }\n\n const results = clusters.clusters\n .map(cluster => eksClient.describeCluster({ name: cluster }))\n .map(async describedClusterPromise => {\n const describedCluster = await describedClusterPromise;\n if (describedCluster.cluster) {\n const entity = {\n apiVersion: 'backstage.io/v1alpha1',\n kind: 'Resource',\n metadata: {\n annotations: {\n [ACCOUNTID_ANNOTATION]: accountId,\n [ARN_ANNOTATION]: describedCluster.cluster.arn || '',\n [ANNOTATION_KUBERNETES_API_SERVER]:\n describedCluster.cluster.endpoint || '',\n [ANNOTATION_KUBERNETES_API_SERVER_CA]:\n describedCluster.cluster.certificateAuthority?.data || '',\n [ANNOTATION_KUBERNETES_AUTH_PROVIDER]: 'aws',\n },\n name: this.normalizeName(describedCluster.cluster.name as string),\n namespace: 'default',\n },\n spec: {\n type: 'kubernetes-cluster',\n owner: 'unknown',\n },\n };\n emit({\n type: 'entity',\n entity,\n location,\n });\n }\n });\n await Promise.all(results);\n return true;\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\n\n/**\n * The configuration parameters for a single AWS Organization Processor\n */\nexport type AwsOrganizationProviderConfig = {\n /**\n * The role to assume for the processor.\n */\n roleArn?: string;\n};\n\nexport function readAwsOrganizationConfig(\n config: Config,\n): AwsOrganizationProviderConfig {\n const providerConfig = config.getOptionalConfig('provider');\n\n const roleArn = providerConfig?.getOptionalString('roleArn');\n return {\n roleArn,\n };\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ResourceEntityV1alpha1 } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n Account,\n ListAccountsResponse,\n Organizations,\n} from '@aws-sdk/client-organizations';\nimport { Logger } from 'winston';\nimport { readAwsOrganizationConfig } from '../awsOrganization/config';\nimport {\n AwsCredentialProvider,\n DefaultAwsCredentialsManager,\n} from '@backstage/integration-aws-node';\n\nconst AWS_ORGANIZATION_REGION = 'us-east-1';\nconst LOCATION_TYPE = 'aws-cloud-accounts';\n\nconst ACCOUNTID_ANNOTATION = 'amazonaws.com/account-id';\nconst ARN_ANNOTATION = 'amazonaws.com/arn';\nconst ORGANIZATION_ANNOTATION = 'amazonaws.com/organization-id';\n\n/**\n * A processor for ingesting AWS Accounts from AWS Organizations.\n *\n * If custom authentication is needed, it can be achieved by configuring the\n * global AWS.credentials object.\n *\n * @public\n */\nexport class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {\n private readonly organizations: Organizations;\n private readonly logger: Logger;\n\n static async fromConfig(config: Config, options: { logger: Logger }) {\n const c = config.getOptionalConfig('catalog.processors.awsOrganization');\n const orgConfig = c ? readAwsOrganizationConfig(c) : undefined;\n const awsCredentialsManager =\n DefaultAwsCredentialsManager.fromConfig(config);\n const credProvider = await awsCredentialsManager.getCredentialProvider({\n arn: orgConfig?.roleArn,\n });\n return new AwsOrganizationCloudAccountProcessor(\n credProvider,\n options.logger,\n );\n }\n\n private constructor(\n private readonly credProvider: AwsCredentialProvider,\n logger: Logger,\n ) {\n this.logger = logger?.child({\n target: this.getProcessorName(),\n });\n this.organizations = new Organizations({\n credentialDefaultProvider: () => this.credProvider.sdkCredentialProvider,\n region: AWS_ORGANIZATION_REGION,\n }); // Only available in us-east-1\n }\n\n getProcessorName(): string {\n return 'AwsOrganizationCloudAccountProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n _optional: boolean,\n emit: CatalogProcessorEmit,\n ): Promise<boolean> {\n if (location.type !== LOCATION_TYPE) {\n return false;\n }\n\n this.logger?.info('Discovering AWS Organization Account objects');\n\n (await this.getAwsAccounts())\n .map(account => this.mapAccountToComponent(account))\n .filter(entity => {\n if (location.target !== '') {\n if (entity.metadata.annotations) {\n return (\n entity.metadata.annotations[ORGANIZATION_ANNOTATION] ===\n location.target\n );\n }\n return false;\n }\n return true;\n })\n .forEach(entity => {\n emit(processingResult.entity(location, entity));\n });\n\n return true;\n }\n\n private normalizeName(name: string): string {\n return name\n .trim()\n .toLocaleLowerCase('en-US')\n .replace(/[^a-zA-Z0-9\\-]/g, '-');\n }\n\n private extractInformationFromArn(arn: string): {\n accountId: string;\n organizationId: string;\n } {\n const parts = arn.split('/');\n\n return {\n accountId: parts[parts.length - 1],\n organizationId: parts[parts.length - 2],\n };\n }\n\n private async getAwsAccounts(): Promise<Account[]> {\n let awsAccounts: Account[] = [];\n let isInitialAttempt = true;\n let nextToken = undefined;\n while (isInitialAttempt || nextToken) {\n isInitialAttempt = false;\n const orgAccounts: ListAccountsResponse =\n await this.organizations.listAccounts({ NextToken: nextToken });\n if (orgAccounts.Accounts) {\n awsAccounts = awsAccounts.concat(orgAccounts.Accounts);\n }\n nextToken = orgAccounts.NextToken;\n }\n\n return awsAccounts;\n }\n\n private mapAccountToComponent(account: Account): ResourceEntityV1alpha1 {\n const { accountId, organizationId } = this.extractInformationFromArn(\n account.Arn as string,\n );\n return {\n apiVersion: 'backstage.io/v1alpha1',\n kind: 'Resource',\n metadata: {\n annotations: {\n [ACCOUNTID_ANNOTATION]: accountId,\n [ARN_ANNOTATION]: account.Arn || '',\n [ORGANIZATION_ANNOTATION]: organizationId,\n },\n name: this.normalizeName(account.Name || ''),\n namespace: 'default',\n },\n spec: {\n type: 'cloud-account',\n owner: 'unknown',\n },\n };\n }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { UrlReader } from '@backstage/backend-common';\nimport { isError } from '@backstage/errors';\nimport {\n CatalogProcessor,\n CatalogProcessorEmit,\n CatalogProcessorParser,\n processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport limiterFactory from 'p-limit';\n\n/**\n * A processor for automatic discovery of entities from S3 buckets. Handles the\n * `s3-discovery` location type, and target bucket URLs e.g. on the form\n * `https://testbucket.s3.us-east-2.amazonaws.com`.\n *\n * @public\n * @deprecated Use the `AwsS3EntityProvider` instead (see https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-aws/CHANGELOG.md#014).\n */\nexport class AwsS3DiscoveryProcessor implements CatalogProcessor {\n constructor(private readonly reader: UrlReader) {}\n\n getProcessorName(): string {\n return 'AwsS3DiscoveryProcessor';\n }\n\n async readLocation(\n location: LocationSpec,\n optional: boolean,\n emit: CatalogProcessorEmit,\n parser: CatalogProcessorParser,\n ): Promise<boolean> {\n if (location.type !== 's3-discovery') {\n return false;\n }\n\n try {\n const output = await this.doRead(location.target);\n for (const item of output) {\n for await (const parseResult of parser({\n data: item.data,\n location: { type: location.type, target: item.url },\n })) {\n emit(parseResult);\n }\n }\n } catch (error) {\n const message = `Unable to read ${location.type}, ${error}`;\n\n if (isError(error) && error.name === 'NotFoundError') {\n if (!optional) {\n emit(processingResult.notFoundError(location, message));\n }\n } else {\n emit(processingResult.generalError(location, message));\n }\n }\n return true;\n }\n\n private async doRead(\n location: string,\n ): Promise<{ data: Buffer; url: string }[]> {\n const limiter = limiterFactory(5);\n const response = await this.reader.readTree(location);\n const responseFiles = await response.files();\n const output = responseFiles.map(async file => ({\n url: file.path,\n data: await limiter(file.content),\n }));\n return Promise.all(output);\n }\n}\n"],"names":["ACCOUNTID_ANNOTATION","ARN_ANNOTATION","DefaultAwsCredentialsManager","EKS","ANNOTATION_KUBERNETES_API_SERVER","ANNOTATION_KUBERNETES_API_SERVER_CA","ANNOTATION_KUBERNETES_AUTH_PROVIDER","Organizations","processingResult","isError","limiterFactory"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAmCA,MAAMA,sBAA+B,GAAA,0BAAA,CAAA;AACrC,MAAMC,gBAAyB,GAAA,mBAAA,CAAA;AASxB,MAAM,sBAAmD,CAAA;AAAA,EAI9D,OAAO,WAAW,UAA4C,EAAA;AAC5D,IAAM,MAAA,qBAAA,GACJC,+CAA6B,CAAA,UAAA,CAAW,UAAU,CAAA,CAAA;AACpD,IAAA,OAAO,IAAI,sBAAuB,CAAA;AAAA,MAChC,kBAAoB,EAAA,qBAAA;AAAA,KACrB,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,YAAY,OAGT,EAAA;AACD,IAAA,IAAA,CAAK,qBAAqB,OAAQ,CAAA,kBAAA,CAAA;AAClC,IAAA,IAAA,CAAK,qBAAqB,OAAQ,CAAA,kBAAA,CAAA;AAAA,GACpC;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,cAAc,IAAsB,EAAA;AAClC,IAAO,OAAA,IAAA,CACJ,MACA,CAAA,iBAAA,CAAkB,OAAO,CACzB,CAAA,OAAA,CAAQ,mBAAmB,GAAG,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,SAAW,EAAA;AAC/B,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAGA,IAAA,MAAM,CAAC,SAAW,EAAA,MAAM,IAAI,QAAS,CAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AAErD,IAAI,IAAA,CAAC,SAAa,IAAA,CAAC,MAAQ,EAAA;AACzB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,kEAAA;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAI,IAAA,WAAA,CAAA;AAEJ,IAAA,IAAI,KAAK,kBAAoB,EAAA;AAC3B,MAAc,WAAA,GAAA,MAAM,IAAK,CAAA,kBAAA,CAAmB,SAAS,CAAA,CAAA;AAAA,KACvD;AAEA,IAAI,IAAA,gBAAA,CAAA;AACJ,IAAA,IAAI,KAAK,kBAAoB,EAAA;AAC3B,MAAA,MAAM,sBACJ,MAAM,IAAA,CAAK,mBAAmB,qBAAsB,CAAA,EAAE,WAAW,CAAA,CAAA;AACnE,MAAA,gBAAA,GAAmB,MAAM,mBAAoB,CAAA,qBAAA,CAAA;AAAA,KAC/C;AAEA,IAAM,MAAA,SAAA,GAAY,IAAIC,aAAI,CAAA;AAAA,MACxB,WAAA;AAAA,MACA,yBAA2B,EAAA,gBAAA;AAAA,KAC5B,CAAA,CAAA;AACD,IAAA,MAAM,QAAW,GAAA,MAAM,SAAU,CAAA,YAAA,CAAa,EAAE,CAAA,CAAA;AAChD,IAAI,IAAA,QAAA,CAAS,aAAa,KAAW,CAAA,EAAA;AACnC,MAAO,OAAA,IAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,OAAU,GAAA,QAAA,CAAS,QACtB,CAAA,GAAA,CAAI,aAAW,SAAU,CAAA,eAAA,CAAgB,EAAE,IAAA,EAAM,SAAS,CAAC,CAC3D,CAAA,GAAA,CAAI,OAAM,uBAA2B,KAAA;AAtH5C,MAAA,IAAA,EAAA,CAAA;AAuHQ,MAAA,MAAM,mBAAmB,MAAM,uBAAA,CAAA;AAC/B,MAAA,IAAI,iBAAiB,OAAS,EAAA;AAC5B,QAAA,MAAM,MAAS,GAAA;AAAA,UACb,UAAY,EAAA,uBAAA;AAAA,UACZ,IAAM,EAAA,UAAA;AAAA,UACN,QAAU,EAAA;AAAA,YACR,WAAa,EAAA;AAAA,cACX,CAACH,sBAAoB,GAAG,SAAA;AAAA,cACxB,CAACC,gBAAc,GAAG,gBAAA,CAAiB,QAAQ,GAAO,IAAA,EAAA;AAAA,cAClD,CAACG,uDAAgC,GAC/B,gBAAA,CAAiB,QAAQ,QAAY,IAAA,EAAA;AAAA,cACvC,CAACC,0DAAmC,GAAA,CAAA,CAClC,sBAAiB,OAAQ,CAAA,oBAAA,KAAzB,mBAA+C,IAAQ,KAAA,EAAA;AAAA,cACzD,CAACC,0DAAmC,GAAG,KAAA;AAAA,aACzC;AAAA,YACA,IAAM,EAAA,IAAA,CAAK,aAAc,CAAA,gBAAA,CAAiB,QAAQ,IAAc,CAAA;AAAA,YAChE,SAAW,EAAA,SAAA;AAAA,WACb;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,IAAM,EAAA,oBAAA;AAAA,YACN,KAAO,EAAA,SAAA;AAAA,WACT;AAAA,SACF,CAAA;AACA,QAAK,IAAA,CAAA;AAAA,UACH,IAAM,EAAA,QAAA;AAAA,UACN,MAAA;AAAA,UACA,QAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AACH,IAAM,MAAA,OAAA,CAAQ,IAAI,OAAO,CAAA,CAAA;AACzB,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;AC5HO,SAAS,0BACd,MAC+B,EAAA;AAC/B,EAAM,MAAA,cAAA,GAAiB,MAAO,CAAA,iBAAA,CAAkB,UAAU,CAAA,CAAA;AAE1D,EAAM,MAAA,OAAA,GAAU,iDAAgB,iBAAkB,CAAA,SAAA,CAAA,CAAA;AAClD,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,GACF,CAAA;AACF;;ACDA,MAAM,uBAA0B,GAAA,WAAA,CAAA;AAChC,MAAM,aAAgB,GAAA,oBAAA,CAAA;AAEtB,MAAM,oBAAuB,GAAA,0BAAA,CAAA;AAC7B,MAAM,cAAiB,GAAA,mBAAA,CAAA;AACvB,MAAM,uBAA0B,GAAA,+BAAA,CAAA;AAUzB,MAAM,oCAAiE,CAAA;AAAA,EAkBpE,WAAA,CACW,cACjB,MACA,EAAA;AAFiB,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA,CAAA;AAGjB,IAAK,IAAA,CAAA,MAAA,GAAS,iCAAQ,KAAM,CAAA;AAAA,MAC1B,MAAA,EAAQ,KAAK,gBAAiB,EAAA;AAAA,KAChC,CAAA,CAAA;AACA,IAAK,IAAA,CAAA,aAAA,GAAgB,IAAIC,iCAAc,CAAA;AAAA,MACrC,yBAAA,EAA2B,MAAM,IAAA,CAAK,YAAa,CAAA,qBAAA;AAAA,MACnD,MAAQ,EAAA,uBAAA;AAAA,KACT,CAAA,CAAA;AAAA,GACH;AAAA,EAzBA,aAAa,UAAW,CAAA,MAAA,EAAgB,OAA6B,EAAA;AACnE,IAAM,MAAA,CAAA,GAAI,MAAO,CAAA,iBAAA,CAAkB,oCAAoC,CAAA,CAAA;AACvE,IAAA,MAAM,SAAY,GAAA,CAAA,GAAI,yBAA0B,CAAA,CAAC,CAAI,GAAA,KAAA,CAAA,CAAA;AACrD,IAAM,MAAA,qBAAA,GACJL,+CAA6B,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAChD,IAAM,MAAA,YAAA,GAAe,MAAM,qBAAA,CAAsB,qBAAsB,CAAA;AAAA,MACrE,KAAK,SAAW,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,SAAA,CAAA,OAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,oCAAA;AAAA,MACT,YAAA;AAAA,MACA,OAAQ,CAAA,MAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAeA,gBAA2B,GAAA;AACzB,IAAO,OAAA,sCAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AA1FtB,IAAA,IAAA,EAAA,CAAA;AA2FI,IAAI,IAAA,QAAA,CAAS,SAAS,aAAe,EAAA;AACnC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAK,CAAA,EAAA,GAAA,IAAA,CAAA,MAAA,KAAL,mBAAa,IAAK,CAAA,8CAAA,CAAA,CAAA;AAElB,IAAA,CAAC,MAAM,IAAA,CAAK,cAAe,EAAA,EACxB,GAAI,CAAA,CAAA,OAAA,KAAW,IAAK,CAAA,qBAAA,CAAsB,OAAO,CAAC,CAClD,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA;AAChB,MAAI,IAAA,QAAA,CAAS,WAAW,EAAI,EAAA;AAC1B,QAAI,IAAA,MAAA,CAAO,SAAS,WAAa,EAAA;AAC/B,UAAA,OACE,MAAO,CAAA,QAAA,CAAS,WAAY,CAAA,uBAAuB,MACnD,QAAS,CAAA,MAAA,CAAA;AAAA,SAEb;AACA,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAO,OAAA,IAAA,CAAA;AAAA,KACR,CACA,CAAA,OAAA,CAAQ,CAAU,MAAA,KAAA;AACjB,MAAA,IAAA,CAAKM,kCAAiB,CAAA,MAAA,CAAO,QAAU,EAAA,MAAM,CAAC,CAAA,CAAA;AAAA,KAC/C,CAAA,CAAA;AAEH,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,cAAc,IAAsB,EAAA;AAC1C,IAAO,OAAA,IAAA,CACJ,MACA,CAAA,iBAAA,CAAkB,OAAO,CACzB,CAAA,OAAA,CAAQ,mBAAmB,GAAG,CAAA,CAAA;AAAA,GACnC;AAAA,EAEQ,0BAA0B,GAGhC,EAAA;AACA,IAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,KAAA,CAAM,GAAG,CAAA,CAAA;AAE3B,IAAO,OAAA;AAAA,MACL,SAAW,EAAA,KAAA,CAAM,KAAM,CAAA,MAAA,GAAS,CAAC,CAAA;AAAA,MACjC,cAAgB,EAAA,KAAA,CAAM,KAAM,CAAA,MAAA,GAAS,CAAC,CAAA;AAAA,KACxC,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,cAAqC,GAAA;AACjD,IAAA,IAAI,cAAyB,EAAC,CAAA;AAC9B,IAAA,IAAI,gBAAmB,GAAA,IAAA,CAAA;AACvB,IAAA,IAAI,SAAY,GAAA,KAAA,CAAA,CAAA;AAChB,IAAA,OAAO,oBAAoB,SAAW,EAAA;AACpC,MAAmB,gBAAA,GAAA,KAAA,CAAA;AACnB,MAAM,MAAA,WAAA,GACJ,MAAM,IAAK,CAAA,aAAA,CAAc,aAAa,EAAE,SAAA,EAAW,WAAW,CAAA,CAAA;AAChE,MAAA,IAAI,YAAY,QAAU,EAAA;AACxB,QAAc,WAAA,GAAA,WAAA,CAAY,MAAO,CAAA,WAAA,CAAY,QAAQ,CAAA,CAAA;AAAA,OACvD;AACA,MAAA,SAAA,GAAY,WAAY,CAAA,SAAA,CAAA;AAAA,KAC1B;AAEA,IAAO,OAAA,WAAA,CAAA;AAAA,GACT;AAAA,EAEQ,sBAAsB,OAA0C,EAAA;AACtE,IAAA,MAAM,EAAE,SAAA,EAAW,cAAe,EAAA,GAAI,IAAK,CAAA,yBAAA;AAAA,MACzC,OAAQ,CAAA,GAAA;AAAA,KACV,CAAA;AACA,IAAO,OAAA;AAAA,MACL,UAAY,EAAA,uBAAA;AAAA,MACZ,IAAM,EAAA,UAAA;AAAA,MACN,QAAU,EAAA;AAAA,QACR,WAAa,EAAA;AAAA,UACX,CAAC,oBAAoB,GAAG,SAAA;AAAA,UACxB,CAAC,cAAc,GAAG,OAAA,CAAQ,GAAO,IAAA,EAAA;AAAA,UACjC,CAAC,uBAAuB,GAAG,cAAA;AAAA,SAC7B;AAAA,QACA,IAAM,EAAA,IAAA,CAAK,aAAc,CAAA,OAAA,CAAQ,QAAQ,EAAE,CAAA;AAAA,QAC3C,SAAW,EAAA,SAAA;AAAA,OACb;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,IAAM,EAAA,eAAA;AAAA,QACN,KAAO,EAAA,SAAA;AAAA,OACT;AAAA,KACF,CAAA;AAAA,GACF;AACF;;AC7IO,MAAM,uBAAoD,CAAA;AAAA,EAC/D,YAA6B,MAAmB,EAAA;AAAnB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAAA,GAAoB;AAAA,EAEjD,gBAA2B,GAAA;AACzB,IAAO,OAAA,yBAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,QAAA,EACA,MACA,MACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,cAAgB,EAAA;AACpC,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAI,IAAA;AACF,MAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,MAAM,CAAA,CAAA;AAChD,MAAA,KAAA,MAAW,QAAQ,MAAQ,EAAA;AACzB,QAAA,WAAA,MAAiB,eAAe,MAAO,CAAA;AAAA,UACrC,MAAM,IAAK,CAAA,IAAA;AAAA,UACX,UAAU,EAAE,IAAA,EAAM,SAAS,IAAM,EAAA,MAAA,EAAQ,KAAK,GAAI,EAAA;AAAA,SACnD,CAAG,EAAA;AACF,UAAA,IAAA,CAAK,WAAW,CAAA,CAAA;AAAA,SAClB;AAAA,OACF;AAAA,aACO,KAAP,EAAA;AACA,MAAM,MAAA,OAAA,GAAU,CAAkB,eAAA,EAAA,QAAA,CAAS,IAAS,CAAA,EAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAEpD,MAAA,IAAIC,cAAQ,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AACpD,QAAA,IAAI,CAAC,QAAU,EAAA;AACb,UAAA,IAAA,CAAKD,kCAAiB,CAAA,aAAA,CAAc,QAAU,EAAA,OAAO,CAAC,CAAA,CAAA;AAAA,SACxD;AAAA,OACK,MAAA;AACL,QAAA,IAAA,CAAKA,kCAAiB,CAAA,YAAA,CAAa,QAAU,EAAA,OAAO,CAAC,CAAA,CAAA;AAAA,OACvD;AAAA,KACF;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAc,OACZ,QAC0C,EAAA;AAC1C,IAAM,MAAA,OAAA,GAAUE,mCAAe,CAAC,CAAA,CAAA;AAChC,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,MAAA,CAAO,SAAS,QAAQ,CAAA,CAAA;AACpD,IAAM,MAAA,aAAA,GAAgB,MAAM,QAAA,CAAS,KAAM,EAAA,CAAA;AAC3C,IAAA,MAAM,MAAS,GAAA,aAAA,CAAc,GAAI,CAAA,OAAM,IAAS,MAAA;AAAA,MAC9C,KAAK,IAAK,CAAA,IAAA;AAAA,MACV,IAAM,EAAA,MAAM,OAAQ,CAAA,IAAA,CAAK,OAAO,CAAA;AAAA,KAChC,CAAA,CAAA,CAAA;AACF,IAAO,OAAA,OAAA,CAAQ,IAAI,MAAM,CAAA,CAAA;AAAA,GAC3B;AACF;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { CatalogProcessor, CatalogProcessorEmit, CatalogProcessorParser, EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-node';
|
|
2
2
|
import { LocationSpec } from '@backstage/plugin-catalog-common';
|
|
3
|
-
import {
|
|
3
|
+
import { AwsCredentialIdentity } from '@aws-sdk/types';
|
|
4
|
+
import { AwsCredentialsManager } from '@backstage/integration-aws-node';
|
|
4
5
|
import { Config } from '@backstage/config';
|
|
5
6
|
import { Logger } from 'winston';
|
|
6
7
|
import { UrlReader } from '@backstage/backend-common';
|
|
@@ -11,7 +12,7 @@ import { TaskRunner, PluginTaskScheduler } from '@backstage/backend-tasks';
|
|
|
11
12
|
*
|
|
12
13
|
* @public
|
|
13
14
|
*/
|
|
14
|
-
type AWSCredentialFactory = (awsAccountId: string) => Promise<
|
|
15
|
+
type AWSCredentialFactory = (awsAccountId: string) => Promise<AwsCredentialIdentity>;
|
|
15
16
|
|
|
16
17
|
/**
|
|
17
18
|
* A processor for automatic discovery of resources from EKS clusters. Handles the
|
|
@@ -22,8 +23,11 @@ type AWSCredentialFactory = (awsAccountId: string) => Promise<Credentials>;
|
|
|
22
23
|
*/
|
|
23
24
|
declare class AwsEKSClusterProcessor implements CatalogProcessor {
|
|
24
25
|
private credentialsFactory?;
|
|
26
|
+
private credentialsManager?;
|
|
27
|
+
static fromConfig(configRoot: Config): AwsEKSClusterProcessor;
|
|
25
28
|
constructor(options: {
|
|
26
29
|
credentialsFactory?: AWSCredentialFactory;
|
|
30
|
+
credentialsManager?: AwsCredentialsManager;
|
|
27
31
|
});
|
|
28
32
|
getProcessorName(): string;
|
|
29
33
|
normalizeName(name: string): string;
|
|
@@ -39,12 +43,12 @@ declare class AwsEKSClusterProcessor implements CatalogProcessor {
|
|
|
39
43
|
* @public
|
|
40
44
|
*/
|
|
41
45
|
declare class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
|
|
46
|
+
private readonly credProvider;
|
|
42
47
|
private readonly organizations;
|
|
43
|
-
private readonly
|
|
48
|
+
private readonly logger;
|
|
44
49
|
static fromConfig(config: Config, options: {
|
|
45
50
|
logger: Logger;
|
|
46
|
-
}): AwsOrganizationCloudAccountProcessor
|
|
47
|
-
private static buildCredentials;
|
|
51
|
+
}): Promise<AwsOrganizationCloudAccountProcessor>;
|
|
48
52
|
private constructor();
|
|
49
53
|
getProcessorName(): string;
|
|
50
54
|
readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
|
|
@@ -79,10 +83,13 @@ declare class AwsS3DiscoveryProcessor implements CatalogProcessor {
|
|
|
79
83
|
*/
|
|
80
84
|
declare class AwsS3EntityProvider implements EntityProvider {
|
|
81
85
|
private readonly config;
|
|
86
|
+
private readonly integration;
|
|
87
|
+
private readonly awsCredentialsManager;
|
|
82
88
|
private readonly logger;
|
|
83
|
-
private
|
|
89
|
+
private s3?;
|
|
84
90
|
private readonly scheduleFn;
|
|
85
91
|
private connection?;
|
|
92
|
+
private endpoint?;
|
|
86
93
|
static fromConfig(configRoot: Config, options: {
|
|
87
94
|
logger: Logger;
|
|
88
95
|
schedule?: TaskRunner;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-catalog-backend-module-aws",
|
|
3
3
|
"description": "A Backstage catalog backend module that helps integrate towards AWS",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.2.0",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -43,31 +43,36 @@
|
|
|
43
43
|
"clean": "backstage-cli package clean"
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@aws-sdk/client-
|
|
47
|
-
"@
|
|
48
|
-
"@
|
|
49
|
-
"@
|
|
46
|
+
"@aws-sdk/client-eks": "^3.310.0",
|
|
47
|
+
"@aws-sdk/client-organizations": "^3.310.0",
|
|
48
|
+
"@aws-sdk/client-s3": "^3.310.0",
|
|
49
|
+
"@aws-sdk/credential-providers": "^3.310.0",
|
|
50
|
+
"@aws-sdk/middleware-endpoint": "^3.310.0",
|
|
51
|
+
"@aws-sdk/types": "^3.310.0",
|
|
52
|
+
"@backstage/backend-common": "^0.18.5",
|
|
53
|
+
"@backstage/backend-plugin-api": "^0.5.2",
|
|
54
|
+
"@backstage/backend-tasks": "^0.5.2",
|
|
50
55
|
"@backstage/catalog-model": "^1.3.0",
|
|
51
56
|
"@backstage/config": "^1.0.7",
|
|
52
57
|
"@backstage/errors": "^1.1.5",
|
|
53
|
-
"@backstage/integration": "^1.4.5
|
|
58
|
+
"@backstage/integration": "^1.4.5",
|
|
59
|
+
"@backstage/integration-aws-node": "^0.1.3",
|
|
54
60
|
"@backstage/plugin-catalog-common": "^1.0.13",
|
|
55
|
-
"@backstage/plugin-catalog-node": "^1.3.6
|
|
56
|
-
"@backstage/plugin-kubernetes-common": "^0.6.3
|
|
61
|
+
"@backstage/plugin-catalog-node": "^1.3.6",
|
|
62
|
+
"@backstage/plugin-kubernetes-common": "^0.6.3",
|
|
57
63
|
"@backstage/types": "^1.0.2",
|
|
58
|
-
"aws-sdk": "^2.840.0",
|
|
59
64
|
"lodash": "^4.17.21",
|
|
60
65
|
"p-limit": "^3.0.2",
|
|
61
66
|
"uuid": "^8.0.0",
|
|
62
67
|
"winston": "^3.2.1"
|
|
63
68
|
},
|
|
64
69
|
"devDependencies": {
|
|
65
|
-
"@aws-sdk/util-stream-node": "^3.
|
|
66
|
-
"@backstage/backend-test-utils": "^0.1.37
|
|
67
|
-
"@backstage/cli": "^0.22.7
|
|
70
|
+
"@aws-sdk/util-stream-node": "^3.310.0",
|
|
71
|
+
"@backstage/backend-test-utils": "^0.1.37",
|
|
72
|
+
"@backstage/cli": "^0.22.7",
|
|
68
73
|
"@types/lodash": "^4.14.151",
|
|
69
74
|
"aws-sdk-client-mock": "^2.0.0",
|
|
70
|
-
"aws-sdk-mock": "^
|
|
75
|
+
"aws-sdk-client-mock-jest": "^2.0.0",
|
|
71
76
|
"luxon": "^3.0.0",
|
|
72
77
|
"yaml": "^2.0.0"
|
|
73
78
|
},
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"AwsS3EntityProvider-ff893453.cjs.js","sources":["../../src/credentials/AwsCredentials.ts","../../src/providers/config.ts","../../src/providers/AwsS3EntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport aws, { Credentials } from 'aws-sdk';\nimport { CredentialsOptions } from 'aws-sdk/lib/credentials';\n\nexport class AwsCredentials {\n /**\n * If accessKeyId and secretAccessKey are missing, the DefaultAWSCredentialsProviderChain will be used:\n * https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html\n */\n static create(\n config: {\n accessKeyId?: string;\n secretAccessKey?: string;\n roleArn?: string;\n externalId?: string;\n },\n roleSessionName: string,\n ): Credentials | CredentialsOptions | undefined {\n if (!config) {\n return undefined;\n }\n\n const accessKeyId = config.accessKeyId;\n const secretAccessKey = config.secretAccessKey;\n let explicitCredentials: Credentials | undefined;\n\n if (accessKeyId && secretAccessKey) {\n explicitCredentials = new Credentials({\n accessKeyId,\n secretAccessKey,\n });\n }\n\n const roleArn = config.roleArn;\n if (roleArn) {\n return new aws.ChainableTemporaryCredentials({\n masterCredentials: explicitCredentials,\n params: {\n RoleArn: roleArn,\n RoleSessionName: roleSessionName,\n ExternalId: config.externalId,\n },\n });\n }\n\n return explicitCredentials;\n }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { readTaskScheduleDefinitionFromConfig } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { AwsS3Config } from './types';\n\nconst DEFAULT_PROVIDER_ID = 'default';\n\nexport function readAwsS3Configs(config: Config): AwsS3Config[] {\n const configs: AwsS3Config[] = [];\n\n const providerConfigs = config.getOptionalConfig('catalog.providers.awsS3');\n if (!providerConfigs) {\n return configs;\n }\n\n if (providerConfigs.has('bucketName')) {\n // simple/single config variant\n configs.push(readAwsS3Config(DEFAULT_PROVIDER_ID, providerConfigs));\n\n return configs;\n }\n\n for (const id of providerConfigs.keys()) {\n configs.push(readAwsS3Config(id, providerConfigs.getConfig(id)));\n }\n\n return configs;\n}\n\nfunction readAwsS3Config(id: string, config: Config): AwsS3Config {\n const bucketName = config.getString('bucketName');\n const region = config.getOptionalString('region');\n const prefix = config.getOptionalString('prefix');\n\n const schedule = config.has('schedule')\n ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n : undefined;\n\n return {\n id,\n bucketName,\n region,\n prefix,\n schedule,\n };\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginTaskScheduler, TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport { AwsS3Integration, ScmIntegrations } from '@backstage/integration';\nimport {\n EntityProvider,\n EntityProviderConnection,\n locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { AwsCredentials } from '../credentials/AwsCredentials';\nimport { readAwsS3Configs } from './config';\nimport { AwsS3Config } from './types';\nimport { S3 } from 'aws-sdk';\nimport { ListObjectsV2Output } from 'aws-sdk/clients/s3';\nimport * as uuid from 'uuid';\nimport { Logger } from 'winston';\n\n// TODO: event-based updates using S3 events (+ queue like SQS)?\n/**\n * Provider which discovers catalog files (any name) within an S3 bucket.\n *\n * Use `AwsS3EntityProvider.fromConfig(...)` to create instances.\n *\n * @public\n */\nexport class AwsS3EntityProvider implements EntityProvider {\n private readonly logger: Logger;\n private readonly s3: S3;\n private readonly scheduleFn: () => Promise<void>;\n private connection?: EntityProviderConnection;\n\n static fromConfig(\n configRoot: Config,\n options: {\n logger: Logger;\n schedule?: TaskRunner;\n scheduler?: PluginTaskScheduler;\n },\n ): AwsS3EntityProvider[] {\n const providerConfigs = readAwsS3Configs(configRoot);\n\n // Even though the awsS3 integration allows a config array\n // there is no *real* support for multiple configs.\n // Usually, there will be just the integration for the default host.\n // In case, a custom endpoint is used, the host from this endpoint\n // will be extracted and used as host (e.g., localhost when used with LocalStack)\n // and the default integration will be added as second integration.\n // In this case, we still want the first one though, but have no means to select it\n // just from the bucket name (and region).\n const integration = ScmIntegrations.fromConfig(configRoot).awsS3.list()[0];\n if (!integration) {\n throw new Error('No integration found for awsS3');\n }\n\n if (!options.schedule && !options.scheduler) {\n throw new Error('Either schedule or scheduler must be provided.');\n }\n\n return providerConfigs.map(providerConfig => {\n if (!options.schedule && !providerConfig.schedule) {\n throw new Error(\n `No schedule provided neither via code nor config for awsS3-provider:${providerConfig.id}.`,\n );\n }\n\n const taskRunner =\n options.schedule ??\n options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n return new AwsS3EntityProvider(\n providerConfig,\n integration,\n options.logger,\n taskRunner,\n );\n });\n }\n\n private constructor(\n private readonly config: AwsS3Config,\n integration: AwsS3Integration,\n logger: Logger,\n taskRunner: TaskRunner,\n ) {\n this.logger = logger.child({\n target: this.getProviderName(),\n });\n\n this.s3 = new S3({\n apiVersion: '2006-03-01',\n credentials: AwsCredentials.create(\n integration.config,\n 'backstage-aws-s3-provider',\n ),\n endpoint: integration.config.endpoint,\n region: this.config.region,\n s3ForcePathStyle: integration.config.s3ForcePathStyle,\n });\n\n this.scheduleFn = this.createScheduleFn(taskRunner);\n }\n\n private createScheduleFn(taskRunner: TaskRunner): () => Promise<void> {\n return async () => {\n const taskId = `${this.getProviderName()}:refresh`;\n return taskRunner.run({\n id: taskId,\n fn: async () => {\n const logger = this.logger.child({\n class: AwsS3EntityProvider.prototype.constructor.name,\n taskId,\n taskInstanceId: uuid.v4(),\n });\n\n try {\n await this.refresh(logger);\n } catch (error) {\n logger.error(`${this.getProviderName()} refresh failed`, error);\n }\n },\n });\n };\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n getProviderName(): string {\n return `awsS3-provider:${this.config.id}`;\n }\n\n /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n async connect(connection: EntityProviderConnection): Promise<void> {\n this.connection = connection;\n await this.scheduleFn();\n }\n\n async refresh(logger: Logger) {\n if (!this.connection) {\n throw new Error('Not initialized');\n }\n\n logger.info('Discovering AWS S3 objects');\n\n const keys = await this.listAllObjectKeys();\n logger.info(`Discovered ${keys.length} AWS S3 objects`);\n\n const locations = keys.map(key => this.createLocationSpec(key));\n\n await this.connection.applyMutation({\n type: 'full',\n entities: locations.map(location => {\n return {\n locationKey: this.getProviderName(),\n entity: locationSpecToLocationEntity({ location }),\n };\n }),\n });\n\n logger.info(`Committed ${locations.length} Locations for AWS S3 objects`);\n }\n\n private async listAllObjectKeys(): Promise<string[]> {\n const keys: string[] = [];\n\n let continuationToken: string | undefined = undefined;\n let output: ListObjectsV2Output;\n do {\n const request = this.s3.listObjectsV2({\n Bucket: this.config.bucketName,\n ContinuationToken: continuationToken,\n Prefix: this.config.prefix,\n });\n\n output = await request.promise();\n if (output.Contents) {\n output.Contents.forEach(item => {\n if (item.Key && !item.Key.endsWith('/')) {\n keys.push(item.Key);\n }\n });\n }\n continuationToken = output.NextContinuationToken;\n } while (continuationToken);\n\n return keys;\n }\n\n private createLocationSpec(key: string): LocationSpec {\n return {\n type: 'url',\n target: this.createObjectUrl(key),\n presence: 'required',\n };\n }\n\n private createObjectUrl(key: string): string {\n const bucketName = this.config.bucketName;\n const endpoint = this.s3.endpoint.href;\n\n return encodeURI(`${endpoint}${bucketName}/${key}`);\n }\n}\n"],"names":["Credentials","aws","readTaskScheduleDefinitionFromConfig","S3","integration","ScmIntegrations","uuid","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBO,MAAM,cAAe,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAK1B,OAAO,MACL,CAAA,MAAA,EAMA,eAC8C,EAAA;AAC9C,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAEA,IAAA,MAAM,cAAc,MAAO,CAAA,WAAA,CAAA;AAC3B,IAAA,MAAM,kBAAkB,MAAO,CAAA,eAAA,CAAA;AAC/B,IAAI,IAAA,mBAAA,CAAA;AAEJ,IAAA,IAAI,eAAe,eAAiB,EAAA;AAClC,MAAA,mBAAA,GAAsB,IAAIA,eAAY,CAAA;AAAA,QACpC,WAAA;AAAA,QACA,eAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,MAAM,UAAU,MAAO,CAAA,OAAA,CAAA;AACvB,IAAA,IAAI,OAAS,EAAA;AACX,MAAO,OAAA,IAAIC,wBAAI,6BAA8B,CAAA;AAAA,QAC3C,iBAAmB,EAAA,mBAAA;AAAA,QACnB,MAAQ,EAAA;AAAA,UACN,OAAS,EAAA,OAAA;AAAA,UACT,eAAiB,EAAA,eAAA;AAAA,UACjB,YAAY,MAAO,CAAA,UAAA;AAAA,SACrB;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,mBAAA,CAAA;AAAA,GACT;AACF;;AC1CA,MAAM,mBAAsB,GAAA,SAAA,CAAA;AAErB,SAAS,iBAAiB,MAA+B,EAAA;AAC9D,EAAA,MAAM,UAAyB,EAAC,CAAA;AAEhC,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,yBAAyB,CAAA,CAAA;AAC1E,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,YAAY,CAAG,EAAA;AAErC,IAAA,OAAA,CAAQ,IAAK,CAAA,eAAA,CAAgB,mBAAqB,EAAA,eAAe,CAAC,CAAA,CAAA;AAElE,IAAO,OAAA,OAAA,CAAA;AAAA,GACT;AAEA,EAAW,KAAA,MAAA,EAAA,IAAM,eAAgB,CAAA,IAAA,EAAQ,EAAA;AACvC,IAAA,OAAA,CAAQ,KAAK,eAAgB,CAAA,EAAA,EAAI,gBAAgB,SAAU,CAAA,EAAE,CAAC,CAAC,CAAA,CAAA;AAAA,GACjE;AAEA,EAAO,OAAA,OAAA,CAAA;AACT,CAAA;AAEA,SAAS,eAAA,CAAgB,IAAY,MAA6B,EAAA;AAChE,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,SAAA,CAAU,YAAY,CAAA,CAAA;AAChD,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA,CAAA;AAChD,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,iBAAA,CAAkB,QAAQ,CAAA,CAAA;AAEhD,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCC,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,UAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAA;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF;;ACnBO,MAAM,mBAA8C,CAAA;AAAA,EAqDjD,WACW,CAAA,MAAA,EACjB,WACA,EAAA,MAAA,EACA,UACA,EAAA;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AAKjB,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AAED,IAAK,IAAA,CAAA,EAAA,GAAK,IAAIC,MAAG,CAAA;AAAA,MACf,UAAY,EAAA,YAAA;AAAA,MACZ,aAAa,cAAe,CAAA,MAAA;AAAA,QAC1B,WAAY,CAAA,MAAA;AAAA,QACZ,2BAAA;AAAA,OACF;AAAA,MACA,QAAA,EAAU,YAAY,MAAO,CAAA,QAAA;AAAA,MAC7B,MAAA,EAAQ,KAAK,MAAO,CAAA,MAAA;AAAA,MACpB,gBAAA,EAAkB,YAAY,MAAO,CAAA,gBAAA;AAAA,KACtC,CAAA,CAAA;AAED,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EArEA,OAAO,UACL,CAAA,UAAA,EACA,OAKuB,EAAA;AACvB,IAAM,MAAA,eAAA,GAAkB,iBAAiB,UAAU,CAAA,CAAA;AAUnD,IAAM,MAAAC,aAAA,GAAcC,4BAAgB,UAAW,CAAA,UAAU,EAAE,KAAM,CAAA,IAAA,GAAO,CAAC,CAAA,CAAA;AACzE,IAAA,IAAI,CAACD,aAAa,EAAA;AAChB,MAAM,MAAA,IAAI,MAAM,gCAAgC,CAAA,CAAA;AAAA,KAClD;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAO,OAAA,eAAA,CAAgB,IAAI,CAAkB,cAAA,KAAA;AA1EjD,MAAA,IAAA,EAAA,CAAA;AA2EM,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,uEAAuE,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SACxF,CAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAA,OAAO,IAAI,mBAAA;AAAA,QACT,cAAA;AAAA,QACAA,aAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,QACR,UAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EA0BQ,iBAAiB,UAA6C,EAAA;AACpE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,CAAG,EAAA,IAAA,CAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AACvC,MAAA,OAAO,WAAW,GAAI,CAAA;AAAA,QACpB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,mBAAoB,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YACjD,MAAA;AAAA,YACA,cAAA,EAAgBE,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,KAAM,CAAA,CAAA,EAAG,IAAK,CAAA,eAAA,qBAAoC,KAAK,CAAA,CAAA;AAAA,WAChE;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,eAAA,EAAkB,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GACvC;AAAA;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,QAAQ,MAAgB,EAAA;AAC5B,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAA,CAAO,KAAK,4BAA4B,CAAA,CAAA;AAExC,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,iBAAkB,EAAA,CAAA;AAC1C,IAAO,MAAA,CAAA,IAAA,CAAK,CAAc,WAAA,EAAA,IAAA,CAAK,MAAuB,CAAA,eAAA,CAAA,CAAA,CAAA;AAEtD,IAAA,MAAM,YAAY,IAAK,CAAA,GAAA,CAAI,SAAO,IAAK,CAAA,kBAAA,CAAmB,GAAG,CAAC,CAAA,CAAA;AAE9D,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA,EAAU,SAAU,CAAA,GAAA,CAAI,CAAY,QAAA,KAAA;AAClC,QAAO,OAAA;AAAA,UACL,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,UAClC,MAAQ,EAAAC,8CAAA,CAA6B,EAAE,QAAA,EAAU,CAAA;AAAA,SACnD,CAAA;AAAA,OACD,CAAA;AAAA,KACF,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,IAAA,CAAK,CAAa,UAAA,EAAA,SAAA,CAAU,MAAqC,CAAA,6BAAA,CAAA,CAAA,CAAA;AAAA,GAC1E;AAAA,EAEA,MAAc,iBAAuC,GAAA;AACnD,IAAA,MAAM,OAAiB,EAAC,CAAA;AAExB,IAAA,IAAI,iBAAwC,GAAA,KAAA,CAAA,CAAA;AAC5C,IAAI,IAAA,MAAA,CAAA;AACJ,IAAG,GAAA;AACD,MAAM,MAAA,OAAA,GAAU,IAAK,CAAA,EAAA,CAAG,aAAc,CAAA;AAAA,QACpC,MAAA,EAAQ,KAAK,MAAO,CAAA,UAAA;AAAA,QACpB,iBAAmB,EAAA,iBAAA;AAAA,QACnB,MAAA,EAAQ,KAAK,MAAO,CAAA,MAAA;AAAA,OACrB,CAAA,CAAA;AAED,MAAS,MAAA,GAAA,MAAM,QAAQ,OAAQ,EAAA,CAAA;AAC/B,MAAA,IAAI,OAAO,QAAU,EAAA;AACnB,QAAO,MAAA,CAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AAC9B,UAAA,IAAI,KAAK,GAAO,IAAA,CAAC,KAAK,GAAI,CAAA,QAAA,CAAS,GAAG,CAAG,EAAA;AACvC,YAAK,IAAA,CAAA,IAAA,CAAK,KAAK,GAAG,CAAA,CAAA;AAAA,WACpB;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AACA,MAAA,iBAAA,GAAoB,MAAO,CAAA,qBAAA,CAAA;AAAA,KACpB,QAAA,iBAAA,EAAA;AAET,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA,EAEQ,mBAAmB,GAA2B,EAAA;AACpD,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA,EAAQ,IAAK,CAAA,eAAA,CAAgB,GAAG,CAAA;AAAA,MAChC,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AAAA,EAEQ,gBAAgB,GAAqB,EAAA;AAC3C,IAAM,MAAA,UAAA,GAAa,KAAK,MAAO,CAAA,UAAA,CAAA;AAC/B,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,EAAA,CAAG,QAAS,CAAA,IAAA,CAAA;AAElC,IAAA,OAAO,SAAU,CAAA,CAAA,EAAG,QAAW,CAAA,EAAA,UAAA,CAAA,CAAA,EAAc,GAAK,CAAA,CAAA,CAAA,CAAA;AAAA,GACpD;AACF;;;;"}
|