Merge pull request #11305 from swordqiu/hotfix/qj-update-readme-20210604

fix: improve README
This commit is contained in:
Zexi Li
2021-06-04 09:53:56 +08:00
committed by GitHub
2 changed files with 107 additions and 43 deletions
+51 -17
View File
@@ -1,35 +1,68 @@
# Yunion Cloud (云联融合云)
# Cloudpods
[![CircleCI](https://circleci.com/gh/yunionio/yunioncloud.svg?style=svg)](https://circleci.com/gh/yunionio/yunioncloud)
[![Build Status](https://travis-ci.com/yunionio/yunioncloud.svg?branch=master)](https://travis-ci.org/yunionio/yunioncloud)
[![Go Report Card](https://goreportcard.com/badge/github.com/yunionio/yunioncloud)](https://goreportcard.com/report/github.com/yunionio/yunioncloud)
## 什么是云联融合云?
## Cloudpods是什么?
云联融合云(Yunion Cloud)是一个开源的多云平台。融合云构建在用户分布于多云基础设施之上,通过技术手段将分布于多云的异构IT资源统一管理,将多底层多云的差异向用户屏蔽,并通过网络和调度实现资源的融合与打通,在多云之上进行抽象,向用户呈现统一的使用界面和API接口,让用户就像使用一个云平台一样使用分布于多云的资源,实现一个统一的“云上之云”的云平台。
Cloudpods是一个开源的Golang实现的云原生融合多云/混合云的云平台。Cloudpods可以理解为pod(豆荚) of clouds,有多云管理的寓意。Cloupods可以管理多个云平台和云账号。并且,Cloudpods隐藏了这些平台和账号之间的云资源的数据模型和API的差异,对外暴露了一套统一的API。从而大大降低了访问多云的复杂度,提升了管理多云资源的效率。
鉴于企业IT基础设施的两个趋势:1. 企业使用多云基础设施,并且公有云是最主要的基础设施提供者;2. 企业应用将逐步云原生化,企业IT基础设施需要为Kubernetes优化。融合云为此架构而设计。一方面抽象管理底层的多云基础设施,另一方面为多云Kubernetes提供运行环境。融合云为企业未来的的IT基础设施架构而设计。
## 功能
云联融合云具备以下功能特性:
Cloudpods提供了如下的功能:
- 多云资源统一管理
* 一个可以管理海量KVM虚拟机的轻量级私有云
* 一个能进行物理机全生命周期管理的裸机云
* 实现了VMware vSphere虚拟化集群的自助服务和自动化
* 管理多云资源的功能,可以管理大多数的主流云,包括私有云,例如OpenStack,以及公有云,例如AWS,Azure,GCP,阿里云,华为云和腾讯云等
* 提供一组统一的功能丰富的REST API访问以上的云资源
* 一套完整的多租户认证和访问控制体系
* 多云镜像管理自动将镜像转换为不同云平台需要的格式
统一API、镜像、调度、账号体系、监控和计费等操作,能够全面管理 On premises、 私有云、公有云资源。
## 安装
- 内置私有云
我们可以通过以下简单三步将Cloudpods安装在一台至少8GiB内存和100GB硬盘的Linux主机上:
YunionCloud 内置完备的私有云实现,提供对用户本地IDC的虚拟机、物理机和负载均衡等资源管理。
### 准备SSH免密登录
- 为多云Kubernetes提供运行环境
```bash
# Generate the local ssh keypair
# (SKIP this stekp if you already have ~/.ssh/id_rsa.pub locally)
$ ssh-keygen
# Copy the generated ~/.ssh/id_rsa.pub public key to the machine to be deployed
$ ssh-copy-id -i ~/.ssh/id_rsa.pub root@10.168.26.216
# Try to login to the machine to be deployed without password,
# should be able to get the hostname of the deployed machine
# without entering the login password
$ ssh root@10.168.26.216 "hostname"
```
YunionCloud 自身为运行在Kubernetes的云原生应用,并且能在多云环境部署运行Kubernetes集群。
### 安装ansible和git
欢迎安装部署云联融合云,期待大家的反馈!
#### CentOS
```bash
# Install ansible and git locally
$ yum install -y epel-release ansible git
```
#### Debian 10
```bash
# Install ansible locally
$ apt install -y ansible git
```
### 安装cloudpods
## 部署
请将脚本中的<host_ip>替换为该Linux主机的主IP地址。
请参考文档 [快速开始](https://docs.yunion.io/zh/docs/quickstart/) 搭建 YunionCloud 集群。
```bash
# Git clone the ocboot installation tool locally
$ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py <host_ip>
```
大概10-30分钟后,安装完成。访问https://<host_ip>登入Cloudpods的Web控制台。初始的账号和密码为:admin/admin@123
请参考文档 [快速开始](https://docs.yunion.io/zh/docs/quickstart/) 获得更详细的安装指导。
## 文档
@@ -39,9 +72,9 @@
- [Swagger API文档](https://docs.yunion.cn/api/)
## 架构
## 规划
![architecture](https://www.yunion.cn/static/frame.png)
请访问[Cloudpods Roadmap](https://docs.yunion.io/zh/docs/roadmap/).
## 贡献
@@ -51,4 +84,5 @@
## License
YunionCloud 使用 Apache license 2.0. 详情请看 [LICENSE](./LICENSE) 。
Cloudpods 使用 Apache license 2.0. 详情请看 [LICENSE](./LICENSE) 。
+56 -26
View File
@@ -1,4 +1,4 @@
# Yunion Cloud
## Cloudpods
[![CircleCI](https://circleci.com/gh/yunionio/yunioncloud.svg?style=svg)](https://circleci.com/gh/yunionio/yunioncloud)
[![Build Status](https://travis-ci.com/yunionio/yunioncloud.svg?branch=master)](https://travis-ci.com/yunionio/yunioncloud/branches)
@@ -6,35 +6,64 @@
[English](./README.md) | [简体中文](./README-CN.md)
## What is Yunion Cloud?
## What is Cloudpods?
Yunion Cloud is an open source unified-IaaS cloud platform.
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.
As its name sugguests, 'Yun' means 'cloud' in Chinese and 'Yunion Cloud' means to unify many distinct clouds into the one that behaves like an integral cloud platform.
## Features
As trends show, the enterprise IT infrastructure in the future would be unavoidably heterogeneous and the public clouds should be the major infrastructure providers for many enterprises. Further, the infrastructure would most likely be prepared for the cloud-native applications running on Kubernetes. Yunion Cloud is built to provide the cloud architecture for this scenario such that it is the middle layer between the underlying cloud infrustructures and the overlay kubernetes clusters across many clouds.
Many may consider Yunion Cloud as a multi-cloud management platform (MCMP). Rather, we would view it as an IaaS platform as it does not only manage the resources and services from many clouds, but also hides the differences of underlying technologies and exposes one set of APIs that allow programatically interacting with the compute/storage/networking resources across many clouds.
Yunion Cloud is working on abstracting APIs for the following resources:
* Compute, including virtual machines, images, etc.
* Storage, including disks, snapshots, object storages, etc.
* Networking, including load balancers, VPC, virtual networks, NAT gateways, security groups, etc.
* Accouting and billing, etc.
* ...
over the following many cloud providers:
* On-premise IT resources, including kvm VM, baremetal, VMware vsphere/ESXi, etc.
* Private clouds, including OpenStack, etc.
* Public clouds, including Aliyun, AWS, Azure, Tencent Cloud, Huawei Cloud, etc.
You are welcome to install and try Yunion Cloud. Looking forward to your feedback.
* 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
## Installation
Please refers to [quick start](https://docs.yunion.io/en/docs/quickstart/).
You may install Cloudpods into a Linux box with at least 8GiB RAM and 100GB storage with the following three simple steps:
### Prepare passwordless SSH login
```bash
# Generate the local ssh keypair
# (SKIP this stekp if you already have ~/.ssh/id_rsa.pub locally)
$ ssh-keygen
# Copy the generated ~/.ssh/id_rsa.pub public key to the machine to be deployed
$ ssh-copy-id -i ~/.ssh/id_rsa.pub root@10.168.26.216
# Try to login to the machine to be deployed without password,
# should be able to get the hostname of the deployed machine
# without entering the login password
$ ssh root@10.168.26.216 "hostname"
```
### Install ansible and git
#### For CentOS
```bash
# Install ansible and git locally
$ yum install -y epel-release ansible git
```
#### For Debian 10
```bash
# Install ansible locally
$ apt install -y ansible git
```
### Install cloudpods
Please replace <host_ip> with the master IP address of the linux box.
```bash
# Git clone the ocboot installation tool locally
$ git clone https://github.com/yunionio/ocboot && cd ./ocboot && ./run.py <host_ip>
```
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.
For more detailed instructions, please refers to [quick start](https://docs.yunion.io/en/docs/quickstart/).
## Documentations
@@ -42,9 +71,9 @@ Please refers to [quick start](https://docs.yunion.io/en/docs/quickstart/).
- [Swagger API](https://docs.yunion.io/en/docs/swagger/)
## Architecture
## Roadmap
![architecture](https://www.yunion.cn/static/frame.png)
See [Cloudpods Roadmap](https://docs.yunion.io/en/docs/roadmap/) for details.
## Contribution
@@ -53,3 +82,4 @@ You are welcome to contribute to the project. Please refer to [CONTRIBUTING.md](
## License
Apache License 2.0. See [LICENSE](./LICENSE).