Skip to content

Commit

Permalink
doc(helm): update cloud install docs for docker registry (star-whale#…
Browse files Browse the repository at this point in the history
…1773)

update cloud install docs for docker registry
  • Loading branch information
tianweidut authored Feb 3, 2023
1 parent 968bdc2 commit f91953b
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 35 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,13 +291,14 @@ Let's go ahead and finish the tutorial on the on-premises instance.
```bash
helm repo add starwhale https://star-whale.github.io/charts
helm repo update
helm install --devel my-starwhale starwhale/starwhale -n starwhale --create-namespace --set minikube.enabled=true
export SWNAME=starwhale SWNS=starwhale
helm upgrade --install $SWNAME starwhale/starwhale --namespace $SWNS --create-namespace --set minikube.enabled=true --set mysql.primary.persistence.storageClass=$SWNAME-mysql --set minio.persistence.storageClass=$SWNAME-minio --set image.registry=docker-registry.starwhale.cn --set minio.global.imageRegistry=docker-registry.starwhale.cn --set mysql.global.imageRegistry=docker-registry.starwhale.cn
```
After the installation is successful, the following prompt message appears:
```bash
NAME: my-starwhale
NAME: starwhale
LAST DEPLOYED: Thu Jun 23 14:48:02 2022
NAMESPACE: starwhale
STATUS: deployed
Expand All @@ -311,13 +312,13 @@ Let's go ahead and finish the tutorial on the on-premises instance.
Port Forward Visit:
- starwhale controller:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-controller 8082:8082
- run: kubectl port-forward --namespace starwhale svc/starwhale-controller 8082:8082
- visit: http://localhost:8082
- minio admin:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-minio 9001:9001
- run: kubectl port-forward --namespace starwhale svc/starwhale-minio 9001:9001
- visit: http://localhost:9001
- mysql:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-mysql 3306:3306
- run: kubectl port-forward --namespace starwhale svc/starwhale-mysql 3306:3306
- visit: mysql -h 127.0.0.1 -P 3306 -ustarwhale -pstarwhale
******************************************
Expand All @@ -336,14 +337,14 @@ Let's go ahead and finish the tutorial on the on-premises instance.
| NAME | READY | STATUS | RESTARTS | AGE |
|:-----|-------|--------|----------|-----|
|my-starwhale-controller-7d864558bc-vxvb8|1/1|Running|0|1m
|my-starwhale-minio-7d45db75f6-7wq9b|1/1|Running|0|2m
|my-starwhale-mysql-0|1/1|Running|0|2m
|starwhale-controller-7d864558bc-vxvb8|1/1|Running|0|1m
|starwhale-minio-7d45db75f6-7wq9b|1/1|Running|0|2m
|starwhale-mysql-0|1/1|Running|0|2m
Make the Starwhale controller accessible locally with the following command:
```bash
kubectl port-forward --namespace starwhale svc/my-starwhale-controller 8082:8082
kubectl port-forward --namespace starwhale svc/starwhale-controller 8082:8082
```
- ☕ **STEP4**: Upload the artifacts to the cloud instance
Expand Down
11 changes: 9 additions & 2 deletions docs/docs/guides/install/helm-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ helm delete starwhale

| Name | Description | Default Value |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `image.registry` | image registry, you can find Starwhale docker images in docker.io or ghcr.io. | `ghcr.io` |
| `image.org` | image registry org, [starwhaleai](https://hub.docker.com/u/starwhaleai)(docker.io) or [star-whale](https://github.com/orgs/star-whale)(ghcr.io) or some custom org name in other registries | `star-whale` |
| `image.registry` | image registry, you can find Starwhale docker images in docker.io or ghcr.io or docker-registry.starwhale.cn. For users in the mainland of China, please use docker-registry.starwhale.cn registry. | `ghcr.io`|
| `image.org`| image registry org, [starwhaleai](https://hub.docker.com/u/starwhaleai)(docker.io) or [star-whale](https://github.com/orgs/star-whale)(ghcr.io and docker-registry.starwhale.cn) or some custom org name in other registries | `star-whale` |

### 6.2 Starwhale parameters

Expand Down Expand Up @@ -85,6 +85,13 @@ In minikube mode, you can easy to build an all-in-one starwhale. Run command exa
helm upgrade --install starwhale starwhale/starwhale --namespace starwhale --create-namespace --set minikube.enabled=true
```

For users in the mainland of China, please use the following command:

