@backstage/plugin-catalog-backend-module-aws 0.1.4-next.2 → 0.1.4
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 +85 -0
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,90 @@
|
|
|
1
1
|
# @backstage/plugin-catalog-backend-module-aws
|
|
2
2
|
|
|
3
|
+
## 0.1.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 5969c4b65c: Add a new provider `AwsS3EntityProvider` as replacement for `AwsS3DiscoveryProcessor`.
|
|
8
|
+
|
|
9
|
+
In order to migrate from the `AwsS3DiscoveryProcessor` you need to apply
|
|
10
|
+
the following changes:
|
|
11
|
+
|
|
12
|
+
**Before:**
|
|
13
|
+
|
|
14
|
+
```yaml
|
|
15
|
+
# app-config.yaml
|
|
16
|
+
|
|
17
|
+
catalog:
|
|
18
|
+
locations:
|
|
19
|
+
- type: s3-discovery
|
|
20
|
+
target: https://sample-bucket.s3.us-east-2.amazonaws.com/prefix/
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
/* packages/backend/src/plugins/catalog.ts */
|
|
25
|
+
|
|
26
|
+
import { AwsS3DiscoveryProcessor } from '@backstage/plugin-catalog-backend-module-aws';
|
|
27
|
+
|
|
28
|
+
const builder = await CatalogBuilder.create(env);
|
|
29
|
+
/** ... other processors ... */
|
|
30
|
+
builder.addProcessor(new AwsS3DiscoveryProcessor(env.reader));
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**After:**
|
|
34
|
+
|
|
35
|
+
```yaml
|
|
36
|
+
# app-config.yaml
|
|
37
|
+
|
|
38
|
+
catalog:
|
|
39
|
+
providers:
|
|
40
|
+
awsS3:
|
|
41
|
+
yourProviderId: # identifies your dataset / provider independent of config changes
|
|
42
|
+
bucketName: sample-bucket
|
|
43
|
+
prefix: prefix/ # optional
|
|
44
|
+
region: us-east-2 # optional, uses the default region otherwise
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
/* packages/backend/src/plugins/catalog.ts */
|
|
49
|
+
|
|
50
|
+
import { AwsS3EntityProvider } from '@backstage/plugin-catalog-backend-module-aws';
|
|
51
|
+
|
|
52
|
+
const builder = await CatalogBuilder.create(env);
|
|
53
|
+
/** ... other processors and/or providers ... */
|
|
54
|
+
builder.addEntityProvider(
|
|
55
|
+
...AwsS3EntityProvider.fromConfig(env.config, {
|
|
56
|
+
logger: env.logger,
|
|
57
|
+
schedule: env.scheduler.createScheduledTaskRunner({
|
|
58
|
+
frequency: Duration.fromObject({ minutes: 30 }),
|
|
59
|
+
timeout: Duration.fromObject({ minutes: 3 }),
|
|
60
|
+
}),
|
|
61
|
+
}),
|
|
62
|
+
);
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
For simple setups, you can omit the provider ID at the config
|
|
66
|
+
which has the same effect as using `default` for it.
|
|
67
|
+
|
|
68
|
+
```yaml
|
|
69
|
+
# app-config.yaml
|
|
70
|
+
|
|
71
|
+
catalog:
|
|
72
|
+
providers:
|
|
73
|
+
awsS3:
|
|
74
|
+
# uses "default" as provider ID
|
|
75
|
+
bucketName: sample-bucket
|
|
76
|
+
prefix: prefix/ # optional
|
|
77
|
+
region: us-east-2 # optional, uses the default region otherwise
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
- 776a91ea3a: Corrected title and URL to setup documentation in README
|
|
81
|
+
- Updated dependencies
|
|
82
|
+
- @backstage/plugin-catalog-backend@1.1.0
|
|
83
|
+
- @backstage/integration@1.1.0
|
|
84
|
+
- @backstage/backend-tasks@0.3.0
|
|
85
|
+
- @backstage/catalog-model@1.0.1
|
|
86
|
+
- @backstage/backend-common@0.13.2
|
|
87
|
+
|
|
3
88
|
## 0.1.4-next.2
|
|
4
89
|
|
|
5
90
|
### Patch Changes
|
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.1.4
|
|
4
|
+
"version": "0.1.4",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -33,13 +33,13 @@
|
|
|
33
33
|
"start": "backstage-cli package start"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@backstage/backend-common": "^0.13.2
|
|
37
|
-
"@backstage/backend-tasks": "^0.3.0
|
|
38
|
-
"@backstage/catalog-model": "^1.0.1
|
|
36
|
+
"@backstage/backend-common": "^0.13.2",
|
|
37
|
+
"@backstage/backend-tasks": "^0.3.0",
|
|
38
|
+
"@backstage/catalog-model": "^1.0.1",
|
|
39
39
|
"@backstage/config": "^1.0.0",
|
|
40
40
|
"@backstage/errors": "^1.0.0",
|
|
41
|
-
"@backstage/integration": "^1.1.0
|
|
42
|
-
"@backstage/plugin-catalog-backend": "^1.1.0
|
|
41
|
+
"@backstage/integration": "^1.1.0",
|
|
42
|
+
"@backstage/plugin-catalog-backend": "^1.1.0",
|
|
43
43
|
"@backstage/types": "^1.0.0",
|
|
44
44
|
"aws-sdk": "^2.840.0",
|
|
45
45
|
"lodash": "^4.17.21",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"winston": "^3.2.1"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"@backstage/cli": "^0.17.0
|
|
51
|
+
"@backstage/cli": "^0.17.0",
|
|
52
52
|
"@types/lodash": "^4.14.151",
|
|
53
53
|
"aws-sdk-mock": "^5.2.1",
|
|
54
54
|
"yaml": "^1.9.2"
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"config.d.ts"
|
|
59
59
|
],
|
|
60
60
|
"configSchema": "config.d.ts",
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "e0e44c433319711c2fb8b175db411a621f7aaec2"
|
|
62
62
|
}
|