@backstage/plugin-catalog-backend-module-incremental-ingestion 0.0.0-nightly-20230704023301 → 0.0.0-nightly-20230705023459

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 (4) hide show
  1. package/CHANGELOG.md +11 -10
  2. package/README.md +16 -21
  3. package/alpha/package.json +1 -1
  4. package/package.json +14 -14
package/CHANGELOG.md CHANGED
@@ -1,20 +1,21 @@
1
1
  # @backstage/plugin-catalog-backend-module-incremental-ingestion
2
2
 
3
- ## 0.0.0-nightly-20230704023301
3
+ ## 0.0.0-nightly-20230705023459
4
4
 
5
5
  ### Patch Changes
6
6
 
7
+ - e1d615757f48: Update readme and instructions
7
8
  - Updated dependencies
8
- - @backstage/errors@0.0.0-nightly-20230704023301
9
- - @backstage/backend-common@0.0.0-nightly-20230704023301
10
- - @backstage/plugin-catalog-backend@0.0.0-nightly-20230704023301
11
- - @backstage/plugin-catalog-node@0.0.0-nightly-20230704023301
12
- - @backstage/backend-plugin-api@0.0.0-nightly-20230704023301
13
- - @backstage/backend-tasks@0.0.0-nightly-20230704023301
14
- - @backstage/catalog-model@0.0.0-nightly-20230704023301
9
+ - @backstage/errors@0.0.0-nightly-20230705023459
10
+ - @backstage/backend-common@0.0.0-nightly-20230705023459
11
+ - @backstage/plugin-catalog-backend@0.0.0-nightly-20230705023459
12
+ - @backstage/plugin-catalog-node@0.0.0-nightly-20230705023459
13
+ - @backstage/backend-plugin-api@0.0.0-nightly-20230705023459
14
+ - @backstage/backend-tasks@0.0.0-nightly-20230705023459
15
+ - @backstage/catalog-model@0.0.0-nightly-20230705023459
15
16
  - @backstage/config@1.0.8
16
- - @backstage/plugin-events-node@0.0.0-nightly-20230704023301
17
- - @backstage/plugin-permission-common@0.0.0-nightly-20230704023301
17
+ - @backstage/plugin-events-node@0.0.0-nightly-20230705023459
18
+ - @backstage/plugin-permission-common@0.0.0-nightly-20230705023459
18
19
 
19
20
  ## 0.3.4-next.0
20
21
 
