mirror of
https://hubproxy.babadafafafafa.cn/https://github.com/yunionio/cloudpods.git
synced 2026-09-20 08:03:53 +08:00
fix: improve readme
This commit is contained in:
Qiu Jian
37
README-CN.md
37
README-CN.md
@@ -1,30 +1,31 @@
|
||||
# Cloudpods
|
||||
|
||||
[](https://circleci.com/gh/yunionio/cloudpods)
|
||||
[](https://travis-ci.org/yunionio/cloudpods)
|
||||
[](https://goreportcard.com/report/github.com/yunionio/cloudpods)
|
||||
[](https://circleci.com/gh/yunionio/cloudpods)
|
||||
[](https://travis-ci.org/yunionio/cloudpods)
|
||||
[](https://goreportcard.com/report/github.com/yunionio/cloudpods)
|
||||
|
||||
## Cloudpods是什么?
|
||||
|
||||
Cloudpods是一个开源的Golang实现的云原生融合多云/混合云的云平台。Cloudpods可以理解为pod(豆荚) of clouds，有多云管理的寓意。Cloupods可以管理多个云平台和云账号。并且，Cloudpods隐藏了这些平台和账号之间的云资源的数据模型和API的差异，对外暴露了一套统一的API。从而大大降低了访问多云的复杂度，提升了管理多云资源的效率。
|
||||
Cloudpods是一个开源的Golang实现的云原生融合多云/混合云的云平台。Cloudpods可以理解为pod(豆荚) of clouds。Cloupods可以管理多个云平台和云账号。并且，Cloudpods隐藏了这些平台和账号之间的云资源的数据模型和API的差异，对外暴露了一套统一的API。从而大大降低了访问多云的复杂度，提升了管理多云资源的效率。
|
||||
|
||||
## 功能
|
||||
|
||||
Cloudpods提供了如下的功能：
|
||||
|
||||
* 管理多云资源的功能，可以管理大多数的主流云，包括私有云，例如OpenStack，以及公有云，例如AWS，Azure，GCP，阿里云，华为云和腾讯云等
|
||||
* 允许以统一的联邦身份访问各个云平台的原生控制台的SSO
|
||||
* 一个可以管理海量KVM虚拟机的轻量级私有云
|
||||
* 一个能进行物理机全生命周期管理的裸机云
|
||||
* 实现了VMware vSphere虚拟化集群的自助服务和自动化
|
||||
* 管理多云资源的功能，可以管理大多数的主流云，包括私有云，例如OpenStack，以及公有云，例如AWS，Azure，GCP，阿里云，华为云和腾讯云等
|
||||
* 提供一组统一的功能丰富的REST API访问以上的云资源
|
||||
* 一套功能丰富、统一一致的RESTAPI和模型访问以上的云资源和功能
|
||||
* 一套完整的多租户认证和访问控制体系
|
||||
* 多云镜像管理自动将镜像转换为不同云平台需要的格式
|
||||
* 自动将镜像转换为不同云平台需要的格式的多云镜像服务
|
||||
|
||||
## 安装
|
||||
|
||||
我们可以通过以下简单三步将Cloudpods安装在一台至少8GiB内存和100GB硬盘的Linux主机上：
|
||||
我们可以通过以下简单三步将Cloudpods安装在一台至少8GiB内存和100GB硬盘的Linux主机上（假设该主机的IP为 *10.168.26.216*）：
|
||||
|
||||
### 准备SSH免密登录
|
||||
### 1. 准备SSH免密登录
|
||||
|
||||
```bash
|
||||
# Generate the local ssh keypair
|
||||
@@ -38,7 +39,7 @@ $ ssh-copy-id -i ~/.ssh/id_rsa.pub root@10.168.26.216
|
||||
$ ssh root@10.168.26.216 "hostname"
|
||||
```
|
||||
|
||||
### 安装ansible和git
|
||||
### 2. 安装ansible和git
|
||||
|
||||
#### CentOS
|
||||
```bash
|
||||
@@ -51,38 +52,38 @@ $ yum install -y epel-release ansible git
|
||||
$ apt install -y ansible git
|
||||
```
|
||||
|
||||
### 安装cloudpods
|
||||
### 3. 安装Cloudpods
|
||||
|
||||
请将脚本中的<host_ip>替换为该Linux主机的主IP地址。
|
||||
通过以下命令开始安装Cloudpods：
|
||||
|
||||
```bash
|
||||
# Git clone the ocboot installation tool locally
|
||||
$ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py <host_ip>
|
||||
$ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py 10.168.26.216
|
||||
```
|
||||
|
||||
大概10-30分钟后，安装完成。访问https://<host_ip>登入Cloudpods的Web控制台。初始的账号和密码为：admin/admin@123
|
||||
大概10-30分钟后，安装完成。访问 https://10.168.26.216 登入Cloudpods的Web控制台。初始的账号为 *admin* ，密码为 *admin@123*
|
||||
|
||||
请参考文档 [快速开始](https://docs.yunion.io/zh/docs/quickstart/) 获得更详细的安装指导。
|
||||
|
||||
|
||||
## 文档
|
||||
|
||||
- [文档中心](https://docs.yunion.io/zh)
|
||||
- [Cloudpods文档](https://docs.yunion.io/zh)
|
||||
|
||||
- [Swagger API文档](https://docs.yunion.cn/api/)
|
||||
|
||||
|
||||
## 规划
|
||||
## 开发计划
|
||||
|
||||
请访问[Cloudpods Roadmap](https://docs.yunion.io/zh/docs/roadmap/).
|
||||
|
||||
|
||||
## 贡献
|
||||
|
||||
我们非常欢迎和感谢开发者向项目做贡献，流程细节请查看 [CONTRIBUTING.md](./CONTRIBUTING.md) 。
|
||||
我们非常欢迎和感谢开发者向项目做贡献，流程细节请查看 [CONTRIBUTING](https://docs.yunion.io/zh/docs/contribute/contrib/) 。
|
||||
|
||||
|
||||
## License
|
||||
|
||||
Cloudpods 使用 Apache license 2.0. 详情请看 [LICENSE](./LICENSE) 。
|
||||
Apache license 2.0，详情请看 [LICENSE](./LICENSE)。
|
||||
|
||||
|
||||
36
README.md
36
README.md
@@ -1,30 +1,31 @@
|
||||
## Cloudpods
|
||||
|
||||
[](https://circleci.com/gh/yunionio/cloudpods)
|
||||
[](https://travis-ci.com/yunionio/cloudpods/branches)
|
||||
[](https://goreportcard.com/report/github.com/yunionio/cloudpods)
|
||||
[](https://circleci.com/gh/yunionio/cloudpods)
|
||||
[](https://travis-ci.com/yunionio/cloudpods/branches)
|
||||
[](https://goreportcard.com/report/github.com/yunionio/cloudpods)
|
||||
|
||||
[English](./README.md) | [简体中文](./README-CN.md)
|
||||
|
||||
## What is Cloudpods?
|
||||
|
||||
Cloudpods is an cloud-native open source unified multicloud/hybrid-cloud cloud platform developed with Golang. As the name implies, cloudpods manages the resources from many cloud accounts across many cloud providers. Further, it hides the differences of underlying technologies and exposes one set of APIs that allow programatically interacting with the resources across many clouds.
|
||||
Cloudpods is an cloud-native open source unified multicloud/hybrid-cloud cloud platform developed with Golang. As the name implies, Cloudpods manages the resources from many cloud accounts across many cloud providers. Further, it hides the differences of underlying cloud providers and exposes one set of APIs that allow programatically interacting with the resources across many clouds.
|
||||
|
||||
## Features
|
||||
|
||||
* 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.
|
||||
* Cloud SSO that allows accessing native webconsole of cloud providers with unified federated identities
|
||||
* A light-weight private cloud that manages KVM hypervisor in scale
|
||||
* A BareMetal cloud that automates the full life-cycle management of baremetal physical machines
|
||||
* VMware vSphere management that enables self-service and automation
|
||||
* A multi-cloud management that is able to manage a wide range of major cloud providers, including private cloud, such as OpenStack, and public clouds, such as AWS, Azure, Google Cloud, Alibaba Cloud, Tencent Cloud, Huawei Cloud, etc.
|
||||
* One set of feature-rich APIs to access a wide range of the IaaS resources from platforms above with consistent resource models and APIs
|
||||
* A multi-tenancy RBAC-enabled identity and access management system
|
||||
* A multi-cloud image management system that automates image conversion between different cloud providers
|
||||
* One set of feature-rich APIs to access a wide range of resources from cloud providers above with consistent models and APIs
|
||||
* A complete multi-tenancy RBAC-enabled IAM (identity and access management) system
|
||||
* Multi-cloud image management system that automates image conversion between different cloud providers
|
||||
|
||||
## Installation
|
||||
|
||||
You may install Cloudpods into a Linux box with at least 8GiB RAM and 100GB storage with the following three simple steps:
|
||||
You may install Cloudpods into a Linux box with at least 8GiB RAM and 100GB storage by following three simple steps (assuming that you install Cloudpods on a Linux box with IP *10.168.26.216*):
|
||||
|
||||
### Prepare passwordless SSH login
|
||||
### 1. Prepare passwordless SSH login
|
||||
|
||||
```bash
|
||||
# Generate the local ssh keypair
|
||||
@@ -39,7 +40,7 @@ $ ssh-copy-id -i ~/.ssh/id_rsa.pub root@10.168.26.216
|
||||
# without entering the login password
|
||||
$ ssh root@10.168.26.216 "hostname"
|
||||
```
|
||||
### Install ansible and git
|
||||
### 2. Install ansible and git
|
||||
|
||||
#### For CentOS
|
||||
```bash
|
||||
@@ -52,22 +53,22 @@ $ yum install -y epel-release ansible git
|
||||
$ apt install -y ansible git
|
||||
```
|
||||
|
||||
### Install cloudpods
|
||||
### 3. Install Cloudpods
|
||||
|
||||
Please replace <host_ip> with the master IP address of the linux box.
|
||||
Run the following commands to start installing Cloudpods.
|
||||
|
||||
```bash
|
||||
# Git clone the ocboot installation tool locally
|
||||
$ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py <host_ip>
|
||||
$ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py 10.168.26.216
|
||||
```
|
||||
|
||||
It takes 10-30 minutes to wait the installation complete. You may visit the Cloudpods webconsole at https://<host_ip>. The initial login account and password is admin and admin@123.
|
||||
It takes 10-30 minutes to finish the installation. You may visit the webconsole of Cloudpods at https://10.168.26.216. The initial login account is *admin* and password is *admin@123*.
|
||||
|
||||
For more detailed instructions, please refers to [quick start](https://docs.yunion.io/en/docs/quickstart/).
|
||||
|
||||
## Documentations
|
||||
|
||||
- [Yunion Cloud Documents](https://docs.yunion.io/en)
|
||||
- [Cloudpods Documents](https://docs.yunion.io/en)
|
||||
|
||||
- [Swagger API](https://docs.yunion.io/en/docs/swagger/)
|
||||
|
||||
@@ -77,9 +78,8 @@ See [Cloudpods Roadmap](https://docs.yunion.io/en/docs/roadmap/) for details.
|
||||
|
||||
## Contribution
|
||||
|
||||
You are welcome to contribute to the project. Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
|
||||
You are welcome to contribute to the project. Please refer to [CONTRIBUTING](https://docs.yunion.io/en/docs/contribute/contrib/) for guidelines.
|
||||
|
||||
## License
|
||||
|
||||
Apache License 2.0. See [LICENSE](./LICENSE).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user