Conversation
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for deploying Cube AI using cloud-init on Ubuntu cloud images. It provides an alternative deployment method to the Buildroot-based HAL approach, targeting development and cloud deployment scenarios where a full Ubuntu environment is preferred over minimal custom images.
Changes:
- Added new cloud-init.md documentation file covering Ubuntu-based deployment with automated provisioning
- Updated index.md to include Cloud-Init section in the developer guide table of contents
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/developer-guide/index.md | Added Cloud-Init entry to the developer guide sections list |
| docs/developer-guide/cloud-init.md | New comprehensive guide covering cloud-init deployment, including prerequisites, setup steps, configuration, TDX support, and post-boot setup |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
| id: cloud-init | ||
| title: Cloud-Init | ||
| sidebar_position: 5 |
There was a problem hiding this comment.
The sidebar_position value of 5 conflicts with multiple other files (cvm-management.md and fine-tuning.md also use sidebar_position: 5). This will cause unexpected ordering in the documentation sidebar. Consider using sidebar_position: 6 or adjusting the positions of other files to ensure each file has a unique position value.
| sidebar_position: 5 | |
| sidebar_position: 6 |
| ### 1. Clone the Cube Repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/ultravioletrs/cube.git | ||
| cd cube/hal/ubuntu | ||
| ``` |
There was a problem hiding this comment.
The documentation references cloning the Cube repository and accessing cube/hal/ubuntu, but this is a documentation repository (cube-docs), not the main Cube repository. Users following these instructions from this repository will not find the referenced directory. Consider clarifying that users need to clone the main Cube repository separately, or provide a full GitHub URL for clarity.
| home: /var/lib/ollama | ||
| shell: /usr/sbin/nologin | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The documentation shows a default password of "password" in plain text. While this is for development/testing purposes, it should include a strong warning that this default password must be changed for any non-local or production use. Consider adding a security note similar to those seen elsewhere in the documentation.
| :::warning Security | |
| The example above uses `plain_text_passwd: password` for local development and testing only. **Always override this value with a strong, unique password (or, preferably, SSH key–based access) before exposing an instance to any network or using it in staging or production.** | |
| ::: |
| ### Local Development | ||
|
|
||
| For local development with the Cube UI, update `docker/.env` with the VM's IP address: | ||
|
|
||
| ```bash | ||
| UV_CUBE_NEXTAUTH_URL=http://<vm-ip-address>:${UI_PORT} | ||
| ``` |
There was a problem hiding this comment.
The documentation references updating docker/.env with the VM's IP address, but this path may not exist in the context where users are following this cloud-init deployment guide. Since this documentation repository doesn't contain a docker/.env file, clarify where this file is located (likely in the main Cube repository) or provide more context about which repository/directory this refers to.
What type of PR is this?
What does this do?
Which issue(s) does this PR fix/relate to?
Have you included tests for your changes?
Did you document any new/modified features?
Notes