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

remove @ from nextflow-support ping #50

Merged
merged 1 commit into from
May 29, 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
6 changes: 3 additions & 3 deletions docs/nextflow-create-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can access the URLs to pull these images using Docker here:

![Screenshot of URLs for secure base images](img/base-image-URLs.png)

Please note: if, when you click on [this link to the base image text file](https://github.com/uc-cdis/containers/blob/master/nextflow-base-images/allowed_base_images.txt), **you see an asterisk next to one of these URLs, it means that the image is temporarily unavailable** because it is being updated. Please wait until the asterisk is removed to build an image on that base image. If you would like an estimated timeframe for when the base image will be available, please ping us on Slack (`@nextflow-support`).
Please note: if, when you click on [this link to the base image text file](https://github.com/uc-cdis/containers/blob/master/nextflow-base-images/allowed_base_images.txt), **you see an asterisk next to one of these URLs, it means that the image is temporarily unavailable** because it is being updated. Please wait until the asterisk is removed to build an image on that base image. If you would like an estimated timeframe for when the base image will be available, please ping us on Slack (`nextflow-support`).

### **How to choose your base image**

Expand Down Expand Up @@ -61,7 +61,7 @@ This will help make sure you can pull the base image of interest by running the

First, open your Docker Desktop application (just to be sure Docker is running).

Next, open your terminal. Run `docker pull <image URL>`, where the image URL is the full line as displayed in the [file of security-validated base images](https://github.com/uc-cdis/containers/blob/master/nextflow-base-images/allowed_base_images.txt). If it's working, you will see language that it is pulling (see below). When it's complete (and successfully pulled), there will be a line that says `Status: Downloaded <image>` (see yellow highlight below). If you see this, you know that all the steps necessary to pull your image work. If you don't see this, reach out to us on Slack (`@nextflow-support`)
Next, open your terminal. Run `docker pull <image URL>`, where the image URL is the full line as displayed in the [file of security-validated base images](https://github.com/uc-cdis/containers/blob/master/nextflow-base-images/allowed_base_images.txt). If it's working, you will see language that it is pulling (see below). When it's complete (and successfully pulled), there will be a line that says `Status: Downloaded <image>` (see yellow highlight below). If you see this, you know that all the steps necessary to pull your image work. If you don't see this, reach out to us on Slack (`nextflow-support`, do not use `@`)

![Test docker pull command in terminal](img/test-docker-pull.png)

Expand All @@ -87,7 +87,7 @@ You can run the next suggested command (shown in red box above, `docker scout cv

**Images should be able to pass Gen3 security scanning if there are no Critical vulnerabilities.**

*But please note: The unfortunate nature of vulnerabilities is that there are always new ones appearing, despite our active monitoring. If you do see that one of our base images has a Critical vulnerability reported by Docker Scout, please alert us on Slack (`@nextflow-support`)*
*But please note: The unfortunate nature of vulnerabilities is that there are always new ones appearing, despite our active monitoring. If you do see that one of our base images has a Critical vulnerability reported by Docker Scout, please alert us on Slack (`nextflow-support`)*

*Want to know more about Docker Scout? [Check out the documentation](https://docs.docker.com/scout/quickstart/).*

Expand Down
2 changes: 1 addition & 1 deletion docs/nextflow-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To run workflows in Gen3, you will need the following:

The BRH exposes a [computational workspace](https://brh.data-commons.org/workspace) that researchers can use to run simple Jupyter notebooks and submit workflows. To submit workflow jobs, you need access to the BRH workspace.

Follow [these instructions](https://uc-cdis.github.io/BRH-documentation/05-workspace_registration/#requesting-temporary-trial-access-to-brh-workspace) to request trial access to the BRH workspace. After you have submitted your request, please ping `@nextflow-support` in Slack to alert us to look for your request and approve it. We will notify you by Slack when you are approved.
Follow [these instructions](https://uc-cdis.github.io/BRH-documentation/05-workspace_registration/#requesting-temporary-trial-access-to-brh-workspace) to request trial access to the BRH workspace. After you have submitted your request, please ping `nextflow-support` in Slack *(do not use @ or it will not work)*to alert us to look for your request and approve it. We will notify you by Slack when you are approved.

#### 2) Establish a workspace account with a persistent pay model in BRH

Expand Down
4 changes: 2 additions & 2 deletions docs/nextflow-request-creds.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Since the credentials will ONLY last 1 hour after creation, you may prefer we se
* Please generate and send my credentials in the afternoon
* Please generate and send my credentials ASAP

To ensure prompt attention, I will also ping `@nextflow-support` on the Slack channel after I have sent my email.
To ensure prompt attention, I will also ping `nextflow-support` *(please do not use @ for this)* on the Slack channel after I have sent my email.


Thanks!
Expand All @@ -32,6 +32,6 @@ Thanks!

We will send you the credentials through direct message on Slack, in a link to keep them private.

Please note: If you receive credentials but you are not able to successfully upload an image before they expire, please ping `@nextflow-support` on Slack to let us know we do not need to monitor your submitted image.
Please note: If you receive credentials but you are not able to successfully upload an image before they expire, please ping `nextflow-support` on Slack to let us know we do not need to monitor your submitted image.

[*Continue to Upload Docker Image*](./nextflow-upload-docker.md)
6 changes: 3 additions & 3 deletions docs/nextflow-upload-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ This guide is for users who have received temporary credentials granting access

Your temporary AWS credentials only lasts for 1 hour from when they were created; User Services should have provided an expiration time when sharing the credentials with you. You must start the push to ECR before they expire, or you will need to request new credentials from User Services.

If you do **not** push an image to the ECR before they expire, please ping `@nextflow-support` in Slack so we know not to monitor for an image to progress through scanning.
If you do **not** push an image to the ECR before they expire, please ping `nextflow-support` in Slack so we know not to monitor for an image to progress through scanning.

### **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 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.

Finally, although we make every effort to regularly scan and monitor our base images to ensure that they are free of all critical vulnerabilities, you may have the misfortune to be the first to find a vulnerability in our base image. If you believe you have identified a critical vulnerability in one of our base images, please ping us on Slack at `@nextflow-support`.
Finally, although we make every effort to regularly scan and monitor our base images to ensure that they are free of all critical vulnerabilities, you may have the misfortune to be the first to find a vulnerability in our base image. If you believe you have identified a critical vulnerability in one of our base images, please ping us on Slack at `nextflow-support`.

## **Set AWS environment variables:**

Expand Down Expand Up @@ -92,6 +92,6 @@ Please note that you will need to replace all `placeholder` values in the `nextf

## **Support**

If you encounter any issues or require assistance, please reach out to the User Services team on Slack at `@nextflow-support`, or by email at [[email protected]](mailto:[email protected]). (Slack will result in the quickest reply.)
If you encounter any issues or require assistance, please reach out to the User Services team on Slack at `nextflow-support` (no `@`), or by email at [[email protected]](mailto:[email protected]). (Slack will result in the quickest reply.)

[*Continue to Tutorial Workflows*](./nextflow-tutorial-workflows.md)
Loading