fix(README): simplify content and remove deadlinks

This commit is contained in:
Zexi Li
2024-01-09 12:37:36 +08:00
parent 95b02b3da4
commit 4b599f33be
4 changed files with 15 additions and 399 deletions

View File

@@ -18,7 +18,7 @@ You may answer issues at Github and help those who encounter issues when using C
## Contribute codes
You are welcome to contribute codes to Cloudpods. Please refers to [CONTRIBUTING](https://www.cloudpods.org/en/docs/contribute/contrib/) for more details on how to contribute codes to Cloudpods.
You are welcome to contribute codes to Cloudpods. Please refers to [CONTRIBUTING](https://www.cloudpods.org/en/docs/development/contrib/) for more details on how to contribute codes to Cloudpods.
### Fix Issues
@@ -29,8 +29,8 @@ You may help solve bugs by submiting patches.
You may help improve the codes of Cloudpods, including:
* Develop new features for Cloudpods
* Recode some part of Cloudpods so as to make the code easier to be understood, or less error-prone, or more efficient
* Develop new [features for Cloudpods](https://github.com/yunionio/cloudpods/issues?q=is%3Aopen+is%3Aissue+label%3Afeature).
* Recode some part of Cloudpods so as to make the code easier to be understood, or less error-prone, or more efficient.
## Documentation

View File

@@ -18,7 +18,7 @@ Cloudpods是一款开源的基础设施管理工具软件运行场景复杂
## 贡献代码
我们非常欢迎和感谢开发者向项目提交代码PR流程细节请查看 [CONTRIBUTING](https://www.cloudpods.org/zh/docs/development/contrib/).
我们非常欢迎和感谢开发者向项目提交代码PR流程细节请查看 [CONTRIBUTING](https://www.cloudpods.org/docs/development/contrib/).
### 修复BUG
@@ -27,8 +27,8 @@ Cloudpods是一款开源的基础设施管理工具软件运行场景复杂
### 开发新的功能特性
不仅仅是修复BUG您也可以通过提交代码以改进Cloudpods包括但不限于
* 开发新的功能特性,您可以在[Cloudpods Roadmap](https://www.cloudpods.org/zh/docs/roadmap/)找到Cloudpods的功能规划
* 重构代码,使得代码更加简洁易读,更加低健壮,或者执行起来更加高效
* 开发新的功能特性,您可以在[feature issues](https://github.com/yunionio/cloudpods/issues?q=is%3Aopen+is%3Aissue+label%3Afeature)查找需要的功能
* 重构代码,使得代码更加简洁易读,更加低健壮,或者执行起来更加高效
## 文档

View File

@@ -6,7 +6,7 @@
## Cloudpods是什么?
<img src="https://www.cloudpods.org/images/cloudpods_logo_green.png" alt="Cloudpods" height="100">
<img src="https://v1.cloudpods.org/images/cloudpods_logo_green.png" alt="Cloudpods" height="100">
Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的云平台也就是一个“云上之云”。Cloudpods不仅可以管理本地的虚拟机和物理机资源还可以管理多个云平台和云账号。Cloudpods隐藏了这些异构基础设施资源的数据模型和API的差异对外暴露了一套统一的API允许用户就像用一个云一样地访问多云。从而大大降低了访问多云的复杂度提升了管理多云的效率。
@@ -21,186 +21,7 @@ Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的
## 功能
### 概览 & UI 展示
![](https://www.cloudpods.org/zh/docs/introduce/images/interface1.gif)
<details>
<summary>管理多云资源的功能可以管理大多数的主流云包括私有云例如OpenStack以及公有云例如AWSAzureGCP阿里云华为云和腾讯云等</summary>
<ul>
<li>
<p>云帐号纳管</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/cloudselect.png" alt="multi cloud management">
</li>
<li>
<p>云帐号列表</p>
<img src="https://i.imgur.com/Q0LipfI.png" alt="cloud account list">
</li>
<li>
<p>公有云虚拟机列表</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/publicvmlist.png">
</li>
</ul>
</details>
<details>
<summary>
一个可以管理海量KVM虚拟机的轻量级私有云
</summary>
<ul>
<li>
<p>虚拟机列表</p>
<img src="https://i.imgur.com/DbkRUoo.png">
</li>
<li>
<p>虚拟机创建页面</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createkvmvm1.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/createkvmvm2.png">
</li>
<li>
<p>虚拟机可通过 VNC 或者 SSH 登录</p>
<img src="https://i.imgur.com/m0rkeQ3.png">
</li>
<li>
<p>宿主机列表</p>
<img src="https://imgur.com/i509t5a.png">
</li>
<li>
<p>镜像模板列表</p>
<img src="https://imgur.com/UVFLGi2.png">
</li>
<li>
<p>VPC列表</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vpclist.png">
</li>
<li>
<p>二层网络列表(经典网络)</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/wirelist.png">
</li>
<li>
<p>IP子网列表</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/ipsubnetlist.png">
</li>
<li>
<p>弹性公网IP列表VPC网络</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vpclist.png">
</li>
<li>
<p>LB列表</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/lblist.png">
</li>
</ul>
</details>
<details>
<summary>
一个能进行物理机全生命周期管理的裸机云
</summary>
<ul>
<li>
<p>物理机列表</p>
<img src="https://i.imgur.com/Jz8b5nC.png">
</li>
<li>
<p>物理机纳管</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/addphysicalmachine.png">
</li>
<li>
<p>安装操作系统</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createbaremetal.png">
</li>
<li>支持 ARM64 的物理机服务器</li>
</ul>
</details>
<details>
<summary>一套完整的多租户认证和访问控制体系</summary>
<ul>
<li>
<p>支持本地sql、LDAP 等认证源</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/idplist.png">
</li>
<li>
<p>多租户系统,包括域,项目,组,用户,角色和权限等</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/domainlist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/projectlist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/grouplist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/userlist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/rolelist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/policylist.png">
</li>
</ul>
</details>
<details>
<summary>
实现了VMware vSphere虚拟化集群的自助服务和自动化
</summary>
<ul>
<li>
<p>添加VMware云账号</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createvmware.png">
</li>
<li>
<p>VMware云账号列表</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vmwarelist.png">
</li>
<li>
<p>自动创建二层网络</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vmwarewirelist.png">
</li>
<li>
<p>自动创建IP子网</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vmwareipsubnetlist.png">
</li>
<li>
<p>新建VMware虚拟机</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createvmwarevm1.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/createvmwarevm2.png">
</li>
</ul>
</details>
<details>
<summary>
允许以统一的联邦身份访问各个云平台的原生控制台的SSO
</summary>
<ul>
<li>
<p>为云账号开启免密登录(以阿里云为例)</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/enablecloudsso.png">
</li>
<li>
<p>将Cloudpods平台用户添加为免密登录用户</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/addsamluser.png">
</li>
<li>
<p>多云统一登录入口</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/cloudssoentry.png">
</li>
<li>
<p>多云统一登录-免密登录用户列表</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/cloudsamluser.png">
</li>
<li>
<p>Cloudpods平台用户免密登录阿里云</p>
</li>
</ul>
</details>
<details>
<summary>
一套功能丰富、统一一致的RESTAPI和模型访问以上的云资源和功能
</summary>
</details>
<details>
<summary>
自动将镜像转换为不同云平台需要的格式的多云镜像服务
</summary>
</details>
请访问[产品介绍](https://www.cloudpods.org/docs/introduction/)页面了解详细信息。
### 支持的云平台
@@ -258,23 +79,11 @@ Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的
## 联系我们
您可以通过如下方式联系我们:
* 企业级支持: [服务订阅](https://www.yunion.cn/subscription/index.html)
* 微信: 请扫描如下二维码联系我们
<img src="https://www.cloudpods.org/images/contact_me_qr_20230321.png" alt="WeChat QRCode">
* 哔哩哔哩: [Cloudpods](https://space.bilibili.com/3493131737631540/)
请访问[联系我们](https://www.cloudpods.org/docs/contact/)。
## 版本历史
请访问[Cloudpods Changelog](https://www.cloudpods.org/zh/docs/changelog/).
## 开发规划
请访问[Cloudpods Roadmap](https://www.cloudpods.org/zh/docs/roadmap/).
请访问[Cloudpods Changelog](https://www.cloudpods.org/zh/docs/changelog/)
## 贡献
@@ -282,4 +91,4 @@ Cloudpods是一个开源的Golang实现的云原生的融合多云/混合云的
## License
Apache license 2.0,详情请看 [LICENSE](./LICENSE)。
Apache license 2.0,详情请看 [LICENSE](./LICENSE)。

201
README.md
View File

@@ -8,7 +8,7 @@
## What is Cloudpods?
<img src="https://www.cloudpods.org/images/cloudpods_logo_green.png" alt="Cloudpods" height="100">
<img src="https://v1.cloudpods.org/images/cloudpods_logo_green.png" alt="Cloudpods" height="100">
Cloudpods is a cloud-native open source unified multi/hybrid-cloud platform developed with Golang, i.e. Cloudpods is *a cloud on clouds*. Cloudpods is able to manage not only on-premise KVM/baremetals, but also resources from many cloud accounts across many cloud providers. It hides the differences of underlying cloud providers and exposes one set of APIs that allow programatically interacting with these many clouds.
@@ -23,188 +23,7 @@ Cloudpods is a cloud-native open source unified multi/hybrid-cloud platform deve
## Features
### Summary & UI
![](https://www.cloudpods.org/zh/docs/introduce/images/interface1.gif)
<details>
<summary>
Multi-cloud management that is able to manage a wide range of cloud providers, including private cloud, such as OpenStack, and public clouds, such as AWS, Azure, Google Cloud, Alibaba Cloud, Tencent Cloud, Huawei Cloud, etc.
</summary>
<ul>
<li>
<p>Cloud account create form</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/cloudselect.png" alt="multi cloud management">
</li>
<li>
<p>Cloud accounts list</p>
<img src="https://i.imgur.com/Q0LipfI.png" alt="cloud account list">
</li>
<li>
<p>Multi public cloud VM list</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/publicvmlist.png">
</li>
</ul>
</details>
<details>
<summary>
A light-weight private cloud that manages KVM hypervisor in scale
</summary>
<ul>
<li>
<p>VM instances list</p>
<img src="https://i.imgur.com/DbkRUoo.png">
</li>
<li>
<p>Create VM instance form</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createkvmvm1.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/createkvmvm2.png">
</li>
<li>
<p>VNC and SSH login page</p>
<img src="https://i.imgur.com/m0rkeQ3.png">
</li>
<li>
<p>Host list</p>
<img src="https://imgur.com/i509t5a.png">
</li>
<li>
<p>Image template list</p>
<img src="https://imgur.com/UVFLGi2.png">
</li>
<li>
<p>VPC list</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vpclist.png">
</li>
<li>
<p>Wire list (Classic Network)</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/wirelist.png">
</li>
<li>
<p>IPsubnet list</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/ipsubnetlist.png">
</li>
<li>
<p>Eip list (VPC Network)</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vpclist.png">
</li>
<li>
<p>LB list</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/lblist.png">
</li>
</ul>
</details>
<details>
<summary>
A BareMetal cloud that automates the full life-cycle management of baremetal physical machines
</summary>
<ul>
<li>
<p>BareMetal list</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/physicalmachinelist.png">
</li>
<li>
<p>Baremetal Management</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/addphysicalmachine.png">
</li>
<li>
<p>Create OS on BareMetal</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createbaremetal.png">
</li>
<li>ARM64 baremetal supported</li>
</ul>
</details>
<details>
<summary>
A complete multi-tenancy RBAC-enabled IAM (identity and access management) system
</summary>
<ul>
<li>
<p>sql, LDAP supported</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/idplist.png">
</li>
<li>
<p>Multi-tenancy system, include domain, project, group, user, role, policy</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/domainlist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/projectlist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/grouplist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/userlist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/rolelist.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/policylist.png">
</ul>
</details>
<details>
<summary>
VMware vSphere management that enables self-service and automation
</summary>
<ul>
<li>
<p>Add VMware account</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createvmware.png">
</li>
<li>
<p>VMware account list</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vmwarelist.png">
</li>
<li>
<p>Automatic creation of wire</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vmwarewirelist.png">
</li>
<li>
<p>Automatic creation of ipsubnet</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/vmwareipsubnetlist.png">
</li>
<li>
<p>Create a VMware VM instance</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/createvmwarevm1.png">
<img src="https://www.cloudpods.org/zh/docs/practice/images/createvmwarevm2.png">
</li>
</ul>
</details>
<details>
<summary>
Cloud SSO that allows accessing native webconsole of cloud providers with unified federated identities
</summary>
<ul>
<li>
<p>Enable the SSO login function of the cloud account (aliyun as an example)</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/enablecloudsso.png">
</li>
<li>
<p>create saml users</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/addsamluser.png">
</li>
<li>
<p>Cloud SSO entry</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/cloudssoentry.png">
</li>
<li>
<p>Cloud SSO - SSO login user</p>
<img src="https://www.cloudpods.org/zh/docs/practice/images/cloudsamluser.png">
</li>
<li>
<p>Sign in to the public cloud platform with SSO</p>
</li>
</ul>
</details>
<details>
<summary>
One set of feature-rich APIs to access a wide range of resources from cloud providers above with consistent models and APIs
</summary>
</details>
<details>
<summary>
Multi-cloud image management system that automates image conversion between different cloud providers
</summary>
</details>
See [Introduction](https://www.cloudpods.org/docs/introduction/) for details.
### Supported cloud providers
@@ -263,28 +82,16 @@ Please check this [issue](https://github.com/yunionio/cloudpods/issues/11427) fo
## Contact
You may contact us by:
* Enterprise Support: [Subscription](https://www.yunion.cn/subscription/index.html)
* WeChat: please scan the following QRCode to contact us
<img src="https://www.cloudpods.org/images/contact_me_qr_20230321.png" alt="WeChat QRCode">
* Bilibili: [Cloudpods](https://space.bilibili.com/3493131737631540/)
See [Contact Us](https://www.cloudpods.org/en/docs/contact/) for details.
## Changelog
See [Cloudpods Changelog](https://www.cloudpods.org/en/docs/changelog/) for details.
## Roadmap
See [Cloudpods Roadmap](https://www.cloudpods.org/en/docs/roadmap/) for details.
## Contribution
You are welcome to do any kind of contribution to the project. Please refer to [CONTRIBUTING](./CONTRIBUTING.md) for guidelines.
## License
Apache License 2.0. See [LICENSE](./LICENSE).
Apache License 2.0. See [LICENSE](./LICENSE).