package/README.md CHANGED
@@ -99,18 +99,18 @@ export default async function createPlugin(
99
99
 
100
100
  If you want to manage your incremental entity providers via REST endpoints, the following endpoints are available:
101
101
 
102
- | Method | Path | Description |
103
- | ------ | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
104
- | GET | `/incremental/health` | Checks the health of all incremental providers. Returns array of any unhealthy ones. |
105
- | GET | `/incremental/providers` | Get a list of all known incremental entity providers |
106
- | GET | `/incremental/providers/:provider` | Checks the status of an incremental provider (resting, interstitial, etc). |
107
- | POST | `/incremental/providers/:provider/trigger` | Triggers a provider's next action immediately. E.g., if it's currently interstitial, it will trigger the next burst. |
108
- | POST | `/incremental/providers/:provider/start` | Stop the current ingestion cycle and start a new one immediately. |
109
- | POST | `/incremental/providers/:provider/cancel` | Stop the current ingestion cycle and start a new one in 24 hours. |
110
- | DELETE | `/incremental/providers/:provider` | Completely remove all records for the provider and schedule it to start again in 24 hours. |
111
- | GET | `/incremental/providers/:provider/marks` | Retrieve a list of all ingestion marks for the current ingestion cycle. |
112
- | DELETE | `/incremental/providers/:provider/marks` | Remove all ingestion marks for the current ingestion cycle. |
113
- | POST | `/incremental/cleanup` | Completely remove all records for ALL providers and schedule them to start again in 24 hours. (CAUTION! Can cause orphans!) |
102
+ | Method | Path | Description |
103
+ | ------ | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
104
+ | GET | `/api/catalog/incremental/health` | Checks the health of all incremental providers. Returns array of any unhealthy ones. |
105
+ | GET | `/api/catalog/incremental/providers` | Get a list of all known incremental entity providers |
106
+ | GET | `/api/catalog/incremental/providers/:provider` | Checks the status of an incremental provider (resting, interstitial, etc). |
107
+ | POST | `/api/catalog/incremental/providers/:provider/trigger` | Triggers a provider's next action immediately. E.g., if it's currently interstitial, it will trigger the next burst. |
108
+ | POST | `/api/catalog/incremental/providers/:provider/start` | Stop the current ingestion cycle and start a new one immediately. |
109
+ | POST | `/api/catalog/incremental/providers/:provider/cancel` | Stop the current ingestion cycle and start a new one in 24 hours. |
110
+ | DELETE | `/api/catalog/incremental/providers/:provider` | Completely remove all records for the provider and schedule it to start again in 24 hours. |
111
+ | GET | `/api/catalog/incremental/providers/:provider/marks` | Retrieve a list of all ingestion marks for the current ingestion cycle. |
112
+ | DELETE | `/api/catalog/incremental/providers/:provider/marks` | Remove all ingestion marks for the current ingestion cycle. |
113
+ | POST | `/api/catalog/incremental/cleanup` | Completely remove all records for ALL providers and schedule them to start again in 24 hours. (CAUTION! Can cause orphans!) |
114
114
 
115
115
  In all cases, `:provider` is the name of the incremental entity provider.
116
116
 
@@ -323,22 +323,17 @@ incrementalBuilder.addIncrementalEntityProvider(myEntityProvider, {
323
323
  // How long should it attempt to read pages from the API in a
324
324
  // single burst? Keep this short. The Incremental Entity Provider
325
325
  // will attempt to read as many pages as it can in this time
326
- burstLength: Duration.fromObject({ seconds: 3 }),
326
+ burstLength: { seconds: 3 },
327
327
 
328
328
  // How long should it wait between bursts?
329
- burstInterval: Duration.fromObject({ seconds: 3 }),
329
+ burstInterval: { seconds: 3 },
330
330
 
331
331
  // How long should it rest before re-ingesting again?
332
- restLength: Duration.fromObject({ day: 1 }),
332
+ restLength: { day: 1 },
333
333
 
334
334
  // Optional back-off configuration - how long should it wait to retry
335
335
  // in the event of an error?
336
- backoff: [
337
- Duration.fromObject({ seconds: 5 }),
338
- Duration.fromObject({ seconds: 30 }),
339
- Duration.fromObject({ minutes: 10 }),
340
- Duration.fromObject({ hours: 3 }),
341
- ],
336
+ backoff: [{ seconds: 5 }, { seconds: 30 }, { minutes: 10 }, { hours: 3 }],
342
337
 
343
338
  // Optional. Use this to prevent removal of entities above a given
344
339
  // percentage. This can be helpful if a data source is flaky and
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
3
- "version": "0.0.0-nightly-20230704023301",
3
+ "version": "0.0.0-nightly-20230705023459",
4
4
  "main": "../dist/alpha.cjs.js",
5
5
  "types": "../dist/alpha.d.ts"
6
6
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-backend-module-incremental-ingestion",
3
3
  "description": "An entity provider for streaming large asset sources into the catalog",
4
- "version": "0.0.0-nightly-20230704023301",
4
+ "version": "0.0.0-nightly-20230705023459",
5
5
  "main": "./dist/index.cjs.js",
6
6
  "types": "./dist/index.d.ts",
7
7
  "license": "Apache-2.0",
@@ -43,16 +43,16 @@
43
43
  "postpack": "backstage-cli package postpack"
44
44
  },
45
45
  "dependencies": {
46
- "@backstage/backend-common": "^0.0.0-nightly-20230704023301",
47
- "@backstage/backend-plugin-api": "^0.0.0-nightly-20230704023301",
48
- "@backstage/backend-tasks": "^0.0.0-nightly-20230704023301",
49
- "@backstage/catalog-model": "^0.0.0-nightly-20230704023301",
46
+ "@backstage/backend-common": "^0.0.0-nightly-20230705023459",
47
+ "@backstage/backend-plugin-api": "^0.0.0-nightly-20230705023459",
48
+ "@backstage/backend-tasks": "^0.0.0-nightly-20230705023459",
49
+ "@backstage/catalog-model": "^0.0.0-nightly-20230705023459",
50
50
  "@backstage/config": "^1.0.8",
51
- "@backstage/errors": "^0.0.0-nightly-20230704023301",
52
- "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20230704023301",
53
- "@backstage/plugin-catalog-node": "^0.0.0-nightly-20230704023301",
54
- "@backstage/plugin-events-node": "^0.0.0-nightly-20230704023301",
55
- "@backstage/plugin-permission-common": "^0.0.0-nightly-20230704023301",
51
+ "@backstage/errors": "^0.0.0-nightly-20230705023459",
52
+ "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20230705023459",
53
+ "@backstage/plugin-catalog-node": "^0.0.0-nightly-20230705023459",
54
+ "@backstage/plugin-events-node": "^0.0.0-nightly-20230705023459",
55
+ "@backstage/plugin-permission-common": "^0.0.0-nightly-20230705023459",
56
56
  "@types/express": "^4.17.6",
57
57
  "@types/luxon": "^3.0.0",
58
58
  "express": "^4.17.1",
@@ -64,10 +64,10 @@
64
64
  "winston": "^3.2.1"
65
65
  },
66
66
  "devDependencies": {
67
- "@backstage/backend-app-api": "^0.0.0-nightly-20230704023301",
68
- "@backstage/backend-defaults": "^0.0.0-nightly-20230704023301",
69
- "@backstage/backend-test-utils": "^0.0.0-nightly-20230704023301",
70
- "@backstage/cli": "^0.0.0-nightly-20230704023301"
67
+ "@backstage/backend-app-api": "^0.0.0-nightly-20230705023459",
68
+ "@backstage/backend-defaults": "^0.0.0-nightly-20230705023459",
69
+ "@backstage/backend-test-utils": "^0.0.0-nightly-20230705023459",
70
+ "@backstage/cli": "^0.0.0-nightly-20230705023459"
71
71
  },
72
72
  "files": [
73
73
  "dist",