-
Notifications
You must be signed in to change notification settings - Fork 0
Add aiDAPTIVCache applications documents #67
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| --- | ||
| title: aiDAPTIV Operator | ||
| description: Learn how to install the aiDAPTIV Cache Operator for Phison aiDAPTIVCache device support in Kubernetes | ||
| --- | ||
|
|
||
| import { Steps, Aside } from '@astrojs/starlight/components'; | ||
|
|
||
| This guide demonstrates how to install the **aiDAPTIV Cache Operator**, which is required for Kubernetes to recognize and utilize Phison aiDAPTIVCache devices (`phison.com/ai100`). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before installing the operator, ensure you have: | ||
|
|
||
| - Access to OtterScale platform with Application management permissions | ||
| - A Kubernetes cluster with Phison aiDAPTIVCache hardware installed | ||
| - Sufficient cluster resources for the operator deployment | ||
|
|
||
| <Aside type="note"> | ||
| The aiDAPTIV Cache Operator must be installed **before** deploying any workloads that require Phison aiDAPTIVCache devices. Without this operator, Kubernetes will not be able to recognize or allocate aiDAPTIVCache resources. | ||
| </Aside> | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| <Steps> | ||
|
|
||
| 1. **Navigate to Application Store** | ||
|
|
||
| In the OtterScale web interface: | ||
| - Go to **Application** → **Store** | ||
| - This opens the Helm chart repository | ||
|
|
||
| 2. **Add the aiDAPTIV Operator Chart** | ||
|
|
||
| Click **Import** button and provide the following information: | ||
|
|
||
| - **Chart URL**: | ||
| ``` | ||
| https://github.com/otterscale/charts/releases/download/aidaptivcache-operator-0.4.3/aidaptivcache-operator-0.4.3.tgz | ||
| ``` | ||
|
|
||
| Click **Confirm** to import the chart into your store. | ||
|
|
||
| 3. **Install the Operator** | ||
|
|
||
| - Find `aidaptivcache-inference` in the Store list | ||
| - Click the **Install** button | ||
| - In the Install Release dialog: | ||
| - Enter a **Name** for your deployment (e.g., `aidaptivcache-operator`) | ||
| - Enter a **Namespace** (e.g., `aidaptivcache-operator`) | ||
| - Click **View/Edit** button to open the configuration editor | ||
|
|
||
| <Aside type="tip"> | ||
| The operator uses default values that work for most deployments. You can view the configuration by clicking **View/Edit** if you need to customize settings such as resource limits or node selectors. | ||
| </Aside> | ||
|
|
||
| </Steps> | ||
|
|
||
| ## What the Operator Does | ||
|
|
||
| The aiDAPTIV Cache Operator performs the following functions: | ||
|
|
||
| - **Resource Manager**: Manage aiDAPTIVCache devices | ||
| - **Device Discovery**: Automatically detects Phison aiDAPTIVCache devices on cluster nodes | ||
| - **Device Plugin**: Registers aiDAPTIVCache devices as Kubernetes resources, enabling targeted workload scheduling | ||
| - **Exporter**: Exposes metrics and cache information via an NVMe exporter | ||
|
|
||
| <Aside type="caution"> | ||
| **Important**: Do not uninstall the operator while workloads are using aiDAPTIVCache devices. This may cause pod scheduling issues and device allocation failures. | ||
| </Aside> | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Operator Pod Not Starting | ||
|
|
||
| If the operator pod fails to start: | ||
|
|
||
| 1. **Check pod logs via OtterScale UI**: | ||
| - Navigate to **Application** → **Workloads** | ||
| - Find the `aidaptivcache-operator` workload | ||
| - Click on the pod name to view details | ||
| - Click the **Logs** tab to view container logs | ||
|
|
||
| 2. Verify node labels and taints allow the operator to schedule | ||
|
|
||
| 3. Check that the cluster has sufficient resources | ||
|
|
||
| ## Next Steps | ||
|
|
||
| After successfully installing the aiDAPTIV Cache Operator, you can: | ||
|
|
||
| - Deploy fine-tuning jobs that utilize aiDAPTIVCache devices (see [Deploy aiDAPTIV Finetune](./08-aidaptiv-finetune)) | ||
| - Deploy inference services with aiDAPTIVCache acceleration (see [Deploy aiDAPTIV Inference](./09-aidaptiv-inference)) | ||
|
|
||
| <Aside type="tip"> | ||
| When requesting aiDAPTIVCache devices in your workloads, use the resource key `phison.com/ai100` in both `requests` and `limits` sections of your pod specifications. | ||
| </Aside> | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There seems to be a typo in the chart name. The user is instructed to find
aidaptivcache-inferencein the store list, but this document is about installing theaidaptivcache-operator. The imported chart is alsoaidaptivcache-operator. This should likely beaidaptivcache-operator.