DATAGO-67636: Update README.md to include CLI commands plus some general cleanup #157
Conversation
|
|
||
| * Docker |
There was a problem hiding this comment.
@AndreaKelso Here is the rewording for the prerequisites section.
| @@ -180,10 +180,74 @@ curl -X 'GET' \ | |||
| --output ih9z9lwwv5r.zip | |||
| ``` | |||
|
|
|||
| # Manually uploading scans to Event Portal | |||
| ## Running a Discovery Scan and File Export Using the CLI | |||
|
|
|||
There was a problem hiding this comment.
@AndreaKelso Added additional context for the CLI to make it clear the CLI can be accessed from the docker container or the jar file.
| `run -d -v /path/to/file/AcmeRetailStandalone.yml:/config/ema.yml -v /path/to/scandir:/tmp --env CMD_LINE_ARGS=${CMD_LINE_ARGS} --env BROKER_PASSWORD=${BROKER_PASSWORD} --name event-management-agent event-management-agent:latest` | ||
|
|
||
| ## Running a Discovery File Upload Using the CLI | ||
|
|
There was a problem hiding this comment.
@AndreaKelso I was missing the word "upload" in the first sentence. Hopefully it's clear now.
| ``` | ||
| CMD_LINE_ARGS="scan mysolacebroker /path/to/scan.zip --springdoc.api-docs.enabled=false --spring.main.web-application-type=none" | ||
| docker run -d -v /path/to/file/AcmeRetailStandalone.yml:/config/ema.yml -v /path/to/scandir:/tmp --env CMD_LINE_ARGS=${CMD_LINE_ARGS} --env BROKER_PASSWORD=${BROKER_PASSWORD} --name event-management-agent event-management-agent:latest | ||
| ``` |
There was a problem hiding this comment.
I noticed that there is copy to clipboard icon in git when you look at the file, and that copy will copy everything in the block. Therefore, I think it is better if we introduce 1 command per block to prevent any headache of copy pasting more than intended.
There was a problem hiding this comment.
@gregmeldrum can you please use "```" instead? The new refactoring makes the code block read weird and doesn't have the copy to clipboard option anymore.
|
SonarQube Quality Gate
|
What is the purpose of this change?
Update the README.md to reflect the new CLI commands.
How was this change implemented?
Added a new section to the README with an explanation of how to use it.
How was this change tested?
Reviewed by @AndreaKelso
Is there anything the reviewers should focus on/be aware of?
No