nerc-project / nerc-docs

User-facing documentation for the New England Research Cloud

NERC Documentation

User-facing documentation for the New England Research Cloud This repository contains NERC documentation written in Markdown which is converted to html/css/js with the mkdocs static site generator. The theme is mkdocs-material with NERC custom theme and template. The documentation pages can be found in top-level folder docs.

Contributing

We would welcome your contributions, in order to get started check out the Contributing Guide.

nerc-docs's Issues

Update NERC Documentation page to include instructions for non-partners on how to get access

Motivation

As a user from an institution, I would like to know how to arrange for my institution to enable my use of the NERC.

As an institution, I would like to know how to arrange for participation in using the NERC for my constituents.

Completion Criteria

Documentation live on the NERC doc site that lets non-partners know how to get access.

Description

Add details to the NERC Doc page for institutions who are not partners and how they may get access to NERC OpenShift/Stack.

• Draft documentation
  • draft MOU's
  • link to charges
  • any variation for non-member institutions (eg. egress charges?)
  • process to get added to CILogon - nerc-project/regapp#38
• Have others review
• merge

Completion dates

Desired - 2023-12-22
Required - TBD

tagged @waygil and @[email protected] to add to this.

Option to share network needn't be documented

Perhaps this option needn't be mentioned in the user docs if only administrators can see it? (Just a suggestion; if this doc is for admins too, please disregard!)

nerc-docs/docs/openstack/setting-up-a-network/set-up-a-private-network.md

Lines 21 to 22 in a12837e

	Shared: Share the network with other projects. Non admin users are not allowed
	to set shared option and not even visible to them.

Add tutorial on using OpenStack Swift for Datalad

Hello,

I am using NERC OpenStack Swift as a git-annex special remote for a Datalad repository. I would like to contribute some documentation on how to do this to the NERC user guides.

Background info: Datalad is a git-based data management tool which wraps git-annex, a system for adding large files to Git and using distributed storage for those files. Datalad is very popular among the neuroimaging research community.

I am successfully using NERC Swift as a git-annex special remote for my Datalad repository here: https://github.com/jennydaman/bigbrain-arterial-registration-datalad

Here's what I did:

First, I created EC2 access key ID and secret from https://stack.nerc.mghpcc.org/dashboard/project/api_access/

export AWS_ACCESS_KEY_ID=xxxxxxxx
export AWS_SECRET_ACCESS_KEY=xxxxxxxx
git annex initremote nerc-swift type=S3 encryption=none bucket=bigbrain-arterial-registration-datalad autoenable=true host=stack.nerc.mghpcc.org protocol=https port=13808 requeststyle=path public=yes
git annex enableremote nerc-swift publicurl="https://stack.nerc.mghpcc.org:13808/swift/v1/AUTH_2dd3b02b267242d9b28f94a512ea9ede/bigbrain-arterial-registration-datalad"
datalad create-sibling-github bigbrain-arterial-registration-datalad-3_fsl_registration --access-protocol ssh --publish-depends nerc-swift

error in rocky image user

Hi all,

The user name is stated to be centos. This is incorrect it is rocky

nerc-docs/docs/openstack/create-and-connect-to-the-VM
/ssh-to-cloud-VM.md

Adding pricing for new Flavors based on `gpu-su-a100sxm`

We will be adding 2 new flavors based on Lenovo A100 GPU nodes. Pricing is confirmed.

• Need spec for the new hardware for nerc-docs.
• Need to add these to our main Invoicing Requirement doc for our internal users and also nerc-docs for general users.
• update calculator
• Update Invoice Requirements

Create an OPE user guide to author new books

Working on the repos re-org of OPE project under https://github.com/OPEFFORT. Current repos are still private. Will create a user guide for using OPE CLI tool to seed new books and then make repos public to all.

add docs about windows licensing

How to "bring your own license" to cloudbase image.

Update NERC documentation for Pricing based on updated OpenShift Calculation

Motivation

An update to OpenShift invoice calculation requires an update to documentation.

Completion Criteria

The NERC doc page includes information update from the Invoice Requirements doc.

Description

• Update document
• Create a PR
• Link PR
• merge PR

Completion dates

Desired - 2023-12-22
Required - 2024-01-02

Update repo name

The repo name displayed on the nerc-docs home page is out-of-date:

nerc-docs/mkdocs.yml

Line 7 in 65f9c0f

repo_name: GitLab/NERC/docs

need to document the process for expanding existing filesystems on expanded volumes

When a user expands a volume that has an existing filesystem, that filesystem will need to be expanded from within a VM. Depending on the OS image being used on a given instance, this may happen automatically via various cloud utils or might need to be done manually by the user. In the case of manual steps this would be using resize2fs for ext-based filesystems, xfs_growfs for xfs, etc.