@backstage/plugin-catalog-backend-module-aws 0.0.0-nightly-20220410023309 → 0.0.0-nightly-20220413023505

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.
Files changed (2) hide show
  1. package/CHANGELOG.md +89 -6
  2. package/package.json +7 -7
package/CHANGELOG.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @backstage/plugin-catalog-backend-module-aws
2
2
 
3
- ## 0.0.0-nightly-20220410023309
3
+ ## 0.0.0-nightly-20220413023505
4
4
 
5
5
  ### Patch Changes
6
6
 
@@ -79,11 +79,94 @@
79
79
 
80
80
  - 776a91ea3a: Corrected title and URL to setup documentation in README
81
81
  - Updated dependencies
82
- - @backstage/plugin-catalog-backend@0.0.0-nightly-20220410023309
83
- - @backstage/integration@0.0.0-nightly-20220410023309
84
- - @backstage/backend-tasks@0.0.0-nightly-20220410023309
85
- - @backstage/catalog-model@0.0.0-nightly-20220410023309
86
- - @backstage/backend-common@0.0.0-nightly-20220410023309
82
+ - @backstage/plugin-catalog-backend@0.0.0-nightly-20220413023505
83
+ - @backstage/integration@0.0.0-nightly-20220413023505
84
+ - @backstage/backend-tasks@0.0.0-nightly-20220413023505
85
+ - @backstage/catalog-model@0.0.0-nightly-20220413023505
86
+ - @backstage/backend-common@0.0.0-nightly-20220413023505
87
+
88
+ ## 0.1.4-next.2
89
+
90
+ ### Patch Changes
91
+
92
+ - 5969c4b65c: Add a new provider `AwsS3EntityProvider` as replacement for `AwsS3DiscoveryProcessor`.
93
+
94
+ In order to migrate from the `AwsS3DiscoveryProcessor` you need to apply
95
+ the following changes:
96
+
97
+ **Before:**
98
+
99
+ ```yaml
100
+ # app-config.yaml
101
+
102
+ catalog:
103
+ locations:
104
+ - type: s3-discovery
105
+ target: https://sample-bucket.s3.us-east-2.amazonaws.com/prefix/
106
+ ```
107
+
108
+ ```ts
109
+ /* packages/backend/src/plugins/catalog.ts */
110
+
111
+ import { AwsS3DiscoveryProcessor } from '@backstage/plugin-catalog-backend-module-aws';
112
+
113
+ const builder = await CatalogBuilder.create(env);
114
+ /** ... other processors ... */
115
+ builder.addProcessor(new AwsS3DiscoveryProcessor(env.reader));
116
+ ```
117
+
118
+ **After:**
119
+
120
+ ```yaml
121
+ # app-config.yaml
122
+
123
+ catalog:
124
+ providers:
125
+ awsS3:
126
+ yourProviderId: # identifies your dataset / provider independent of config changes
127
+ bucketName: sample-bucket
128
+ prefix: prefix/ # optional
129
+ region: us-east-2 # optional, uses the default region otherwise
130
+ ```
131
+
132
+ ```ts
133
+ /* packages/backend/src/plugins/catalog.ts */
134
+
135
+ import { AwsS3EntityProvider } from '@backstage/plugin-catalog-backend-module-aws';
136
+
137
+ const builder = await CatalogBuilder.create(env);
138
+ /** ... other processors and/or providers ... */
139
+ builder.addEntityProvider(
140
+ ...AwsS3EntityProvider.fromConfig(env.config, {
141
+ logger: env.logger,
142
+ schedule: env.scheduler.createScheduledTaskRunner({
143
+ frequency: Duration.fromObject({ minutes: 30 }),
144
+ timeout: Duration.fromObject({ minutes: 3 }),
145
+ }),
146
+ }),
147
+ );
148
+ ```
149
+
150
+ For simple setups, you can omit the provider ID at the config
151
+ which has the same effect as using `default` for it.
152
+
153
+ ```yaml
154
+ # app-config.yaml
155
+
156
+ catalog:
157
+ providers:
158
+ awsS3:
159
+ # uses "default" as provider ID
160
+ bucketName: sample-bucket
161
+ prefix: prefix/ # optional
162
+ region: us-east-2 # optional, uses the default region otherwise
163
+ ```
164
+
165
+ - 776a91ea3a: Corrected title and URL to setup documentation in README
166
+ - Updated dependencies
167
+ - @backstage/plugin-catalog-backend@1.1.0-next.3
168
+ - @backstage/backend-common@0.13.2-next.2
169
+ - @backstage/integration@1.1.0-next.2
87
170
 
88
171
  ## 0.1.4-next.1
89
172
 
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.0.0-nightly-20220410023309",
4
+ "version": "0.0.0-nightly-20220413023505",
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.0.0-nightly-20220410023309",
37
- "@backstage/backend-tasks": "^0.0.0-nightly-20220410023309",
38
- "@backstage/catalog-model": "^0.0.0-nightly-20220410023309",
36
+ "@backstage/backend-common": "^0.0.0-nightly-20220413023505",
37
+ "@backstage/backend-tasks": "^0.0.0-nightly-20220413023505",
38
+ "@backstage/catalog-model": "^0.0.0-nightly-20220413023505",
39
39
  "@backstage/config": "^1.0.0",
40
40
  "@backstage/errors": "^1.0.0",
41
- "@backstage/integration": "^0.0.0-nightly-20220410023309",
42
- "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20220410023309",
41
+ "@backstage/integration": "^0.0.0-nightly-20220413023505",
42
+ "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20220413023505",
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.0.0-nightly-20220410023309",
51
+ "@backstage/cli": "^0.0.0-nightly-20220413023505",
52
52
  "@types/lodash": "^4.14.151",
53
53
  "aws-sdk-mock": "^5.2.1",
54
54
  "yaml": "^1.9.2"