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

fix broken links #117

Merged
merged 2 commits into from
Jul 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/v0.3/zh-CN/contribution/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ OpenPitrix 从一开始就是以开源的方式来进行,并且在 2017 年的

可以去跟踪代码,找到相关的代码逻辑,在这个过程中很容易对相关模块有了解,不少 Contributor 可能都是这样完成了第一次贡献,参考以下资料帮助您更好地了解 OpenPitrix。

- [安装指南](../../installation/installation-guide):将 OpenPitrix 部署到自己的环境中开始试用和功能体验
- [快速入门](../../getting-start/introduction):引导新用户快速上手 OpenPitrix
- [用户指南](../../user-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [安装指南](../installation/installation-guide):将 OpenPitrix 部署到自己的环境中开始试用和功能体验
- [快速入门](../getting-start/introduction):引导新用户快速上手 OpenPitrix
- [用户指南](../user-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [项目设计](https://github.com/openpitrix/openpitrix/blob/master/docs/design/README.md):设计的基本思路就是解耦应用程序的仓库和运行时环境,应用程序可以通过匹配运行时环境的标签和应用来源的仓库选择器来运行。
- [Dashboard 贡献指南](https://github.com/openpitrix/dashboard/blob/master/CONTRIBUTING.md):如何为用户控制台的 repo 提交贡献。

Expand Down
6 changes: 3 additions & 3 deletions docs/v0.3/zh-CN/contribution/open-source-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ OpenPitrix 从一开始就是以开源的方式来进行,并且在 2017 年的

可以去跟踪代码,找到相关的代码逻辑,在这个过程中很容易对相关模块有了解,不少 Contributor 可能都是这样完成了第一次贡献。

- [安装指南](../../installation/installation-guide):将 OpenPitrix 部署到自己的环境中开始试用和功能体验
- [快速入门](../../getting-start):引导新用户快速上手 OpenPitrix
- [用户指南](../../user-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [安装指南](../installation/installation-guide):将 OpenPitrix 部署到自己的环境中开始试用和功能体验
- [快速入门](../getting-start):引导新用户快速上手 OpenPitrix
- [用户指南](../user-guide/introduction) :熟悉 OpenPitrix 的使用详情
- [项目设计](https://github.com/openpitrix/openpitrix/blob/master/docs/design/README.md)

### 发现可以参与的事情
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.3/zh-CN/contribution/set-up-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ $ docker container ls | grep dashboard

![OpenPitrix 主页](/dashboard.png)

OpenPitrix 部署成功后,可以使用以下的管理员默认的用户名和密码登录 OpenPitrix 控制台体验,参见 [用户管理](../../user-guide/user-management) 创建开发者和普通用户的角色,[快速入门](../../getting-start/introduction) 将帮助您快速上手 OpenPitrix。
OpenPitrix 部署成功后,可以使用以下的管理员默认的用户名和密码登录 OpenPitrix 控制台体验,参见 [用户管理](../user-guide/user-management) 创建开发者和普通用户的角色,[快速入门](../getting-start/introduction) 将帮助您快速上手 OpenPitrix。


| 角色 | 用户名 | 密码 |
Expand Down
4 changes: 2 additions & 2 deletions docs/v0.3/zh-CN/developer-guide/helm-developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,9 @@ nginx nginx-0.1.0.tgz
```
至此,应用配置包就已经准备完毕,接下来需要创建仓库和上传应用。

仓库可以是 QingCloud 或 AWS 的对象存储,创建仓库可参考 [仓库管理](../../user-guide/repo-management)。
仓库可以是 QingCloud 或 AWS 的对象存储,创建仓库可参考 [仓库管理](../user-guide/repo-management)。

仓库创建完成即可上传应用到平台进一步测试和部署应用到 Kubernetes 运行环境中,可参考 [开发者 - 上传应用](../../getting-start/developer-quick-start/#第二步:上传应用)。部署 Helm Chart 类型的应用(如本篇提到的 nginx)到 Kubernetes 运行环境,参见 [部署 Nginx 到 Kubernetes](../../user-guide/deploying-app-on-k8s)。
仓库创建完成即可上传应用到平台进一步测试和部署应用到 Kubernetes 运行环境中,可参考 [开发者 - 上传应用](../getting-start/developer-quick-start/#第二步:上传应用)。部署 Helm Chart 类型的应用(如本篇提到的 nginx)到 Kubernetes 运行环境,参见 [部署 Nginx 到 Kubernetes](../user-guide/deploying-app-on-k8s)。



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,5 +310,5 @@ $ ls
Wordpress Wordpress-0.1.0.tgz
```

打包后,可以看到将生成一个 Wordpress-0.1.0.tgz 配置包,然后将该配置包上传到 OpenPitrix 平台,参见 [开发者 - 上传应用](../../getting-start/developer-quick-start/#第二步:上传应用)。
打包后,可以看到将生成一个 Wordpress-0.1.0.tgz 配置包,然后将该配置包上传到 OpenPitrix 平台,参见 [开发者 - 上传应用](../getting-start/developer-quick-start/#第二步:上传应用)。

4 changes: 2 additions & 2 deletions docs/v0.3/zh-CN/developer-guide/packaging-openpitrix-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ index.yaml test test-0.1.0.tgz

至此,应用配置包就已经准备完毕,接下来需要创建仓库和上传应用。

仓库可以是 QingCloud 或 AWS 的对象存储,创建仓库可参考 [仓库管理](../../user-guide/repo-management)。
仓库可以是 QingCloud 或 AWS 的对象存储,创建仓库可参考 [仓库管理](../user-guide/repo-management)。

仓库创建完成即可上传应用到平台进一步测试和部署应用,可参考 [开发者 - 上传应用](../../getting-start/developer-quick-start/#第二步:上传应用)。
仓库创建完成即可上传应用到平台进一步测试和部署应用,可参考 [开发者 - 上传应用](../getting-start/developer-quick-start/#第二步:上传应用)。



Expand Down
6 changes: 3 additions & 3 deletions docs/v0.3/zh-CN/getting-start/admin-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ title: "管理员"

管理员可对上传的应用部署和测试,若点击右下角 **通过**,开发者即可将应用发布到应用商店,若点击 **拒绝** 则开发者需要调整后重新提交审核。

> 同时,为了更好地管理应用,OpenPitrix 为管理员提供应用的分类管理功能,这样普通用户可以在应用商店中可根据分类来查看各类应用,如 Database,BigData,Container 等等,新创建的应用默认在 “未分类” 下。仅管理员能够创建应用分类,并将应用添加到分类中。参见 [分类管理](../../user-guide/category-management) 将应用添加到新建的分类中。
> 同时,为了更好地管理应用,OpenPitrix 为管理员提供应用的分类管理功能,这样普通用户可以在应用商店中可根据分类来查看各类应用,如 Database,BigData,Container 等等,新创建的应用默认在 “未分类” 下。仅管理员能够创建应用分类,并将应用添加到分类中。参见 [分类管理](../user-guide/category-management) 将应用添加到新建的分类中。

![审核详情页面](/app-review-page.png)

> 管理员有权限下架应用,参见 [应用管理 - 下架应用](../../user-guide/app-management/#下架应用)。
> 管理员有权限下架应用,参见 [应用管理 - 下架应用](../user-guide/app-management/#下架应用)。

管理员通过应用审核之后,开发者即可 [发布应用](../developer-quick-start/#发布应用) 到应用商店,普通用户可在应用商店浏览应用和部署应用到多云的运行环境,如 Kubernetes、QingCloud、AWS 等运行环境,参考下一篇快速入门之 [普通用户](../regular-user-quick-start)。
管理员通过应用审核之后,开发者即可 [发布应用](../getting-start/developer-quick-start/#发布应用) 到应用商店,普通用户可在应用商店浏览应用和部署应用到多云的运行环境,如 Kubernetes、QingCloud、AWS 等运行环境,参考下一篇快速入门之 [普通用户](../getting-start/regular-user-quick-start)。
16 changes: 8 additions & 8 deletions docs/v0.3/zh-CN/getting-start/developer-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: "开发者"
---

OpenPitrix 旨在帮助软件开发者以极低的学习成本快速部署自己的应用到多云的运行环境中并提供一站式的平台方便管理用户的资源和环境,如果您开发基于 OpenPitrix 平台的应用,那么本篇文档可以帮助您快速开始相关的基础功能操作,主要描述了开发者创建仓库、创建应用和上传应用、提交审核、发布应用等工作流程,流程中的相关文档链接页涵盖了更详细的内容介绍。完成本篇操作后建议您继续阅读 [管理员](../admin-quick-start) 和 [普通用户](../regular-user-quick-start) 的快速入门。
OpenPitrix 旨在帮助软件开发者以极低的学习成本快速部署自己的应用到多云的运行环境中并提供一站式的平台方便管理用户的资源和环境,如果您开发基于 OpenPitrix 平台的应用,那么本篇文档可以帮助您快速开始相关的基础功能操作,主要描述了开发者创建仓库、创建应用和上传应用、提交审核、发布应用等工作流程,流程中的相关文档链接页涵盖了更详细的内容介绍。完成本篇操作后建议您继续阅读 [管理员](../getting-start/admin-quick-start) 和 [普通用户](../getting-start/regular-user-quick-start) 的快速入门。

## 创建仓库

应用仓库目前支持创建基于 QingStor 和 基于 S3 协议如 AWS 的对象存储,以及基于 HTTP/S 协议的仓库 (只读,详情见下文),对象存储用来存放配置包和索引文件。以创建基于 QingStor 对象存储的仓库为例,若创建基于 AWS S3 对象存储及仓库管理参见 [仓库管理](../../user-guide/repo-management)。
应用仓库目前支持创建基于 QingStor 和 基于 S3 协议如 AWS 的对象存储,以及基于 HTTP/S 协议的仓库 (只读,详情见下文),对象存储用来存放配置包和索引文件。以创建基于 QingStor 对象存储的仓库为例,若创建基于 AWS S3 对象存储及仓库管理参见 [仓库管理](../user-guide/repo-management)。

### 第一步:登录 QingCloud 控制台

Expand Down Expand Up @@ -46,16 +46,16 @@ OpenPitrix 旨在帮助软件开发者以极低的学习成本快速部署自己

1、以开发者的身份登录 OpenPitrix 控制台,在菜单栏选择 **仓库**,然后点击 **创建仓库**。

2、填写配置信息。创建完成后,对象存储中存储的应用配置包会被自动索引成为可部署的应用,关于各项配置的更多解释参见 [创建仓库](../../user-guide/repo-management/#第四步:创建仓库)。
2、填写配置信息。创建完成后,对象存储中存储的应用配置包会被自动索引成为可部署的应用,关于各项配置的更多解释参见 [创建仓库](../user-guide/repo-management/#第四步:创建仓库)。

- 运行环境服务商:可以多选,此处勾选 QingCloud 和 AWS (后续会提供更多的服务商支持)。其中 Kubernetes 与 QingCloud 和 AWS 环境的应用配置包格式不同,若选择 QingCloud 和 AWS,意味着当前仓库仅支持上传基于 [OpenPitrix 应用开发规范](../../developer-guide/openpitrix-specification) 的应用,既可以部署到 QingCloud,也可以部署到 AWS。若选择 Kubernetes 则表示当前仓库仅支持上传基于 [Helm Chart 应用开发规范](../../developer-guide/helm-specification) 的应用配置包,且只能部署到 Kubernetes 环境。
- 运行环境服务商:可以多选,此处勾选 QingCloud 和 AWS (后续会提供更多的服务商支持)。其中 Kubernetes 与 QingCloud 和 AWS 环境的应用配置包格式不同,若选择 QingCloud 和 AWS,意味着当前仓库仅支持上传基于 [OpenPitrix 应用开发规范](../developer-guide/openpitrix-specification) 的应用,既可以部署到 QingCloud,也可以部署到 AWS。若选择 Kubernetes 则表示当前仓库仅支持上传基于 [Helm Chart 应用开发规范](../developer-guide/helm-specification) 的应用配置包,且只能部署到 Kubernetes 环境。

- URL:若需要在 OpenPitrix 上传应用到仓库,则该仓库需要基于 S3 协议的对象存储。由于 QingStor 兼容 S3 协议,只需请求地址满足 S3 风格 `s3://s3.<region>.qingstor.com/<bucket_name>` 即可使用 AWS S3 接口访问 QingStor 服务。因此选择 S3 协议,然后填写 `s3://s3.sh1a.qingstor.com/my-openpitrix`,这只是一个示例仓库,URL 填写实际的对象存储地址。Access Key ID 和 Secret Access Key 请参考 [获取 Access Key](https://docs.qingcloud.com/qingstor/api/common/signature.html#%E8%8E%B7%E5%8F%96-access-key),填写后点击 `Validate` 按钮可以检查配置是否有效。以下分别说明每种协议的场景:

- S3:参数形式为 `s3://s3.<region>.qingstor.com/<bucket_name>`。可读可写,支持获取该应用仓库中的应用并能够部署到运行环境,这类协议的仓库支持在 OpenPitrix 中上传应用。
- HTTP/HTTPS:可读,不可写,仅支持获取该应用仓库中的应用并能够部署到运行环境,但不支持在 OpenPitrix 上传应用到这类仓库。

> 注意:若添加 HTTP 或 HTTPS 协议的仓库,在对象存储中需要预先上传索引文件 `index.yaml`,该文件由 [OpenPitrix 客户端工具](../../developer-guide/packaging-openpitrix-app/#准备-openpitrix-客户端工具) 或 [Helm 客户端工具](../../developer-guide/helm-developer-guide/#准备-helm-客户端工具) 生成。若添加 S3 协议的仓库,在上传应用到仓库时将自动在对象存储中生成索引文件。如果是在 QingStor 中上传的应用配置包,其应用将自动同步到 OpenPitrix 的仓库中。
> 注意:若添加 HTTP 或 HTTPS 协议的仓库,在对象存储中需要预先上传索引文件 `index.yaml`,该文件由 [OpenPitrix 客户端工具](../developer-guide/packaging-openpitrix-app/#准备-openpitrix-客户端工具) 或 [Helm 客户端工具](../developer-guide/helm-developer-guide/#准备-helm-客户端工具) 生成。若添加 S3 协议的仓库,在上传应用到仓库时将自动在对象存储中生成索引文件。如果是在 QingStor 中上传的应用配置包,其应用将自动同步到 OpenPitrix 的仓库中。

![创建应用仓库](/create-repo-vmbased.png)

Expand All @@ -64,9 +64,9 @@ OpenPitrix 旨在帮助软件开发者以极低的学习成本快速部署自己

### 第一步:准备应用配置包

为方便您快速熟悉 OpenPitrix,本示例准备了一个基于 [OpenPitrix 开发规范](../../developer-guide/openpitrix-specification) 的 [WordPress](https://wordpress.org) 的应用配置包,且已准备好 Wordpress 与 MySQL 镜像并上传到了 Docker 镜像仓库,点击 [下载 Wordpress 应用配置包](https://openpitrix.anybox.qingcloud.com/s/9iNpm77Z2RAOQFUQBSv1luQEHvWTEGdY),选择 VM Package 文件夹下的 `Wordpress-0.1.0.tgz` 配置包。
为方便您快速熟悉 OpenPitrix,本示例准备了一个基于 [OpenPitrix 开发规范](../developer-guide/openpitrix-specification) 的 [WordPress](https://wordpress.org) 的应用配置包,且已准备好 Wordpress 与 MySQL 镜像并上传到了 Docker 镜像仓库,点击 [下载 Wordpress 应用配置包](https://openpitrix.anybox.qingcloud.com/s/9iNpm77Z2RAOQFUQBSv1luQEHvWTEGdY),选择 VM Package 文件夹下的 `Wordpress-0.1.0.tgz` 配置包。

> 同样,也可参考 [OpenPitrix 规范及应用开发 - 准备 Wordpress 配置文件](../../developer-guide/openpitrix-developer-guide/#准备应用配置包) 的三个必须的配置文件,然后获取 [OpenPitrix 客户端工具](../../developer-guide/packaging-openpitrix-app/#准备-openpitrix-客户端工具) 将配置文件打包 (默认为 `.tgz` 格式),即可生成一个 Wordpress 应用配置包。注意,基于 OpenPitrix 开发规范准备的应用可以部署到 QingCloud、AWS 这类云运行时环境 (Runtime),若要部署到 Kubernetes 运行环境则需要基于 [Helm Chart 开发规范](../../developer-guide/helm-specification) 来准备应用配置包,或下载 Helm Chart Package 文件夹下的 [wordpress-0.3.0.tar](https://openpitrix.anybox.qingcloud.com/s/9iNpm77Z2RAOQFUQBSv1luQEHvWTEGdY)。参见 [部署 Wordpress 到 Kubernetes](../../user-guide/deploying-app-on-k8s)。
> 同样,也可参考 [OpenPitrix 规范及应用开发 - 准备 Wordpress 配置文件](../developer-guide/openpitrix-developer-guide/#准备应用配置包) 的三个必须的配置文件,然后获取 [OpenPitrix 客户端工具](../developer-guide/packaging-openpitrix-app/#准备-openpitrix-客户端工具) 将配置文件打包 (默认为 `.tgz` 格式),即可生成一个 Wordpress 应用配置包。注意,基于 OpenPitrix 开发规范准备的应用可以部署到 QingCloud、AWS 这类云运行时环境 (Runtime),若要部署到 Kubernetes 运行环境则需要基于 [Helm Chart 开发规范](../developer-guide/helm-specification) 来准备应用配置包,或下载 Helm Chart Package 文件夹下的 [wordpress-0.3.0.tar](https://openpitrix.anybox.qingcloud.com/s/9iNpm77Z2RAOQFUQBSv1luQEHvWTEGdY)。参见 [部署 Wordpress 到 Kubernetes](../user-guide/deploying-app-on-k8s)。


### 第二步:上传应用
Expand Down Expand Up @@ -106,4 +106,4 @@ OpenPitrix 旨在帮助软件开发者以极低的学习成本快速部署自己

![应用详情页](/zk-details.png)

至此,您已经基本了解了开发者在 OpenPitrix 平台上传和发布应用的基本工作流程,若需要对当前的应用版本做升级,可创建新的应用版本,参见 [应用版本管理](../../user-guide/app-management/#应用版本管理)。建议您继续阅读快速入门之 [管理员](../admin-quick-start) 和 [普通用户](../regular-user-quick-start)。
至此,您已经基本了解了开发者在 OpenPitrix 平台上传和发布应用的基本工作流程,若需要对当前的应用版本做升级,可创建新的应用版本,参见 [应用版本管理](../user-guide/app-management/#应用版本管理)。建议您继续阅读快速入门之 [管理员](../getting-start/admin-quick-start) 和 [普通用户](../getting-start/regular-user-quick-start)。
Loading