Repository navigation
Update pre-require and installation - #33
Conversation
Summary of ChangesHello @terrywu510, 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! This pull request focuses on enhancing the clarity and completeness of the OtterScale documentation, specifically for prerequisites and installation. The changes aim to provide users with more precise instructions for setting up their environment and installing the software, including a more organized and comprehensive firewall configuration guide, ultimately improving the initial user experience. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the prerequisite and installation documentation, restructuring the firewall requirements into tabs for better readability and updating the installation steps. My review includes suggestions to improve the clarity and accuracy of the documentation, such as clarifying potentially misleading statements, correcting an invalid domain in the firewall list, and making the installation instructions more explicit and easier to follow.
| | `registry.k8s.io` | TCP 443 (HTTPS) | | ||
| | `k8s.gcr.io` | TCP 443 (HTTPS) | | ||
| | `ghcr.io` | TCP 443 (HTTPS) | | ||
| | `coredns` | TCP 443 (HTTPS) | |
There was a problem hiding this comment.
The domain coredns is listed as a requirement for firewall whitelisting. coredns is typically a service name within a Kubernetes cluster and not a public, fully qualified domain name (FQDN) that can be resolved over the internet. This is likely an error and could cause confusion. Please verify the correct domain for the CoreDNS container image registry or remove this entry if it's not an external endpoint.
|
|
||
| ### Network Configuration | ||
|
|
||
| The installer will help set up networking - no manual configuration needed. |
There was a problem hiding this comment.
The statement "no manual configuration needed" could be misleading. The subsequent section on "Bridge Configuration" mentions that the user might be prompted to select an existing bridge, which is a form of manual configuration. Consider rephrasing to better reflect the potential for user interaction.
The installer will help set up networking, though some manual input may be required.
| | `tw.archive.ubuntu.com` | TCP 443 (HTTPS)<br/>TCP 80 (HTTP)\* | | ||
| | `archive.ubuntu.com` | TCP 443 (HTTPS)<br/>TCP 80 (HTTP)\* | | ||
| | `ports.ubuntu.com` | TCP 443 (HTTPS)<br/>TCP 80 (HTTP)\* | | ||
| | `security.ubuntu.com` | TCP 443 (HTTPS)<br/>TCP 80 (HTTP)\* | | ||
| | `esm.ubuntu.com` | TCP 443 (HTTPS)<br/>TCP 80 (HTTP)\* | |
There was a problem hiding this comment.
The asterisk (*) in TCP 80 (HTTP)* is not explained anywhere in the document. This could cause confusion for users trying to configure their firewalls. Please either remove the asterisk if it has no specific meaning, or add a footnote explaining it. This applies to all entries in this table.
|
|
||
| | Domains | Port(s) | Description | | ||
| | :------------------------------------- | :---------------| :-------------| | ||
| | `otterscale.github.io` | TCP 443 (HTTPS) | #OtterScale | |
There was a problem hiding this comment.
The Description column in the HELM Charts table uses a hash prefix (e.g., #OtterScale). This is unconventional for a description in a markdown table and can be confusing. For better clarity, I suggest removing the # prefix from all entries in this column.
| `otterscale.github.io` | TCP 443 (HTTPS) | OtterScale |
| Update .env APP_VERSION and PUBLIC_API_URL | ||
|
|
||
| ## OtterScale Web IP | ||
| OTTERSCALE_WEB_IP="192.168.197.220" | ||
| ```bash | ||
| APP_VERSION=0.6.0-beta.3 | ||
| PUBLIC_API_URL=http://xx.xx.xx.xx:8299 | ||
| ``` |
There was a problem hiding this comment.
The instructions for updating the .env file are a bit fragmented. Also, the code block containing the environment variables is incorrectly highlighted as bash, as these are not executable shell commands. To improve clarity, I suggest combining the instructions and using a more appropriate format for the code block, like env or no language specifier.
Update the `.env` file with your specific values. For example:
```env
APP_VERSION=0.6.0-beta.3
PUBLIC_API_URL=http://xx.xx.xx.xx:8299
```
|
|
||
| 1. Access the OtterScale UI. | ||
| 2. Execute the `install.sh` script. | ||
| 2. Copy the CLI from OtterScale UI and execute the command with sudo privilege. |
There was a problem hiding this comment.
The instruction "Copy the CLI from OtterScale UI and execute the command with sudo privilege" is vague. It would be very helpful for users to see an example of what the command might look like.
2. Copy the installation command from the OtterScale UI and execute it with `sudo` privilege. The command will look similar to this: `curl -sSL http://<your-otterscale-ip>:8299/install.sh | sudo bash`
…ee/open-source banner.
No description provided.