Skip to content

Commit

Permalink
Merge pull request #375 from zexi/upgrade-docs
Browse files Browse the repository at this point in the history
feat: 更新升级内容
  • Loading branch information
zexi authored Oct 16, 2024
2 parents f0f121a + f140ca8 commit 33410ae
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 65 deletions.
30 changes: 29 additions & 1 deletion docs/getting-started/baremetal/docker-compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,8 @@ LISTEN_INTERFACE=eth0 PUBLIC_IP=10.168.222.205 docker compose up

```bash
# 所有服务放到后台运行
$ docker compose up -d
# 下面命令假设 eth0 网卡上的 ip 地址为 10.168.222.205,具体设置请根据自己的环境设置。
$ LISTEN_INTERFACE=eth0 PUBLIC_IP=10.168.222.205 docker compose up -d

# 服务放到后台后,可以通过 logs 自命令查看输出日志
$ docker compose logs -f
Expand Down Expand Up @@ -266,3 +267,30 @@ data
# 删除服务
$ docker compose down
```

## 升级

通过 docker compose 升级很方便,只用更新 docker-compose.yml 的配置文件,然后重启服务就行。

### 更新 compose 配置文件

当上游的 [ocboot/compose/baremetal/docker-compose.yml](https://github.com/yunionio/ocboot/blob/master/compose/baremetal/docker-compose.yml) 更新了,就可以通过 curl 命令下载最新的配置文件,然后重新启动就可以了,步骤如下:

```bash
# 注意切换到对应的 cloudpods-baremetal 目录
$ cd cloudpods-baremetal

# 下载配置文件
$ curl https://raw.githubusercontent.com/yunionio/ocboot/master/compose/baremetal/docker-compose.yml -o docker-compose.yaml
```

### 重启 compose 服务

拉取最新的 docker-compose.yml 配置文件后,使用下面命令重启服务就行了。

```bash
$ docker compose down

# 下面命令假设 eth0 网卡上的 ip 地址为 10.168.222.205,具体设置请根据自己的环境设置。
$ LISTEN_INTERFACE=eth0 PUBLIC_IP=10.168.222.205 docker compose up
```
35 changes: 31 additions & 4 deletions docs/getting-started/cmp/quickstart-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,37 @@ data
$ docker compose down
```

## 升级

通过 docker compose 升级很方便,只用更新 docker-compose.yml 的配置文件。

当上游的 [ocboot/compose/docker-compose.yml](https://github.com/yunionio/ocboot/blob/master/compose/docker-compose.yml) 更新了,就可以通过 git pull 命令,拉取最新的代码,然后重新启动就可以了,步骤如下:


### 更新 ocboot 代码

登录运行 docker compose 的节点,进入 ocboot 代码目录。

```bash
$ cd ocboot
```

拉取最新的代码,并 checkout 到对应的发布版本。

import OcbootFetchCheckout from '@site/src/components/OcbootFetchCheckout';

<OcbootFetchCheckout />

### 重启 compose 服务

拉取最新的 docker-compose.yml 配置文件后,使用下面命令重启服务就行了。

```bash
$ cd compose
$ docker compose down
$ docker compose up -d
```

## 常见问题

### 1. docker 服务没有打开 iptables 和 bridge 导致容器网路无法创建
Expand All @@ -148,7 +179,3 @@ Cloudpods CMP 多云管理版本包含了很多服务,如果一个一个手写
```bash
$ python3 generate-compose.py > compose/docker-compose.yml
```

### 3. 如何升级服务?

参考文档:[通过 docker compose 升级](../../operations/upgrading/docker-compose-upgrade)
42 changes: 0 additions & 42 deletions docs/operations/upgrading/docker-compose-upgrade.md

This file was deleted.

24 changes: 8 additions & 16 deletions docs/operations/upgrading/ocboot-upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ sidebar_position: 1
介绍如何通过 ocboot 升级服务版本到指定版本。

:::tip
ocboot 只能升级通过 ocboot 部署的环境,如果你的环境是通过 docker compose 部署的,请参考以下文档升级:

- [通过 docker compose 升级](./docker-compose-upgrade)
ocboot 只能升级通过 ocboot 部署的环境,如果你的环境是通过 docker compose 或者 helm 部署的,请参考对应部署文档里面的升级操作。
:::

## 前提条件
Expand All @@ -26,7 +24,7 @@ ocboot 只能升级通过 ocboot 部署的环境,如果你的环境是通过 d

import ReleaseVersion from '@site/src/components/ReleaseVersion'

1. 使用 git 拉取最新的 [ocboot](https://github.com/yunionio/ocboot) 代码,切换到 <ReleaseVersion /> 的 tag
1. 下载 [ocboot](https://github.com/yunionio/ocboot/releases) 对应版本代码
2. 使用 [ocboot](https://github.com/yunionio/ocboot) 里面的 `./ocboot.sh upgrade` 命令进行版本升级

## 查看当前版本
Expand All @@ -37,21 +35,15 @@ import GetClusterVersion from '@site/src/components/GetClusterVersion'

<GetClusterVersion />

## 拉取 ocboot 工具

如果本地已经有 ocboot 工具可以跳过此步,只用把代码更新到对应的分支。

下载 ocboot 工具到本地:

import OcbootClone from '@site/src/components/OcbootK3sClone';
## 下载 ocboot 工具

<OcbootClone />

## 更新 ocboot 代码
:::tip
如果本地已经有都应版本的代码,可以跳过下面的步骤,但一般情况下,随着每次新版本发布,都会有对应的 ocboot 部署工具发布,需要使用对应的版本来更新。
:::

import OcbootFetchCheckout from '@site/src/components/OcbootK3sFetchCheckout';
import OcbootReleaseDownload from '../../getting-started/_parts/_quickstart-ocboot-release-download.mdx';

<OcbootFetchCheckout />
<OcbootReleaseDownload />

## 升级服务组件

Expand Down
4 changes: 2 additions & 2 deletions src/components/OcbootFetchCheckout.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ import CodeBlock from '@theme/CodeBlock';
import { getCustomField } from './utils';

export default function OcbootFetchCheckout() {
const version = getCustomField('release_version')
const branch = getCustomField('release_branch')
return (
<CodeBlock language='bash'>
{
`$ git fetch\n` + `$ git checkout ${version}`
`$ git fetch --all\n` + `$ git checkout origin/${branch}`
}
</CodeBlock>
)
Expand Down

0 comments on commit 33410ae

Please sign in to comment.