Skip to content

Commit 9cbe558

Browse files
docs: Fix KAITO acronym alignment (#1501)
**Reason for Change**: <!-- What does this PR improve or fix in KAITO? Why is it needed? --> Ensures consistency when using `KAITO` acronym across documentation and comments. - Updated proposals **Requirements** - [ ] added unit tests and e2e tests (if applicable). **Issue Fixed**: <!-- If this PR fixes GitHub issue 4321, add "Fixes #4321" to the next line. --> Fixes #1397 **Notes for Reviewers**:
1 parent c174bdb commit 9cbe558

20 files changed

Lines changed: 48 additions & 48 deletions

File tree

Makefile

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -175,15 +175,15 @@ $(RAGENGINE_E2E_TEST): ## Build the RAG Engine e2e test binary without running i
175175
(cd test/rage2e && go test -c . -o $(RAGENGINE_E2E_TEST))
176176

177177
.PHONY: kaito-workspace-e2e-test
178-
kaito-workspace-e2e-test: $(E2E_TEST) $(GINKGO) ## Run e2e tests for Kaito Workspace.
178+
kaito-workspace-e2e-test: $(E2E_TEST) $(GINKGO) ## Run e2e tests for KAITO Workspace.
179179
AI_MODELS_REGISTRY_SECRET=$(AI_MODELS_REGISTRY_SECRET) \
180180
AI_MODELS_REGISTRY=$(AI_MODELS_REGISTRY) GPU_PROVISIONER_NAMESPACE=$(GPU_PROVISIONER_NAMESPACE) GPU_PROVISIONER_NAME=$(GPU_PROVISIONER_NAME) \
181181
KARPENTER_NAMESPACE=$(KARPENTER_NAMESPACE) KAITO_NAMESPACE=$(KAITO_NAMESPACE) TEST_SUITE=$(TEST_SUITE) \
182182
SUPPORTED_MODELS_YAML_PATH=$(SUPPORTED_MODELS_YAML_PATH) \
183183
$(GINKGO) -v -trace $(GINKGO_ARGS) $(E2E_TEST)
184184

185185
.PHONY: kaito-ragengine-e2e-test
186-
kaito-ragengine-e2e-test: $(RAGENGINE_E2E_TEST) $(GINKGO) ## Run e2e tests for Kaito RAG Engine.
186+
kaito-ragengine-e2e-test: $(RAGENGINE_E2E_TEST) $(GINKGO) ## Run e2e tests for KAITO RAG Engine.
187187
AI_MODELS_REGISTRY_SECRET=$(AI_MODELS_REGISTRY_SECRET) \
188188
AI_MODELS_REGISTRY=$(AI_MODELS_REGISTRY) GPU_PROVISIONER_NAMESPACE=$(GPU_PROVISIONER_NAMESPACE) GPU_PROVISIONER_NAME=$(GPU_PROVISIONER_NAME) KAITO_NAMESPACE=$(KAITO_NAMESPACE) \
189189
KARPENTER_NAMESPACE=$(KARPENTER_NAMESPACE) KAITO_RAGENGINE_NAMESPACE=$(KAITO_RAGENGINE_NAMESPACE) TEST_SUITE=$(TEST_SUITE) \
@@ -214,7 +214,7 @@ create-aks-cluster: ## Create an AKS cluster with MSI, OIDC, and workload identi
214214
az aks get-credentials --name $(AZURE_CLUSTER_NAME) --resource-group $(AZURE_RESOURCE_GROUP) --overwrite-existing
215215

216216
.PHONY: create-aks-cluster-with-kaito
217-
create-aks-cluster-with-kaito: ## Create an AKS cluster with MSI, OIDC, and Kaito enabled.
217+
create-aks-cluster-with-kaito: ## Create an AKS cluster with MSI, OIDC, and KAITO enabled.
218218
az aks create --name $(AZURE_CLUSTER_NAME) --resource-group $(AZURE_RESOURCE_GROUP) \
219219
--location $(AZURE_LOCATION) --attach-acr $(AZURE_ACR_NAME) \
220220
--kubernetes-version $(AKS_K8S_VERSION) --generate-ssh-keys \
@@ -372,13 +372,13 @@ docker-build-llm-reference-preset: docker-buildx ## Build Docker image for LLM r
372372
--build-arg VERSION=$(VERSION) .
373373

374374
## --------------------------------------
375-
## Kaito Installation
375+
## KAITO Installation
376376
## --------------------------------------
377377

378-
##@ Kaito Installation
378+
##@ KAITO Installation
379379

380380
.PHONY: prepare-kaito-addon-identity
381-
prepare-kaito-addon-identity: ## Create Azure identity and federated credential for Kaito addon.
381+
prepare-kaito-addon-identity: ## Create Azure identity and federated credential for KAITO addon.
382382
IDENTITY_PRINCIPAL_ID=$(shell az identity show --name "ai-toolchain-operator-$(AZURE_CLUSTER_NAME)" -g "$(AZURE_RESOURCE_GROUP_MC)" --query 'principalId');\
383383
az role assignment create --assignee $$IDENTITY_PRINCIPAL_ID --scope "/subscriptions/$(AZURE_SUBSCRIPTION_ID)/resourceGroups/$(AZURE_RESOURCE_GROUP_MC)" --role "Contributor"
384384

@@ -388,7 +388,7 @@ prepare-kaito-addon-identity: ## Create Azure identity and federated credential
388388
--subject system:serviceaccount:"$(KAITO_NAMESPACE):kaito-gpu-provisioner" --audience api://AzureADTokenExchange
389389

390390
.PHONY: az-patch-install-helm
391-
az-patch-install-helm: ## Install Kaito workspace Helm chart and set Azure client env vars and settings in Helm values.
391+
az-patch-install-helm: ## Install KAITO workspace Helm chart and set Azure client env vars and settings in Helm values.
392392
az aks get-credentials --name $(AZURE_CLUSTER_NAME) --resource-group $(AZURE_RESOURCE_GROUP)
393393

394394
yq -i '(.image.repository) = "$(REGISTRY)/workspace"' ./charts/kaito/workspace/values.yaml
@@ -398,7 +398,7 @@ az-patch-install-helm: ## Install Kaito workspace Helm chart and set Azure clien
398398
helm install kaito-workspace ./charts/kaito/workspace --namespace $(KAITO_NAMESPACE) --create-namespace $(HELM_INSTALL_EXTRA_ARGS)
399399

400400
.PHONY: az-patch-install-ragengine-helm
401-
az-patch-install-ragengine-helm: ## Install Kaito RAG Engine Helm chart and set Azure client env vars and settings in Helm values.
401+
az-patch-install-ragengine-helm: ## Install KAITO RAG Engine Helm chart and set Azure client env vars and settings in Helm values.
402402
az aks get-credentials --name $(AZURE_CLUSTER_NAME) --resource-group $(AZURE_RESOURCE_GROUP)
403403

404404
yq -i '(.image.repository) = "$(REGISTRY)/ragengine"' ./charts/kaito/ragengine/values.yaml
@@ -408,7 +408,7 @@ az-patch-install-ragengine-helm: ## Install Kaito RAG Engine Helm chart and set
408408
helm install kaito-ragengine ./charts/kaito/ragengine --namespace $(KAITO_RAGENGINE_NAMESPACE) --create-namespace $(HELM_INSTALL_EXTRA_ARGS)
409409

410410
.PHONY: az-patch-install-ragengine-helm-e2e
411-
az-patch-install-ragengine-helm-e2e: ## Install Kaito RAG Engine Helm chart for e2e tests and set Azure client env vars and settings in Helm values.
411+
az-patch-install-ragengine-helm-e2e: ## Install KAITO RAG Engine Helm chart for e2e tests and set Azure client env vars and settings in Helm values.
412412
az aks get-credentials --name $(AZURE_CLUSTER_NAME) --resource-group $(AZURE_RESOURCE_GROUP)
413413

414414
yq -i '(.image.repository) = "$(REGISTRY)/ragengine"' ./charts/kaito/ragengine/values.yaml
@@ -421,7 +421,7 @@ az-patch-install-ragengine-helm-e2e: ## Install Kaito RAG Engine Helm chart for
421421
helm install kaito-ragengine ./charts/kaito/ragengine --namespace $(KAITO_RAGENGINE_NAMESPACE) --create-namespace $(HELM_INSTALL_EXTRA_ARGS)
422422

423423
.PHONY: aws-patch-install-helm
424-
aws-patch-install-helm: ## Install Kaito workspace Helm chart and set AWS env vars and settings in Helm values.
424+
aws-patch-install-helm: ## Install KAITO workspace Helm chart and set AWS env vars and settings in Helm values.
425425
yq -i '(.image.repository) = "$(REGISTRY)/workspace"' ./charts/kaito/workspace/values.yaml
426426
yq -i '(.image.tag) = "$(IMG_TAG)"' ./charts/kaito/workspace/values.yaml
427427
yq -i '(.clusterName) = "$(AWS_CLUSTER_NAME)"' ./charts/kaito/workspace/values.yaml

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Linux Foundation ID group through the [Linux Foundation Support website](https:/
149149

150150
## Get Involved!
151151

152-
- Visit [#kaito channel in CNCF Slack](https://cloud-native.slack.com/archives/C09B4EWCZ5M) to discuss features in development and proposals.
152+
- Visit [#KAITO channel in CNCF Slack](https://cloud-native.slack.com/archives/C09B4EWCZ5M) to discuss features in development and proposals.
153153
- We host a weekly community meeting for contributors on Tuesdays at 4:00pm PST. Please join here: [meeting link](https://zoom-lfx.platform.linuxfoundation.org/meeting/99948431028?password=05912bb9-53fb-4b22-a634-ab5f8261e94c).
154154
- Reference the weekly meeting notes in our [KAITO community calls doc](https://docs.google.com/document/d/1OEC-WUQ2wn0TDQPsU09shMoXn5cW3dSrdu-M43Q79dA/edit?usp=sharing)!
155155

api/v1alpha1/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
// See the License for the specific language governing permissions and
1212
// limitations under the License.
1313

14-
// Package v1alpha1 contains API Schema definitions for the kaito v1alpha1 API group
14+
// Package v1alpha1 contains API Schema definitions for the KAITO v1alpha1 API group
1515
// +kubebuilder:object:generate=true
1616
// +k8s:defaulter-gen=TypeMeta
1717
// +groupName=kaito.sh

api/v1alpha1/labels.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const (
2626
// KAITOPrefix Kubernetes Data Mining prefix.
2727
KAITOPrefix = "kaito.sh/"
2828

29-
// AnnotationEnableLB determines whether kaito creates LoadBalancer type service for testing.
29+
// AnnotationEnableLB determines whether KAITO creates LoadBalancer type service for testing.
3030
AnnotationEnableLB = KAITOPrefix + "enablelb"
3131

3232
// LabelWorkspaceName is the label for workspace name.

api/v1beta1/labels.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const (
2626
// KAITOPrefix Kubernetes Data Mining prefix.
2727
KAITOPrefix = "kaito.sh/"
2828

29-
// AnnotationEnableLB determines whether kaito creates LoadBalancer type service for testing.
29+
// AnnotationEnableLB determines whether KAITO creates LoadBalancer type service for testing.
3030
AnnotationEnableLB = KAITOPrefix + "enablelb"
3131

3232
// LabelWorkspaceName is the label for workspace name.

charts/kaito/ragengine/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Default values for kaito.
1+
# Default values for KAITO.
22
# This is a YAML-formatted file.
33
# Declare variables to be passed into your templates.
44
replicaCount: 1

charts/kaito/workspace/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Default values for kaito.
1+
# Default values for KAITO.
22
# This is a YAML-formatted file.
33
# Declare variables to be passed into your templates.
44
replicaCount: 1

docs/documentation-versioning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Versioning Workflow
22

3-
This document explains how the automated documentation versioning workflow works in the Kaito project.
3+
This document explains how the automated documentation versioning workflow works in the KAITO project.
44

55
## Overview
66

7-
The `docs-versioning.yaml` GitHub Actions workflow automatically creates versioned documentation when new minor versions are released. This ensures that users can access documentation for specific versions of Kaito.
7+
The `docs-versioning.yaml` GitHub Actions workflow automatically creates versioned documentation when new minor versions are released. This ensures that users can access documentation for specific versions of KAITO.
88

99
## How it Works
1010

docs/proposals/20250611-workspace-subresource-scale-api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,24 @@ see-also:
1414

1515
# Title
1616

17-
Support scale subresource api for workspace in kaito
17+
Support scale subresource api for workspace in KAITO
1818

1919
## Summary
2020

2121
As the number of waiting inference requests increase, It is necessary to scale more inference instances in order to preventing to block inference requests. on the other hand, If the number of waiting inference requests declines, we should consider to reduce inference instances for improving gpu resource utilization.
2222

23-
We hope to provide an auto-scaler feature for scaling inference workloads automatically in terms of changes of custom metrics from inference pods, and this auto scaler doesn't depend on other components(this means Kaito is a self-contained component without dependencies). and we will divide this auto-scaler feature into two parts as following:
23+
We hope to provide an auto-scaler feature for scaling inference workloads automatically in terms of changes of custom metrics from inference pods, and this auto scaler doesn't depend on other components(this means KAITO is a self-contained component without dependencies). and we will divide this auto-scaler feature into two parts as following:
2424

25-
- Part one: support scale subresource api for workspace, so different auto-scaler solutions such as KEDA, HPA, etc. can be integrated with Kaito to mamage inference workloads dynamically. This part is addressed in this proposal.
25+
- Part one: support scale subresource api for workspace, so different auto-scaler solutions such as KEDA, HPA, etc. can be integrated with KAITO to mamage inference workloads dynamically. This part is addressed in this proposal.
2626
- Part two: support a customized auto-sacler for kaito. The auto-scaler is designed for a minimalistic configuration experience, with most parameters pre-tuned for optimal performance. This allows users to easily get started without requiring specialized knowledge of LLM. This part will be addressed in another proposal.
2727

2828
## Motivation
2929

30-
LLM inference service is a baisc and widly-used feature in Kaito, and Kaito community interest in auto scaler for inference workloads continues to intensify, related issues: [#306](https://github.com/kaito-project/kaito/issues/306), [#1104](https://github.com/kaito-project/kaito/issues/1104).
30+
LLM inference service is a baisc and widly-used feature in KAITO, and KAITO community interest in auto scaler for inference workloads continues to intensify, related issues: [#306](https://github.com/kaito-project/kaito/issues/306), [#1104](https://github.com/kaito-project/kaito/issues/1104).
3131

3232
From the technical perspective, It's a good idea to provide auto-scaler capability, becasue the auto-scaler of inference workloads dynamically adjusts the number of inference instances based on request volume--scaling up during traffic spikes to improve inference speed, and scaling down during low demand to minimize GPU resource waste.
3333

34-
To ensure different auto-scaler solutions can integrate with Kaito to manage inference workloads dynamically, We aim to support scale subresource API for Workspace CRD in kaito.
34+
To ensure different auto-scaler solutions can integrate with KAITO to manage inference workloads dynamically, We aim to support scale subresource API for Workspace CRD in KAITO.
3535

3636
### Goals
3737

docs/proposals/20250630-kaito-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Kaito Kubectl CLI Plugin
2+
title: KAITO Kubectl CLI Plugin
33
authors:
44
- "@helayoty"
55
creation-date: 2025-06-30
@@ -10,7 +10,7 @@ see-also:
1010

1111
## Summary
1212

13-
Kaito CLI provides a user-friendly kubectl extension for deploying and managing KAITO workspaces on Kubernetes. Kaito kubectl plugin aims to reduce friction for data scientists and ML engineers by abstracting away error-prone YAML authoring and enabling streamlined model deployment workflows. The initial focus is on core deployment and inference scenarios, with potential expansion to a standalone CLI if advanced features beyond kubectl's scope are needed.
13+
KAITO CLI provides a user-friendly kubectl extension for deploying and managing KAITO workspaces on Kubernetes. KAITO kubectl plugin aims to reduce friction for data scientists and ML engineers by abstracting away error-prone YAML authoring and enabling streamlined model deployment workflows. The initial focus is on core deployment and inference scenarios, with potential expansion to a standalone CLI if advanced features beyond kubectl's scope are needed.
1414

1515
## Motivation
1616

@@ -40,7 +40,7 @@ Currently, users interact with KAITO by manually crafting Kubernetes YAML manife
4040

4141
### Kubectl Plugin
4242

43-
A new kubectl plugin distributed through [Krew](https://github.com/kubernetes-sigs/krew) for Kaito that provides seamless integration with existing Kubernetes workflows.
43+
A new kubectl plugin distributed through [Krew](https://github.com/kubernetes-sigs/krew) for KAITO that provides seamless integration with existing Kubernetes workflows.
4444

4545
Designed for engineers already comfortable with native Kubernetes tooling. By distributing the plugin through [Krew](https://github.com/kubernetes-sigs/krew), users avoid installing a separate binary, inherit their existing kube-contexts and RBAC, and benefit from familiar `kubectl` verb–noun syntax.
4646

0 commit comments

Comments
 (0)