Skip to content
This repository has been archived by the owner on Nov 28, 2022. It is now read-only.

Add the docker portions of pca-report-library #10

Open
wants to merge 79 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
89145e2
Add users to CODEOWNERS file
ameliav Oct 21, 2021
8bddd3b
Remove unneeded ports from docker-compose.yml
ameliav Oct 21, 2021
c0c141d
Merge pca-report-library Dockerfile with this one
ameliav Oct 22, 2021
e52afdb
Update image name in build.yml
ameliav Oct 22, 2021
5146fa9
Update Dockerfile to working state
ameliav Oct 22, 2021
f496a40
Remove platforms from build.yml
ameliav Oct 22, 2021
fc68801
Add docker commands to README.md
ameliav Oct 22, 2021
49c27b1
Remove ports section from README.md
ameliav Oct 25, 2021
8cc7e86
Update Environment variables section in README.md
ameliav Oct 25, 2021
2f60a6e
Add volume path to Dockerfile
ameliav Oct 25, 2021
7eb548c
Remove unneeded sections from README.md
ameliav Oct 25, 2021
35aade2
Update container name in docker-compose.yml
ameliav Oct 27, 2021
0ce564c
Update wait_for_ready and output tests
ameliav Oct 27, 2021
1527721
Fix back container error code in container_test.py
ameliav Oct 29, 2021
8eb36c5
Update version label key in container_test.py
ameliav Oct 29, 2021
f6a68ff
Update MAIN_SERVICE_NAME in conftest.py
ameliav Oct 29, 2021
c62293b
Add copying over version.txt in Dockerfile
ameliav Oct 29, 2021
825d6e1
Update service command in docker-compose.yml
ameliav Oct 29, 2021
d723194
Update the docker compose section of README.md
ameliav Oct 29, 2021
b650f78
Re-add platforms to build.yml
ameliav Nov 5, 2021
d45b1c1
Add braces to PCA_REPORT_TOOLS_SRC in Dockerfile
ameliav Nov 5, 2021
2030740
Add braces to CISA_HOME in Dockerfile
ameliav Nov 5, 2021
b2ce069
Capitalize the word Docker in README
ameliav Nov 5, 2021
c8f5a55
Simplify pca-report-generator summary in README
ameliav Nov 5, 2021
4764d7d
Update pca-report-generator-bash summary in README
ameliav Nov 5, 2021
0df5d73
Merge branch 'PCADEV-197-customize' of github.com:cisagov/pca-report-…
ameliav Nov 5, 2021
f85cb89
Add version tag to image in docker-compose
ameliav Nov 5, 2021
b6631f2
Merge branch 'PCADEV-197-customize' of github.com:cisagov/pca-report-…
ameliav Nov 5, 2021
fc03e8e
Add version tag to image in docker-compose
ameliav Nov 5, 2021
1275338
Merge branch 'PCADEV-197-customize' of github.com:cisagov/pca-report-…
ameliav Nov 5, 2021
dad82c5
Uncomment buildx statement in README
ameliav Nov 5, 2021
307f24c
Update numbering item in README
ameliav Nov 5, 2021
8b4a5ab
Add image version tag to README
ameliav Nov 5, 2021
8d9ac4a
Merge branch 'PCADEV-197-customize' of github.com:cisagov/pca-report-…
ameliav Nov 5, 2021
598acee
Re-add and update sections into the README
ameliav Nov 5, 2021
af48f3c
Uncomment optional environment variable in README
ameliav Nov 5, 2021
ea18e21
Update docker environment variables in README
ameliav Nov 5, 2021
a8f6a04
Re-add ports section in README
ameliav Nov 5, 2021
933aa56
Add image version tag to README
ameliav Nov 5, 2021
f9ed352
Uncomment end of image tags section in README
ameliav Nov 5, 2021
079d2e9
Uncomment top of image tags section in README
ameliav Nov 5, 2021
7cbc7c7
Update image tag release numbers in README
ameliav Nov 5, 2021
91c7b63
Remove docker debug command in README
ameliav Nov 5, 2021
74e995f
Update intro docker project summary in README
ameliav Nov 5, 2021
2b0eba1
Remove secrets from docker-compose
ameliav Nov 8, 2021
4ef3793
Comment out secrets section in README
ameliav Nov 8, 2021
a9238ed
Merge branch 'PCADEV-197-customize' of github.com:cisagov/pca-report-…
ameliav Nov 8, 2021
3095f9c
Remove unneeded volume creation in Dockerfile
ameliav Nov 8, 2021
f8c135f
Comment out volumes section in README
ameliav Nov 8, 2021
c15795b
Remove using secrets with your container in README
ameliav Nov 8, 2021
1be4e84
Comment out secrets section in README
ameliav Nov 8, 2021
9d72a51
Remove unused secrets quote from container_test.py
ameliav Nov 8, 2021
cf1db91
Remove git_commit labels from Dockerfile
ameliav Nov 8, 2021
b7a940d
Remove version label in Dockerfile
ameliav Nov 8, 2021
2f9cd7a
Remove GIT ARGs from Dockerfile
ameliav Nov 8, 2021
c718294
Update version key in container_test.py
ameliav Nov 9, 2021
7286a3c
Remove GIT ARGS from Dockerfile
ameliav Nov 10, 2021
4d038c2
Alphabetize env variables in README
ameliav Nov 10, 2021
cfb0e95
Update version to unspecified in Dockerfile
ameliav Nov 10, 2021
642ef11
Remove versions on the images in docker-compose
ameliav Nov 10, 2021
b4f38da
Remove all instances of ECHO_MESSAGE env variable
ameliav Nov 12, 2021
c56cbe2
Remove unused variables from container_test.py
ameliav Nov 15, 2021
ebc3182
Consolidate and update RUN commands in Dockerfile
ameliav Nov 15, 2021
a9e9a3e
Update var to PCA_REPORT_LIBRARY_SRC in Dockerfile
ameliav Nov 15, 2021
eb3bd0c
Add TODO about updating to Alpine in Dockerfile
ameliav Nov 15, 2021
02a0524
Update TODO with python:3.9.6 image in Dockerfile
ameliav Nov 16, 2021
64810e1
Update TODO wording in Dockerfile
ameliav Nov 16, 2021
19beb67
Add entrypoint pca-report-generator to Dockerfile
ameliav Nov 16, 2021
120e86b
Update version command in docker-compose
ameliav Nov 16, 2021
c494107
Merge branch 'PCADEV-197-customize' of github.com:cisagov/pca-report-…
ameliav Nov 16, 2021
2408f6a
Update docker commands per entrypoint in README
ameliav Nov 16, 2021
2cd9701
Add TODO about updating entrypoint in Dockerfile
ameliav Nov 18, 2021
eed0469
Imrpove explanatory text in the README
ameliav Nov 18, 2021
081047b
Improve and correct docker run examples in README
ameliav Nov 18, 2021
4be5029
Improve pca-report-compiler summary text in README
ameliav Nov 18, 2021
2f7a076
Update docker run example in README
ameliav Nov 18, 2021
8d3e8fb
Update command to start up bash shell in README
ameliav Nov 18, 2021
4df844d
Correct repo name in README
ameliav Nov 18, 2021
a9c92b2
Correct repo name in clone command in README
ameliav Nov 18, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docker commands per entrypoint in README
  • Loading branch information
ameliav committed Nov 16, 2021
commit 2408f6a8d93ae0b7421e2b328f817877fa92cbb4
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -19,29 +19,31 @@ The following Docker commands are available.

An alias can also be set beforehand to remove redundancy.

Parameters can be added at the end. Each defaulting command prints out a help message.

`pca-report-generator` - Creates a PCA report as a PDF

```console
docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-generator
docker run -v $(pwd):/home/cisa cisagov/pca-report-generator:0.0.1
```

`pca-report-templates` - Exports the Report Mustache template and Manual data
file template

```console
docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-templates
docker run -v $(pwd):/home/cisa --entrypoint pca-report-templates cisagov/pca-report-library-docker:0.0.1
```

`pca-report-compiler` - Compiles a PCA LaTeX report file, still in development.

```console
docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-compiler
docker run -v $(pwd):/home/cisa --entrypoint pca-report-templates cisagov/pca-report-library-docker:0.0.1
```

`pca-report-generator-bash` - Starts up a `bash` shell in the container

```console
docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-generator-bash
docker run -v $(pwd):/home/cisa --entrypoint pca-report-generator-bash cisagov/pca-report-generator
```

### Running with Docker Compose ###