README for WorkerApplication #130
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # WorkerApplication Configuration and HK2 Bindings | ||
|
|
||
| This document inventories all configurations used in WorkerApplication. | ||
|
|
||
|
|
||
| ## Configuration overview | ||
|
|
||
| 1. bucketName | ||
| - Type and name: Context: bucket. ENV: PUBLISH_S3_BUCKET | ||
| - What it does: Defines the S3 bucket used for export. | ||
| - Quarkus suggestion: Map to `@ConfigProperty` in `application.properties`. | ||
|
|
||
| 2. cloudId | ||
| - Type and name: Context: cloudId. ENV: CLOUDID | ||
| - What it does: Identifies the AWS worker instance. If not set, AWS worker will not start. | ||
| - Quarkus suggestion: Map to `@ConfigProperty`. | ||
|
|
||
| 3. aws.accessKeyId | ||
|
Member
There was a problem hiding this comment. Drop both accessKeyId and secretKey. We will rely entirely on DefaultAwsRegionProviderChain. This is possible because in CMS 5.3 cloud setup we no longer need separate API keys for multi-worker installations. |
||
| - Type and name: Context: aws.accessKeyId. | ||
| - What id does: AWS access key used for authentication. | ||
| - Quarkus suggestion: Map to `quarkus.amazon.credentials.type` or `@ConfigProperty`. | ||
|
|
||
| 4. aws.secretKey | ||
| - Type and name: Context: aws.secretKey. | ||
| - What it does: AWS secret key is used for authentication. | ||
| - Quarkus suggestion: Map to `quarkus.amazon.credentials.type` or `@ConfigProperty`. | ||
|
|
||
| 5. AWS Region | ||
| - Type and name: ENV (AWS default region configuration) | ||
| - What it does: Determines which AWS region is used. And default fallback is eu-west-1. | ||
| - Quarkus suggestion: Use `quarkus.amazon.region` or `@ConfigProperty`. | ||
|
Member
There was a problem hiding this comment. Ok, will see which is needed depending on how the S3 / SFN clients are injected. We can remove the default if it simplifies the implementation. Important: |
||
|
|
||
| 6. PUBLISH_S3_ACCELERATED | ||
|
Member
There was a problem hiding this comment. Should remain an ENV (same name) |
||
| - Type and name: ENV: PUBLISH_S3_ACCELERATED | ||
| - What it does: Enables S3 transfer acceleration. | ||
| - Quarkus suggestion: Map to `@ConfigProperty`. | ||
|
|
||
| 7. PUBLISH_FS_PATH | ||
|
Member
There was a problem hiding this comment. Should remain an ENV (same name) |
||
| - Type and name: ENV: PUBLISH_FS_PATH | ||
| - What is does: Defines local filesystem export path. If set, export uses local file system instead of S3. | ||
| - Quarkus suggestion: Map to `@ConfigProperty`. | ||
|
|
||
| 8. APTAPPLICATION | ||
|
Member
There was a problem hiding this comment. APTAPPLICATION must remain an ENV because it is used by Arbortext as well. |
||
| - Type and name: ENV: APTAPPLICATION | ||
| - What it does: Defines application path prefix used by PublishJobService. | ||
| - Quarkus suggestion: Map to `@ConfigProperty`. | ||
|
|
||
|
|
||
| ## HK2 Bindings Overview | ||
|
|
||
| 1. WorkerStatusReport | ||
| - Class / Type: WorkerStatusReport | ||
| - Purpose: Used to report worker status inside the application | ||
| - Quarkus suggestion: Replace with `@Singleton` CDI bean. | ||
|
|
||
| 2. region | ||
| - Class / Type: Region. | ||
| - Purpose: Represents the AWS region used by AWS clients. | ||
| - Quarkus suggestion: Inject via `@ConfigProperty` or `@Singleton`. | ||
|
Member
There was a problem hiding this comment. Not sure, depends on how clients are injected. Might be better with @produces |
||
|
|
||
| 3. bucketName | ||
| - Class / Type: String (named binding) | ||
| - Purpose: Holds the configured S3 bucket name. Injected by name in HK2. | ||
| - Quarkus suggestion: Use `@ConfigProperty` with `@Named`. | ||
|
|
||
| 4. exportProviders (Important – Multiple Implementations). | ||
| - Class / Type: Map<String, CmsExportProvider>. | ||
| - Purpose: Contains multiple export provider implementations. | ||
| - "fs" --> CmsExportProviderFsSingle (local file export). | ||
| - "s3" --> CmsExportProviderAwsSingle (S3 export). | ||
| - Quarkus suggestion: Inject as a singleton bean with `@Produces`. | ||
|
Member
There was a problem hiding this comment. Yes, produce the whole Map which means we (hopefully) don't have to modify the code using this Map. |
||
|
|
||
| 5. SfnClient | ||
| - Class / Type: SfnClient. | ||
| - Purpose: AWS Step Functions client | ||
| - Quarkus suggestion: Replace with `@Singleton` or Quarkus AWS SDK client injection. | ||
|
Member
|
||
|
|
||
| 6. ObjectReader / ObjectWriter | ||
| - Class / Type: Jackson | ||
| - Purpose: JSON serialization and deserialization. | ||
| - Quarkus suggestion: Inject via CDI or use `@Produces` beans. | ||
|
|
||
| 7. PublishServicePe | ||
| - Class / Type: PublishServicePe. | ||
| - Purpose: Backend publish service. | ||
| - Quarkus suggestion: Replace with `@Singleton` CDI bean. | ||
|
|
||
| 8. PublishJobService | ||
| - Class / Type: PublishJobService. | ||
| - Purpose: Orchestrates export and publish jobs. | ||
| - Quarkus suggestion: Replace with `@Singleton` CDI bean. | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Current logic:
context parameter overrides environment variable, enables multiple workers.
The context parameter should be refactored to @ConfigProperty. Let's drop the ENV support.