From af5966cae59db8d790fd18885f960db0a61947a1 Mon Sep 17 00:00:00 2001 From: "{admin@attacker.club}" Date: Wed, 11 Oct 2023 09:54:47 +0800 Subject: [PATCH] init --- .DS_Store | Bin 0 -> 6148 bytes README.md | 38 +++++++++++- docs/css/extra.css | 151 +++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 72 +++++++++++++++++++++ mkdocs.yml | 103 +++++++++++++++++++++++++++++++ readthedocs.yml | 4 ++ requirements.txt | 5 ++ 7 files changed, 372 insertions(+), 1 deletion(-) create mode 100644 .DS_Store create mode 100644 docs/css/extra.css create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 readthedocs.yml create mode 100644 requirements.txt diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..4c52fe9ca4e6e83a9318f54e1a00e51897934efe GIT binary patch literal 6148 zcmeHK%}T>S5Z-O0O({YS3Oz1(Em+&46fYsx7cim+m70*C!I&*gY7eE5v%Zi|;`2DO zyAg}^Dq?3~_nY6{><8H&#u)cz(II0FW6Xwz$Wd7%=w2JDnPfzcV}$d35~eZ)`_07u zI^efkEN2NTSp4<-!%3RtMYsFTYjtaDyJ0u%mVN6#$hltx#Vq%N=`~sxQl??02jOKB z&&SU0smzKX$>OOhNTL{0ZmyCnl5T<@_%rK6bxq7^CH9Po)N@v{FNIfw?46HIx*QSH#{~7!;YajWm zC1eo;#K1pefLkMfX7FeEH&aN S=vU={bP-U5P)7{>0s|kGAxd%p literal 0 HcmV?d00001 diff --git a/README.md b/README.md index 4accd86..4c0af52 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# ezops + +# Ezops + + +## 可以使用pip命令安装MkDocs + +```bash +pip3 install mkdocs +``` + +## 初始化项目 + +```bash +git clone https://git.opsx.vip/docs/ezops.git +cd ezops +python3 -m mkdocs new . +``` + +## 启动 + +```bash +pip3 install -r requirements.txt +mkdocs serve +``` + +## 构建 + +```bash +mkdocs build +``` diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..3f6d095 --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1,151 @@ +/* .md-header { + background-color: rgb(37, 43, 60); + /* top: 48px; */ +} */ + +.md-footer { + background-color: rgb(37, 43, 60); +} + +.md-tabs { + background-color: #0a7be0; +} + +.md-footer-nav__link { + padding-top: .8rem; +} + +.md-main__inner { + margin-top: 3rem; +} + +.progress-label { + position: absolute; + text-align: center; + font-weight: 700; + width: 100%; + margin: 0; + line-height: 1.2rem; + white-space: nowrap; + overflow: hidden; +} + +.progress-bar { + height: 1.2rem; + float: left; + background-color: #2979ff; +} + +.progress { + display: block; + width: 100%; + margin: 0.5rem 0; + height: 1.2rem; + background-color: #eeeeee; + position: relative; +} + +.progress.thin { + margin-top: 0.9rem; + height: 0.4rem; +} + +.progress.thin .progress-label { + margin-top: -0.4rem; +} + +.progress.thin .progress-bar { + height: 0.4rem; +} + +.progress-100plus .progress-bar { + background-color: #00e676; +} + +.progress-80plus .progress-bar { + background-color: #fbc02d; +} + +.progress-60plus .progress-bar { + background-color: #ff9100; +} + +.progress-40plus .progress-bar { + background-color: #ff5252; +} + +.progress-20plus .progress-bar { + background-color: #ff1744; +} + +.progress-0plus .progress-bar { + background-color: #f50057; +} + +.md-typeset table:not([class]) td { + border: .05rem solid var(--md-default-fg-color--lightest); +} + +.md-typeset table:not([class]) tr:first-child td { + border: .05rem solid var(--md-default-fg-color--lightest); +} + +.lg-backdrop { + background-color: rgb(0 0 0 /0.8) +} + +.lg-outer .lg-img-wrap { + padding: 80px +} + +.md-nav__source { + background-color: #fc6554; +} + +.md-grid { + margin-left: 1rem; + margin-right: auto; + max-width: initial; +} + +.md-top { + margin-top: 2rem; +} + +.x-pack-span { + background-color: #0a7be0; + padding: 2px 5px; + color: #ffffff; +} + +.new-span { + background-color: seagreen; + padding: 2px 5px; + color: #ffffff; +} + +/** 增加边框蓝条 **/ +.md-typeset .admonition, +.md-typeset details { + border-width: 0; + border-left-width: 4px; +} + +.md-typeset .admonition.abstract, +.md-typeset details.abstract { + border-left-color: #3370FF; +} + +.md-typeset p, +.md-typeset ul, +.md-typeset ol, +.md-typeset dl, +.md-typeset blockquote { + display: flow-root; + margin: 1em 0; +} + +/** 显示所有标题 **/ +.admonition-title { + display: block; +} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..89c894d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,72 @@ +# 产品介绍 + +!!! Abstract "" + CloudExplorer Lite 是开源的轻量级云管平台； + CloudExplorer Lite 脱胎于飞致云创始软件产品 CloudExplorer 多云管理平台，支持对接纳管主流的公有云和私有云基础设施，提供开箱即用的云主机管理、云账单、运营分析和安全合规等基本功能，同时还可提供强大的扩展能力以满足企业的定制化需求。 +![主页](./img/index/主页.png){ width="1235px" } + +## 1 产品优势 + +!!! Abstract "" + - 多云对接：CloudExplorer Lite 支持对接纳管市场上主流的公有云和私有云，包括阿里云、华为云、腾讯云、VMware、OpenStack、Proxmox VE 等； + - 开箱即用：作为一款轻量版云管平台，CloudExplorer Lite 提供诸多开箱即用的功能满足大部分企业的基本需求； + - 扩展能力：CloudExplorer Lite 提供了强大的多租户体系和模块化能力，可以满足企业的定制化需求。 + +## 2 多云对接能力 + +!!! Abstract "" + CloudExplorer Lite 支持对接纳管市场上主流的公有云和私有云基础设施，包括阿里云、腾讯云、华为云、VMware、OpenStack、Proxmox VE 等。 +![云账号](./img/index/云账号.png){ width="1235px" } + +## 3 开箱即用的功能 + +!!! Abstract "" + CloudExplorer Lite 提供了诸多开箱即用的功能，比如云主机管理、云账单、运营分析和安全合规等，能够满足大部分企业在云基础设施管理方面的基本需求。 + +- 3.1 云主机管理 + +!!! Abstract "" + CloudExplorer Lite 提供统一的云主机的生命周期管理操作界面；基于用户管理体系，用户可创建、可操作的资源都具备隔离性。 +![云主机管理](./img/index/云主机管理.png){ width="1235px" } + +- 3.2 云账单 + +!!! Abstract "" + CloudExplorer Lite 提供统一的费用管理、费用分摊、自定义多维度账单功能，可以作为企业的云资源成本分析中心，帮助企业用户有效降低云上资源的成本管理难度。 +![云账单](./img/index/云账单.png){ width="1235px" } + +- 3.3 运营分析 + +!!! Abstract "" + CloudExplorer Lite 能够对企业现有的云资源从分布、容量、使用情况等多个维度进行分析，并提供资源优化建议。 +![运营分析](./img/index/运营分析.png){ width="1235px" } + +- 3.4 安全合规 + +!!! Abstract "" + CloudExplorer Lite 支持一键扫描多个云平台的多种云资源，可灵活定义规则。 + +![一键扫描](./img/index/安全合规-一键扫描.png){ width="1235px" } +![安全合规-总览](./img/index/安全合规-总览.png){ width="1235px" } + +## 4 扩展能力 + +!!! Abstract "" + CloudExplorer Lite提供了强大的多租户体系和模块化能力，可以满足企业的定制化需求。 + +- 4.1 多租户体系 + +!!! Abstract "" + 作为云管平台的核心能力之一，CloudExplorer Lite 为用户提供多租户、多角色的管理模型。系统初始化了三种内置角色，分别为系统管理员、组织管理员和普通用户，用户可以根据企业的实际情况进行灵活的租户体系映射。 +![管理模型](./img/systemarch/管理模型.png){ width="600px" } + +- 4.2 模块设计 + +!!! Abstract "" + CloudExplorer Lite 采用模块化设计，即插即用，企业可以轻松部署不同模块，从而扩大对云基础设施的管理范围。 +![模块管理](./img/index/模块管理.png){ width="1235px" } + +## 5 了解更多 + +!!! Abstract "" + - CloudExplorer Lite 知识库： diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..40093b0 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,103 @@ +site_name: Ezops 文档 +site_description: 运维开发平台 +site_author: Logan +site_url: http://localhost:8000 +copyright: Copyright @ 2023 Logan Li, All rights reserved. + +repo_name: 'Ezops' +repo_url: https://git.opsx.vip/docs/ezops +# theme: mkdocs # 默认主题 +# theme: readthedocs +# theme: material # pip3 install mkdocs-material +edit_uri: https://github.com/CloudExplorer-Dev/docs/tree/main/docs +theme: + name: 'material' + logo: './image/logo-white.png' + favicon: './image/favicon.ico' + language: 'zh' + highlightjs: true + hljs_languages: + - yaml + - django + palette: + - scheme: default + accent: blue + toggle: + icon: material/weather-sunny + name: Switch to dark mode + - scheme: slate + accent: blue + toggle: + icon: material/weather-night + name: Switch to light mode + features: + - navigation.instant + - navigation.tracking + - navigation.indexes + - navigation.top + - search.suggest + - search.highlight + - search.share + - header.autohide + - content.tabs.link + custom_dir: "theme" + + +nav: +- 产品介绍: index.md +- 快速入门: quick_start.md +- 系统架构: system_arch.md +- 作者说明: author.md + + +markdown_extensions: +- admonition +- codehilite: + guess_lang: True + linenums: False + # - toc: + # permalink: True +- footnotes +- attr_list +- def_list +- tables +- abbr +- md_in_html +- pymdownx.extra +- pymdownx.arithmatex +- pymdownx.betterem: + smart_enable: all +- pymdownx.caret +- pymdownx.critic +- pymdownx.details +- pymdownx.inlinehilite +- pymdownx.magiclink +- pymdownx.mark +- pymdownx.smartsymbols +- pymdownx.superfences +- pymdownx.tasklist +- pymdownx.tilde +- pymdownx.betterem +- pymdownx.progressbar +- pymdownx.tabbed + +extra_css: +- css/extra.css + +plugins: +- search: + lang: + - en + - ja + separator: '[\s\-\.]+' +extra: + version: + method: mike + + social: + - icon: fontawesome/brands/github + link: https://git.opsx.vip/docs/ezops.git + - icon: fontawesome/solid/envelope + link: mailto:admin@attacker.club + # - icon: fontawesome/solid/phone + # link: tel://18072725611 diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 0000000..067efc3 --- /dev/null +++ b/readthedocs.yml @@ -0,0 +1,4 @@ +build: + image: latest + +requirements_file: requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d7f2f23 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +mkdocs +mkdocs-material +mdx_gh_links +markdown +markdown-checklist \ No newline at end of file