Create Freezer_long_term_storage #459
Conversation
New page for Freezer - much is placeholder for now. Sorry in advance for the formatting/syntax issues! Signed-off-by: Claire Rye <claire@ryefamily.co.uk>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @clairerye, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces a new documentation page for NeSI's Freezer long-term storage service. The page provides an overview of the service, instructions on how to get started, how to install and configure the s3cmd tool for interacting with Freezer, and examples of common operations such as listing contents, disk usage, putting objects, and restoring from tape. It also includes a glossary and a section on known issues and pain points.
Highlights
- New Documentation Page: A new page
docs/Storage/Freezer_long_term_storagehas been created to document the Freezer service. - Getting Started Guide: The page includes a guide on how to get started with the Freezer service, including obtaining an allocation and credentials.
- s3cmd Tool Configuration: Detailed instructions are provided for installing and configuring the
s3cmdtool for interacting with the Freezer service. - Usage Examples: The documentation includes examples of common operations such as listing buckets, uploading files, and restoring data from tape.
- Known Issues: A section dedicated to known issues and pain points, such as the confusing region field and issues with the
s3cmd ducommand.
Changelog
- docs/Storage/Freezer_long_term_storage
- Created a new documentation page for the Freezer long-term storage service.
- Added an overview of the Freezer service and its features.
- Provided instructions on how to get started with the service.
- Included a guide on installing and configuring the s3cmd tool.
- Added examples of common operations such as listing buckets, uploading files, and restoring data.
- Documented known issues and pain points.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
To tape, the data flows,
Freezer's chill, where knowledge goes,
Long-term, safe, and deep.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new page for NeSI's Freezer service, providing information on long-term data storage using tape. The document covers getting started, installation, configuration, and usage examples with the s3cmd tool. The page also lists known issues and pain points. Overall, the document provides a good starting point for users of the Freezer service.
Summary of Findings
- Insecure Credentials: The configuration example includes hardcoded access key and secret key, which is a security risk. This should be changed to use environment variables or a more secure method for storing credentials.
- Inconsistent Formatting: There are inconsistencies in the formatting of code snippets and headings. Standardizing the formatting will improve readability.
- Outdated Information: The document mentions a specific IP address and port (210.7.37.122:7070) for the S3 endpoint. This information may become outdated and should be made more generic or configurable.
Merge Readiness
The pull request introduces a new documentation page for the Freezer service. While the content is informative, there are some critical issues related to security (hardcoded credentials) that need to be addressed before merging. Additionally, inconsistencies in formatting should be resolved to improve readability. I am unable to approve this pull request, and recommend that it not be merged until the identified issues are addressed and others have reviewed and approved this code.
| Access Key: tber027 | ||
| Secret Key: $dR!2sn67Hh4 |
There was a problem hiding this comment.
Storing access keys and secret keys directly in the configuration is a security risk. Suggest using environment variables or a more secure method for credential management.
Access Key: $NESI_ACCESS_KEY
Secret Key: $NESI_SECRET_KEY
| Secret Key: $dR!2sn67Hh4 | ||
| Default Region: us-east-1 | ||
| Use "s3.amazonaws.com" for S3 Endpoint and not modify it to the target Amazon S3. | ||
| S3 Endpoint: 210.7.37.122:7070 |
There was a problem hiding this comment.
Hardcoding the S3 endpoint IP address and port can lead to issues if the endpoint changes. Consider using a DNS name or making this configurable.
S3 Endpoint: freezer.nesi.org.nz
|
|
||
| ## Restore from tape | ||
|
|
||
| Restore file from Glacier storage <StorageClass>GLACIER</StorageClass> |
There was a problem hiding this comment.
The <StorageClass>GLACIER</StorageClass> tag looks like an artifact from another document format (e.g., XML). It's not valid Markdown and doesn't render correctly. Please remove it.
|
Test deployment available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/clairerye-patch-1 |
New page for Freezer - much is placeholder for now. Sorry in advance for the formatting/syntax issues!