```bash
export SWNAME=starwhale SWNS=starwhale
helm upgrade --install $SWNAME starwhale/starwhale --namespace $SWNS --create-namespace --set minikube.enabled=true --set mysql.primary.persistence.storageClass=$SWNAME-mysql --set minio.persistence.storageClass=$SWNAME-minio --set image.registry=docker-registry.starwhale.cn --set minio.global.imageRegistry=docker-registry.starwhale.cn --set mysql.global.imageRegistry=docker-registry.starwhale.cn
```

### 6.5 dev mode

| Name | Description | Default Value |
Expand Down
21 changes: 11 additions & 10 deletions docs/docs/quickstart/on-premises.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,14 @@ For users in the mainland of China, please add these startup parameters:`--ima
```bash
helm repo add starwhale https://star-whale.github.io/charts
helm repo update
helm install --devel my-starwhale starwhale/starwhale -n starwhale --create-namespace --set minikube.enabled=true
export SWNAME=starwhale SWNS=starwhale
helm upgrade --install $SWNAME starwhale/starwhale --namespace $SWNS --create-namespace --set minikube.enabled=true --set mysql.primary.persistence.storageClass=$SWNAME-mysql --set minio.persistence.storageClass=$SWNAME-minio --set image.registry=docker-registry.starwhale.cn --set minio.global.imageRegistry=docker-registry.starwhale.cn --set mysql.global.imageRegistry=docker-registry.starwhale.cn
```

After the installation is successful, the following prompt message appears:

```bash
NAME: my-starwhale
NAME: starwhale
LAST DEPLOYED: Thu Jun 23 14:48:02 2022
NAMESPACE: starwhale
STATUS: deployed
Expand All @@ -55,7 +56,7 @@ Chart Name: starwhale
Chart Version: 0.3.0
App Version: 0.3.0
Starwhale Image:
- server: ghcr.io/star-whale/server:0.3.0
- server: docker-registry.starwhale.cn/star-whale/server:0.3.0

******************************************
Web Visit:
Expand All @@ -64,13 +65,13 @@ Web Visit:

Port Forward Visist:
- starwhale controller:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-controller 8082:8082
- run: kubectl port-forward --namespace starwhale svc/starwhale-controller 8082:8082
- visit: http://localhost:8082
- minio admin:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-minio 9001:9001
- run: kubectl port-forward --namespace starwhale svc/starwhale-minio 9001:9001
- visit: http://localhost:9001
- mysql:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-mysql 3306:3306
- run: kubectl port-forward --namespace starwhale svc/starwhale-mysql 3306:3306
- visit: mysql -h 127.0.0.1 -P 3306 -ustarwhale -pstarwhale

******************************************
Expand All @@ -89,14 +90,14 @@ kubectl get pods -n starwhale

| NAME | READY | STATUS | RESTARTS | AGE |
|:-----|-------|--------|----------|-----|
|my-starwhale-controller-7d864558bc-vxvb8|1/1|Running|0|1m
|my-starwhale-minio-7d45db75f6-7wq9b|1/1|Running|0|2m
|my-starwhale-mysql-0|1/1|Running|0|2m
|starwhale-controller-7d864558bc-vxvb8|1/1|Running|0|1m
|starwhale-minio-7d45db75f6-7wq9b|1/1|Running|0|2m
|starwhale-mysql-0|1/1|Running|0|2m

Make the Starwhale controller accessible locally with the following command:

```bash
kubectl port-forward --namespace starwhale svc/my-starwhale-controller 8082:8082
kubectl port-forward --namespace starwhale svc/starwhale-controller 8082:8082
```

## 2. Upload the artifacts to the cloud instance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ helm delete starwhale

