From 82e601488517895fbacf107dcda2edf7d7b45b36 Mon Sep 17 00:00:00 2001 From: Neko Ayaka Date: Sat, 20 Apr 2024 23:25:54 +0800 Subject: [PATCH] docs: updated themes, guides Signed-off-by: Neko Ayaka --- CONTRIBUTING.md | 2 +- README.md | 21 ++++++++++++++++++- .../components/GettingStartedBlocksEn.vue | 12 +++++------ .../components/GettingStartedBlocksZhCn.vue | 14 ++++++------- 4 files changed, 34 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41d4853..a74a182 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,7 +166,7 @@ its dependencies. 2. Using the installer -Users can just run kubectl apply -f to install the project, i.e.: +Users can just run `kubectl apply -f ` to install the project, i.e.: ```sh kubectl apply -f https://raw.githubusercontent.com//ollama-operator//dist/install.yaml diff --git a/README.md b/README.md index 3c5b778..5665101 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,24 @@ kubectl apply -f https://raw.githubusercontent.com/nekomeowww/ollama-operator/ma kubectl wait --for=jsonpath='{.status.replicas}'=2 deployment/ollama-operator-controller-manager -n ollama-operator-system ``` -### Create model +### Deploy a model + +> [!NOTE] +> You can also use the `kollama` CLI natively shipped by Ollama Operator, and will be easier to interact with the operator. +> +> Install `kollama` CLI: +> +> ```shell +> go install github.com/nekomeowww/ollama-operator/cmd/kollama@latest +> ``` +> +> Deploy a model can be done with the following command: +> +> ```shell +> kollama deploy phi --expose --node-port 30001 +> ``` +> +> More information can be found at [CLI](https://ollama-operator.ayaka.io/pages/en/guide/getting-started/cli.html) > [!IMPORTANT] > Working with `kind`? @@ -64,6 +81,8 @@ kubectl wait --for=jsonpath='{.status.replicas}'=2 deployment/ollama-operator-co > accessMode: ReadWriteOnce > ``` +Let's create a `Model` CRD for the model `phi`: + ```yaml apiVersion: ollama.ayaka.io/v1 kind: Model diff --git a/docs/.vitepress/theme/components/GettingStartedBlocksEn.vue b/docs/.vitepress/theme/components/GettingStartedBlocksEn.vue index 084cae3..3566cbc 100644 --- a/docs/.vitepress/theme/components/GettingStartedBlocksEn.vue +++ b/docs/.vitepress/theme/components/GettingStartedBlocksEn.vue @@ -16,9 +16,9 @@
-

Dislike YAML?

-

Faster and better UX?

-

No worries, kollama here to rescue!

+

Dislike YAML?

+

Faster and better UX?

+

No worries, kollama here to rescue!

# as regular binary cli

@@ -47,9 +47,9 @@
-

Fine-grained control over parameters?

-

GitOps and CI/CD?

-

CRD is simple enough with 6 lines!

+

Fine-grained control over parameters?

+

GitOps and CI/CD?

+

CRD is simple enough with 6 lines!

apiVersion: ollama.ayaka.io/v1

diff --git a/docs/.vitepress/theme/components/GettingStartedBlocksZhCn.vue b/docs/.vitepress/theme/components/GettingStartedBlocksZhCn.vue index 803c8e0..e70d38b 100644 --- a/docs/.vitepress/theme/components/GettingStartedBlocksZhCn.vue +++ b/docs/.vitepress/theme/components/GettingStartedBlocksZhCn.vue @@ -16,15 +16,15 @@
-

讨厌 YAML?

-

更好更快的使用体验?

-

没问题的,用 kollama 也可以!

+

讨厌 YAML?

+

更好更快的使用体验?

+

没问题的,用 kollama 也可以!

# 常规二进制

$ kollama deploy phi

- or + 或者

# 作为 kubectl 插件

$ kubectl ollama deploy phi

@@ -47,9 +47,9 @@
-

对部署参数的精细控制?

-

GitOps 和自动化部署?

-

CRD 也超简单,只有 6 行!

+

对部署参数的精细控制?

+

GitOps 和自动化部署?

+

CRD 也超简单,只有 6 行!

apiVersion: ollama.ayaka.io/v1