Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typos #48

Merged
merged 1 commit into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/05-workspace_registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Find instructions for funding workspace accounts with any of the persistent pay
[img req access]: ./img/profile_login_other_commons.png
[img workspaces]: ./img/workspace_flavors_080322.png
[BRH login]: https://brh.data-commons.org/login
[BRH Workspace]: https://brhstaging.data-commons.org/workspace
[BRH Workspace]: https://brh.data-commons.org/workspace
[BRH Workspace Acct Mgr]: https://brh-portal.org/
[BRH Platform]: https://brh.data-commons.org/
[Gen3.org]: https://gen3.org/
Expand Down
4 changes: 2 additions & 2 deletions docs/nextflow-create-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ We have one base image that is available for running workflows on CPUs.

## Verify that your Docker and Docker Scout are working as expected

Before you take the time to build your own Dockerfile, its good to be sure your Docker is able to pull the base image of interest and that you are able to scan with Docker Scout. Doing these tests will be quite quick, and will help you identify problems more easily than if you try to troubleshoot problems in a build.
Before you take the time to build your own Dockerfile, it's good to be sure your Docker is able to pull the base image of interest and that you are able to scan with Docker Scout. Doing these tests will be quite quick, and will help you identify problems more easily than if you try to troubleshoot problems in a build. This is also a good opportunity to verify that your selected base image has not accumulated any vulnerabilities since we last scanned it.

### **Test pulling the Docker image**

Expand All @@ -67,7 +67,7 @@ Next, open your terminal. Run `docker pull <image URL>`, where the image URL is

### **Test using Docker Scout to evaluate image vulnerabilities**

At the end of your test pull, Docker offers a suggestion to use Docker Scout to examine your image for vulnerabilities (see red box above). Since you will want to use Docker Scout to evaluate your custom build later, now is a convenient time to test this tool and make sure you are fully set up to run Docker Scout (even though we do not expect the base images to have any security problems).
At the end of your test pull, Docker offers a suggestion to use Docker Scout to examine your image for vulnerabilities (see red box above). Since you will want to use Docker Scout to evaluate your custom build later, now is a convenient time to test this tool and make sure you are fully set up to run Docker Scout. Although we do not expect the base images to have any security problems, it's most efficient to run this quick check before you spend time building on this image, in case it has accumulated a vulnerability since we last scanned it.

*Note: If you don't seem to have access to Docker Scout, check whether you're using the [latest Docker version](#prerequisites).*

Expand Down
2 changes: 1 addition & 1 deletion docs/nextflow-upload-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you do **not** push an image to the ECR before they expire, please ping `@nex

### **A note about security and expiration of approved Docker images**

Because of the ever-updating nature of vulnerability detection, an image that has passed in the past is not guaranteed to always pass. Even if you are resumitting an image that has passed previously, there may be new vulnerabilities that have been reported that mean the image does not pass now. Best practices for most efficient submission are to always [examine an image with Docker Scout](nextflow-create-docker.md/#run-docker-scout) before pushing it.
Because of the ever-updating nature of vulnerability detection, an image that has passed in the past is not guaranteed to always pass. Even if you are resubmitting an image that has passed previously, there may be new vulnerabilities that have been reported that mean the image does not pass now. Best practices for most efficient submission are to always [examine an image with Docker Scout](nextflow-create-docker.md/#run-docker-scout) before pushing it.

Similarly, because new vulnerabilities are always emerging, to protect the security of the Gen3 Workspace, approved containers will only remain available in the approved repo for 30 days. However, users can always request new credentials and resubmit their image for scanning.

Expand Down
Loading