Skip to content

Commit 15909f0

Browse files
Merge pull request #121 from clearlydefined/RomanIakovlev-patch-1
Specify actual storage container for changes notifications in README
2 parents d0b6ffb + 38e3197 commit 15909f0

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

tools/blobstorage-backupdata/README.MD

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ parties to maintain the complete mirror of ClearlyDefined definitions, and doing
1515
## Published data structure
1616

1717
The changes published into a storage account named `clearlydefinedprod`, in a container named
18-
`production-snapshots`. This container doesn't allow for listing of objects, because of costs
18+
`changes-notifications`, so that the complete base URL is
19+
`https://clearlydefinedprod.blob.core.windows.net/changes-notifications`.
20+
This container doesn't allow for listing of objects, because of costs
1921
considerations. Instead, the following mechanism is used to notify users of new changes.
2022

2123
The files contained in the storage container can be split into two categories:
@@ -110,7 +112,7 @@ excluding the `files` part.
110112
</details>
111113

112114
### Indexing files
113-
Indexing files are contained in the `changes` sub-directory of the `production-snapshots` container.
115+
Indexing files are contained in the `changes` sub-directory of the `changes-notifications` container.
114116
There are further two categories of these files:
115117
1. Changeset files,
116118
2. `index` file.
@@ -216,10 +218,10 @@ The software responsible for producing the data according to the definition abov
216218
`blobstorage-backupdata`. It's published as a Docker image to GitHub container registry and
217219
deployed to Azure Container Instances. It's scheduled to run hourly.
218220

219-
Every time it runs it inspects the `changes\index` file and calculates the time interval
221+
Every time it runs it inspects the `changes/index` file and calculates the time interval
220222
where no changes have been published yet. It then requests the changes made in this calculated
221223
interval from the main database, and publishes the resulting definitions and changesets. It also
222-
updates the `changes\index` file by adding the published changeset entries.
224+
updates the `changes/index` file by adding the published changeset entries.
223225

224226
### Operations
225227
`blobstorage-backupdata` is built on every merge to main branch. It done using GitHub action defined in
@@ -240,4 +242,4 @@ It's possible to run `blobstorage-backupdata` locally, either via Docker or dire
240242
using e.g. `docker build ./tools/blobstorage-backupdata -t pcj:latest` and then run via
241243
`docker run --env-file .env -i pcj:latest`. The `.env` file contains sensitive data and is not published in this
242244
repository, so you should create it yourself, e.g. from the `template.env` and specify the necessary information,
243-
obtained separately.
245+
obtained separately.

0 commit comments

Comments
 (0)