Skip to content
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

tiup: refactor tiup reference #4868

Merged
merged 76 commits into from
Mar 1, 2021
Merged
Changes from 1 commit
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
6afee2c
Prepare to change
lucklove Nov 10, 2020
0e76708
Introduce reference
lucklove Nov 11, 2020
d8fda1c
Add reference for tiup list and tiup uninstall
lucklove Nov 11, 2020
2077674
mirror WIP
lucklove Nov 26, 2020
14e8a3a
Update
lucklove Dec 9, 2020
724aea0
Add tiup mirror command
lucklove Dec 10, 2020
7d34944
More document for mirror
lucklove Dec 16, 2020
cfe4a2c
Add doc
lucklove Dec 17, 2020
0098142
Update publish document
lucklove Dec 18, 2020
448f74f
Update document for mirror
lucklove Dec 22, 2020
637a92f
Finish the command section
lucklove Dec 24, 2020
769ddff
Add topology reference for tiup-cluster
lucklove Dec 30, 2020
89feb16
Document for dm cluster topology
lucklove Dec 31, 2020
96fbf83
Update
lucklove Jan 5, 2021
35807e7
Finish dm
lucklove Jan 7, 2021
c330d88
Finish dm
lucklove Jan 7, 2021
186d4bc
Address comment
lucklove Jan 11, 2021
f508d7b
Fix lint
lucklove Jan 11, 2021
0872ad1
Merge branch 'master' into tiup
lucklove Jan 11, 2021
00c69e7
Fix link
lucklove Jan 11, 2021
8022482
Fix lint
lucklove Jan 11, 2021
0b1a0be
Merge branch 'master' into tiup
TomShawn Jan 11, 2021
ee910ad
Merge branch 'master' into tiup
lucklove Jan 12, 2021
5c09de5
Remove unused aliases
lucklove Jan 20, 2021
6d82fd4
Remove description title
lucklove Jan 20, 2021
46f2276
Apply suggestions from code review
lucklove Jan 20, 2021
92ec495
Merge branch 'tiup' of https://github.com/lucklove/docs-cn into tiup
lucklove Jan 20, 2021
ecb7df4
Apply suggestions from code review
lucklove Jan 21, 2021
85c60ee
Apply suggestions from code review
lucklove Jan 22, 2021
c9fde0c
Apply suggestions from code review
lucklove Jan 22, 2021
cf58861
Apply suggestions from code review
lucklove Jan 22, 2021
3465363
Address comment
lucklove Jan 22, 2021
e78004c
Merge branch 'master' into tiup
lucklove Jan 25, 2021
3c6384b
Merge branch 'master' into tiup
lucklove Jan 26, 2021
e2321f2
Merge branch 'master' into tiup
lucklove Jan 28, 2021
bb6ca71
Apply suggestions from code review
lucklove Jan 29, 2021
aa71655
Merge branch 'master' into tiup
lucklove Jan 29, 2021
ef916b9
Update tiup/tiup-reference.md
lucklove Jan 29, 2021
cb6bced
Address comment
lucklove Jan 29, 2021
aaf4ed6
Merge branch 'master' into tiup
lucklove Feb 1, 2021
ae9ea1e
Address comment
lucklove Feb 1, 2021
4f935fa
Update tiup-command-clean.md
yikeke Feb 1, 2021
d7ea451
fix a typo
Feb 1, 2021
258e28f
Apply suggestions from code review
lucklove Feb 1, 2021
2e9c211
Address comment
lucklove Feb 1, 2021
73b54a9
Address comment
lucklove Feb 1, 2021
5a14917
Apply suggestions from code review
lucklove Feb 1, 2021
f26f895
Update tiup/tiup-mirror-reference.md
lucklove Feb 1, 2021
85a6968
Merge branch 'master' into tiup
lucklove Feb 1, 2021
6d3a5af
Address comment
lucklove Feb 1, 2021
f1654e8
Apply suggestions from code review
lucklove Feb 1, 2021
f0e7a66
Address comment
lucklove Feb 1, 2021
000800b
Apply suggestions from code review
lucklove Feb 2, 2021
a2c1669
Merge branch 'master' into tiup
TomShawn Feb 3, 2021
9dc570e
refine format and remove control characters
TomShawn Feb 3, 2021
8424606
correct spelling and format
TomShawn Feb 3, 2021
99e5f99
Merge branch 'master' into tiup
TomShawn Feb 4, 2021
84859dc
Merge branch 'master' into tiup
TomShawn Feb 17, 2021
9c36c71
Merge branch 'master' into tiup
TomShawn Feb 18, 2021
dce1411
Resolve comment
lucklove Feb 22, 2021
ecbe08f
Apply suggestions from code review
lucklove Feb 22, 2021
a624e66
Merge branch 'tiup' of https://github.com/lucklove/docs-cn into tiup
lucklove Feb 22, 2021
bee0ba1
Merge branch 'master' into tiup
lucklove Feb 22, 2021
67e711b
Update tiup/tiup-command-completion.md
lucklove Feb 24, 2021
e58c0f7
Address comment
lucklove Feb 24, 2021
1b8ea3b
Merge branch 'tiup' of https://github.com/lucklove/docs-cn into tiup
lucklove Feb 24, 2021
8768213
Fix link
lucklove Feb 24, 2021
a00215c
Apply suggestions from code review
lucklove Feb 24, 2021
b869c11
Address comment
lucklove Feb 25, 2021
6794b15
Merge branch 'tiup' of https://github.com/lucklove/docs-cn into tiup
lucklove Feb 25, 2021
d2d4d8c
Merge branch 'master' into tiup
TomShawn Mar 1, 2021
dbd243e
Merge branch 'master' into tiup
yikeke Mar 1, 2021
7bbaecf
Fix link
lucklove Mar 1, 2021
69ff4f8
Address comment
lucklove Mar 1, 2021
4005fd3
add links to tiup-cluster-topology-reference.md
Mar 1, 2021
b82fddf
fix links
Mar 1, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update publish document
  • Loading branch information
