Skip to content

Commit 65ad56d

Browse files
committed
Update changelog and setup instructions
Signed-off-by: Victor Chang <[email protected]>
1 parent 65f0310 commit 65ad56d

File tree

2 files changed

+28
-11
lines changed

2 files changed

+28
-11
lines changed

docs/changelog.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@
1717

1818
# Changelog
1919

20+
21+
## 0.3.3
22+
23+
[GitHub Milestone 0.3.2](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/9)
24+
25+
- Ability to create storage buckets on startup
26+
- Include logging scope values for LogStash
27+
28+
2029
## 0.3.2
2130

2231
[GitHub Milestone 0.3.2](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/8)

docs/setup/setup.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -131,23 +131,31 @@ Locate the storage section of the configuration in `appsettings.json`:
131131
"InformaticsGateway": {
132132
"dicom": { ... },
133133
"storage": {
134-
"storageServiceCredentials": {
135-
"endpoint": "localhost:9000", # IP & port to MinIO instance
136-
"accessKey": "admin", # Access key or username
137-
"accessToken": "password", # Access token or password
138-
"securedConnection": false, # Indicates if connection should be secured using HTTPS
139-
"region": "local", # Region
140-
"serviceName": "MinIO" # Name of the service
141-
},
142-
"storageService": "Monai.Deploy.Storage.MinIO.MinIoStorageService, Monai.Deploy.Storage.MinIO", # Fully qualified type name of the storage service
143-
"securedConnection": false, # Indicates if a secured connection is required to access MinIO
144-
"storageServiceBucketName": "igbucket" # The name of the bucket where data is uploaded to
134+
"localTemporaryStoragePath": "/payloads", # path to store incoming data before uploading to the storage service
135+
"remoteTemporaryStoragePath": "/incoming", # the path on the "temporaryBucketName" where the data is uploaded to before payload assembly
136+
"bucketName": "monaideploy", # name of the bucket for storing payloads
137+
"temporaryBucketName": "monaideploy", # name of the bucket for temporarily storing incoming data before payload is assembled
138+
"serviceAssemblyName": "Monai.Deploy.Storage.MinIO.MinIoStorageService, Monai.Deploy.Storage.MinIO", # the fully qualified assembly name for the storage service to use
139+
"watermarkPercent": 75, # a percentage value that indicates when the system shall stop receiving or downloading data. Disk space is calculated based on the path defined in "localTemporaryStoragePath"
140+
"reserveSpaceGB": 5, # minimum disk space required and reserved for the Informatics Gateway
141+
"settings": { # settings for the storage library: default to minio
142+
"endpoint": "localhost:9000", # MinIO server IP and port number
143+
"accessKey": "admin", # username/access key
144+
"accessToken": "password", # password/access token
145+
"securedConnection": false, # enable secured connection to minio?
146+
"region": "local", # storatge region
147+
"createBuckets": "monaideploy" # buckets to be created on startup if not already exists
148+
}
145149
},
146150
...
147151
}
148152
}
149153
```
150154

155+
> [!Note]
156+
> Update the `createBuckets` configuration if you would like to have the Informatics Gateway create the storage buckets on startup. Otherwise, leave it blank.
157+
> To create multiple buckets, separate each bucket name with comma.
158+
151159
#### Install the Storage Plug-in
152160

153161
As shown above, the default plug-in configured is __MinIO__ and is ready to use.

0 commit comments

Comments
 (0)