|字段|描述|默认值|
|---|---|-----|
| `image.registry` | 镜像Registry, Starwhale镜像会发布在 docker.ioghcr.io上| `ghcr.io`|
| `image.org` | 镜像的org名字: [starwhaleai](https://hub.docker.com/u/starwhaleai)(docker.io)、[star-whale](https://github.com/orgs/star-whale)(ghcr.io) 或者其他在私有registry上定义的镜像org名字 | `star-whale` |
| `image.registry` | 镜像Registry, Starwhale镜像会发布在 docker.io, ghcr.io和docker-registry.starwhale.cn上,中国大陆网络推荐使用docker-registry.starwhale.cn镜像源 | `ghcr.io`|
| `image.org` | 镜像的org名字: [starwhaleai](https://hub.docker.com/u/starwhaleai)(docker.io)、[star-whale](https://github.com/orgs/star-whale)(ghcr.io和docker-registry.starwhale.cn) 或者其他在私有registry上定义的镜像org名字 | `star-whale` |

### 6.2 Starwhale参数

Expand Down Expand Up @@ -79,11 +79,17 @@ helm delete starwhale
使用minikube模式,可以在单机环境使用minikube安装一个all-in-one的Starwhale,方便进行本地开发、调试。安装命令如下:

```bash
export SWNAME=starwhale
export SWNS=starwhale
export SWNAME=starwhale SWNS=starwhale
helm upgrade --install $SWNAME starwhale/starwhale --namespace $SWNS --create-namespace --set minikube.enabled=true --set mysql.primary.persistence.storageClass=$SWNAME-mysql --set minio.persistence.storageClass=$SWNAME-minio
```

若在中国大陆网络环境,推荐使用如下命令:

```bash
export SWNAME=starwhale SWNS=starwhale
helm upgrade --install $SWNAME starwhale/starwhale --namespace $SWNS --create-namespace --set minikube.enabled=true --set mysql.primary.persistence.storageClass=$SWNAME-mysql --set minio.persistence.storageClass=$SWNAME-minio --set image.registry=docker-registry.starwhale.cn --set minio.global.imageRegistry=docker-registry.starwhale.cn --set mysql.global.imageRegistry=docker-registry.starwhale.cn
```

### 6.5 开发模式

|字段|描述|默认值|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ minikube start
```bash
helm repo add starwhale https://star-whale.github.io/charts
helm repo update
helm install --devel my-starwhale starwhale/starwhale -n starwhale --create-namespace --set minikube.enabled=true
export SWNAME=starwhale SWNS=starwhale
helm upgrade --install $SWNAME starwhale/starwhale --namespace $SWNS --create-namespace --set minikube.enabled=true --set mysql.primary.persistence.storageClass=$SWNAME-mysql --set minio.persistence.storageClass=$SWNAME-minio --set image.registry=docker-registry.starwhale.cn --set minio.global.imageRegistry=docker-registry.starwhale.cn --set mysql.global.imageRegistry=docker-registry.starwhale.cn
```

更详细的Helm Charts参数配置,请参考[使用Helm安装Cloud Instance](../guides/install/helm-charts.md)文档。当成功安装后,会有类似如下信息输出:

```bash
NAME: my-starwhale
NAME: starwhale
LAST DEPLOYED: Thu Jun 23 14:48:02 2022
NAMESPACE: starwhale
STATUS: deployed
Expand All @@ -45,7 +46,7 @@ Chart Name: starwhale
Chart Version: 0.3.0
App Version: 0.3.0
Starwhale Image:
- server: ghcr.io/star-whale/server:0.3.0
- server: docker-registry.starwhale.cn/star-whale/server:0.3.0

******************************************
Web Visit:
Expand All @@ -54,13 +55,13 @@ Web Visit:

Port Forward Visist:
- starwhale controller:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-controller 8082:8082
- run: kubectl port-forward --namespace starwhale svc/starwhale-controller 8082:8082
- visit: http://localhost:8082
- minio admin:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-minio 9001:9001
- run: kubectl port-forward --namespace starwhale svc/starwhale-minio 9001:9001
- visit: http://localhost:9001
- mysql:
- run: kubectl port-forward --namespace starwhale svc/my-starwhale-mysql 3306:3306
- run: kubectl port-forward --namespace starwhale svc/starwhale-mysql 3306:3306
- visit: mysql -h 127.0.0.1 -P 3306 -ustarwhale -pstarwhale

******************************************
Expand All @@ -79,14 +80,14 @@ kubectl get pods -n starwhale

| NAME | READY | STATUS | RESTARTS | AGE |
|:-----|-------|--------|----------|-----|
|my-starwhale-controller-7d864558bc-vxvb8|1/1|Running|0|1m
|my-starwhale-minio-7d45db75f6-7wq9b|1/1|Running|0|2m
|my-starwhale-mysql-0|1/1|Running|0|2m
|starwhale-controller-7d864558bc-vxvb8|1/1|Running|0|1m
|starwhale-minio-7d45db75f6-7wq9b|1/1|Running|0|2m
|starwhale-mysql-0|1/1|Running|0|2m

可以使用kubectl的port-forward命令,在宿主机浏览器直接通过8082端口访问Starwhale Controller Web:

```bash
kubectl port-forward --namespace starwhale svc/my-starwhale-controller 8082:8082
kubectl port-forward --namespace starwhale svc/starwhale-controller 8082:8082
```

## 2. 发布Model/Runtime/Dataset到Cloud Instance上
Expand Down

0 comments on commit f91953b

Please sign in to comment.