lucklove committed Jan 7, 2021
commit 0098142b6ff23ffd0f534848188f5b3d14dd46a4
61 changes: 61 additions & 0 deletions tiup/tiup-command-mirror-publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: tiup mirror publish
aliases: ['/docs-cn/dev/tiup/tiup-command-mirror-publish/']
---

# tiup mirror publish

## 介绍

命令 `tiup mirror publish` 用于发布新组件,或已有组件的新版本。只有合法的组件管理员才可以发布组件,组件管理员的引入方式参考[grant命令](/tiup/tiup-command-mirror-grant.md)。

## 语法

```sh
tiup mirror publish <comp-name> <version> <tarball> <entry> [flags]
```

各个参数解释如下:

- `<comp-name>`:组件名,如 ,建议使用符合正则 `^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$` 的字符串
- `<version>`:当前正在发布的版本,需要符合 [Semantic Versioning](https://semver.org/)
lucklove marked this conversation as resolved.
Show resolved Hide resolved
lucklove marked this conversation as resolved.
Show resolved Hide resolved
- `<tarball>`:`.tar.gz` 包的本地路径,需要将组件的可执行文件及依赖放在该包中,由 TiUP 上传到镜像
- `<entry>`:组件的可执行文件在 `<tarball>` 中的位置
lucklove marked this conversation as resolved.
Show resolved Hide resolved

## 选项

### -k, --key(string,默认 ${TIUP_HOME}/keys/private.json)

组件管理员的私钥,客户端需要使用该私钥对组件信息 (`{component}.json`) 进行签名。

### --arch(string,默认 ${GOARCH})

该 `<tarlball>` 中的二进制文件运行的平台,一个 `<tarball>` 只能选以下三个平台之一:

- amd64:表示在 amd64 架构的机器上运行
- arm64:表示在 arm64 架构的机器上运行
lucklove marked this conversation as resolved.
Show resolved Hide resolved
- any:表示可以在以上两种架构的机器上运行(比如脚本)

> **注意:**
>
> 若 `--arch` 指定为 `any`,则 `--os` 也必须指定为 `any`。

### --os(string,默认 ${GOOS})

该 `<tarlball>` 中的二进制文件运行的操作系统,一个 `<tarball>` 只能选以下三个操作系统之一:

- linux:表示在 Linux 操作系统上运行
- darwin:表示在 Darwin 操作系统上运行
- any:表示可以在以上两种操作系统上运行(比如脚本)

> **注意:**
>
> 若 `--os` 指定为 `any`,则 `--arch` 也必须指定为 `any`。

### --desc(string,默认为空)

该组件的描述信息。

### --hide(boolean,默认 false)

是否为隐藏组件,若为隐藏组件,则不在 `tiup list` 的列表中显示,但是 `tiup list --all` 可看到。