Skip to content

docs: update installation docs to support different cloud providers #1247

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Jul 23, 2025
Merged

docs: update installation docs to support different cloud providers #1247

merged 11 commits into from
Jul 23, 2025
+701 −435

Conversation

Jont828
Copy link
Contributor

@Jont828 Jont828 commented Jul 9, 2025 •
edited
Loading

Reason for Change:

Update docs to have generalized installation flow with steps on using BYO GPU nodes and setting up GPU provisioner.

Requirements

  • added unit tests and e2e tests (if applicable).

Issue Fixed:

Fixes #1211
Notes for Reviewers:

@kaito-pr-agent Kaito PR Agent
Copy link

kaito-pr-agent bot commented Jul 9, 2025

Title

Update installation docs for multi-cloud support

Description

  • Updated installation documentation to support multiple cloud providers.

  • Added tabbed sections for Azure and AWS specific instructions.

  • Moved tips to green tip views for better readability.

  • Refactored Makefile to use generic cluster name variables.

Changes walkthrough 📝

Relevant files
Configuration changes
Makefile
Refactor Makefile for cloud agnostic variables                     

Makefile

  • Introduced generic CLUSTER_NAME and RESOURCE_GROUP variables.
  • Updated AZURE_CLUSTER_NAME and AZURE_RESOURCE_GROUP to use new
    variables.
    		• +4/-2     
    Documentation
    installation.md
    Remove old Azure installation doc                                               

    website/docs/installation.md

    • Removed old Azure-specific installation document.
    		 +0/-145 
    installation.mdx
    Add multi-cloud installation guide                                             

    website/docs/installation.mdx

  • Added tabbed sections for Azure and AWS installation instructions.
  • Included prerequisites for each cloud provider.
  • Updated installation steps to use Makefile targets.
  • Added tips using green tip views.
    		• +223/-0 
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    		•

    @kaito-pr-agent Kaito PR Agent
    Copy link

    kaito-pr-agent bot commented Jul 9, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Default Tabs

    Both tabs in the component are marked as default. Only one tab should be set as default.

     
    <TabItem value="azure" label="Azure" default>

- [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) to provision Azure resources

</TabItem>
<TabItem value="aws" label="AWS" default>
    Missing Prerequisite

    The AWS tab is missing a prerequisite for eksctl.

     
    - [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) to provision AWS resources
- [Eksctl](https://eksctl.io/installation/) (>= v0.191.0) to create and manage clusters on EKS
-
    Hardcoded Values

    There are hardcoded values in the installation instructions (e.g., kaito-rg, kaito). Consider using environment variables or configuration files for better flexibility.

     
    export RESOURCE_GROUP="kaito-rg"
export CLUSTER_NAME="kaito"
export LOCATION="eastus"

    @kaito-pr-agent Kaito PR Agent
    Copy link

    kaito-pr-agent bot commented Jul 9, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix JSON file typo

    Correct the typo in the JSON file description.

    website/docs/installation.mdx [15]

    -- [jq](https://jqlang.github.io/jq/download) to process JSON file
+- [jq](https://jqlang.github.io/jq/download) to process JSON files
    Suggestion importance[1-10]: 6

    __

    Why: Correcting the typo improves the clarity of the documentation.

    		Low
    Remove default attribute

    Remove the default attribute from the AWS tab to prevent both tabs being marked as
    default.

    website/docs/installation.mdx [31]

    -<TabItem value="aws" label="AWS" default>
+<TabItem value="aws" label="AWS">
    Suggestion importance[1-10]: 6

    __

    Why: Removing the default attribute prevents both tabs from being incorrectly marked as default.

    		Low
    Clarify make command

    Ensure the make command is clear and consistent with other provider instructions.

    website/docs/installation.mdx [110-112]

     ```bash
-make az-patch-install-helm
+make install-helm-azure
    <details><summary>Suggestion importance[1-10]: 6</summary>

__

Why: Ensuring consistency in the `make` command helps users follow the instructions more easily.


</details></details></td><td align=center>Low

</td></tr></tr></tbody></table>

    sozercan
    sozercan requested changes Jul 9, 2025
    View reviewed changes
    chewong
    chewong reviewed Jul 9, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    sozercan
    sozercan reviewed Jul 11, 2025
    View reviewed changes
    chewong
    chewong reviewed Jul 11, 2025
    View reviewed changes
    @Jont828
    Copy link
    Contributor Author

    Jont828 commented Jul 15, 2025

    @sozercan @chewong Updated the PR except for the last comment on the instanceType field. Any word on that or if we need to change it here?

    @Jont828 Jont828 changed the title [WIP] Update installation docs to support different cloud providers Update installation docs to support different cloud providers Jul 15, 2025
    sozercan
    sozercan approved these changes Jul 15, 2025
    View reviewed changes
    Copy link
    Collaborator

    @sozercan sozercan left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM

    @sozercan sozercan requested a review from chewong July 15, 2025 22:34
    @chewong chewong requested review from zhuangqh and sozercan July 23, 2025 02:51
    Fei-Guo
    Fei-Guo reviewed Jul 23, 2025
    View reviewed changes
    zhuangqh
    zhuangqh reviewed Jul 23, 2025
    View reviewed changes
    @sozercan
    Copy link
    Collaborator

    LGTM after addressing https://github.com/kaito-project/kaito/pull/1247/files#r2224227592

    @chewong chewong merged commit ff93426 into kaito-project:main Jul 23, 2025
    14 of 16 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @Fei-Guo Fei-Guo Fei-Guo left review comments

    @chewong chewong chewong approved these changes

    @zhuangqh zhuangqh zhuangqh approved these changes

    @helayoty helayoty Awaiting requested review from helayoty

    @ishaansehgal99 ishaansehgal99 Awaiting requested review from ishaansehgal99

    @sozercan sozercan Awaiting requested review from sozercan

    Assignees

    @Jont828 Jont828

    Labels
    Review effort 3/5
    Projects
    KAITO Roadmap
    Status: Done
    Milestone
    0.7.0
    Development

    Successfully merging this pull request may close these issues.

    docs: generic kaito installation flow
    5 participants
    @Jont828 @sozercan @chewong @zhuangqh @Fei-Guo