generated from aliyun-computenest/quickstart-demo
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8ae4f76
Showing
4 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
|
||
name: build | ||
on: | ||
push: | ||
branches: | ||
- main | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.x | ||
- run: pip install mkdocs | ||
- run: pip install mkdocs-aliyun-computenest | ||
- run: mkdocs gh-deploy --force --clean --verbose | ||
- run: | | ||
full_repo_name="${{ github.repository }}" | ||
repo_name=${full_repo_name#*/} | ||
curl -X POST -H "Content-Type: application/json" -d "{"ServiceDocRepoNames":["${repo_name}"]}" "http://1119821156893882.eventbridge.ap-southeast-1.aliyuncs.com/webhook/putEvents?token=d7ae8f64e0ce42c7b757f9013e3bbd13920fe8ea7c2b4d2cb3d2e8e9dfbd4230afc9f9dfb37448448e416da1a85dc2fc81627b00fecd4909bb47e536833d1bae" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# QuickStart Demo | ||
|
||
查看服务实例部署在线文档,请访问 [服务实例部署文档](https://aliyun-computenest.github.io/quickstart-demo) | ||
|
||
本文档通过 [MkDocs](https://github.com/mkdocs/mkdocs) 生成,请参考[使用文档](https://www.mkdocs.org/getting-started/#installation) | ||
|
||
1)安装和使用: | ||
|
||
```shell | ||
$ pip install mkdocs # or use pip3 安装文档工具 | ||
$ pip install --upgrade mkdocs-aliyun-computenest # or use pip3 安装计算巢主题 | ||
$ mkdocs serve # in root folder | ||
``` | ||
2)本地预览:本地在浏览器打开 [http://localhost:8000/](http://localhost:8000/) 。 | ||
|
||
3)本地新建分支后,提交 `Pull request` 到 `main`分支。 | ||
|
||
4)合并至 `main` 分支后,查看 pages 部署结果。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
# Demo服务实例部署文档 | ||
|
||
## 概述 | ||
|
||
`(服务概述内容)`。 | ||
|
||
``` | ||
eg: | ||
Demo服务是计算巢提供的示例。 | ||
本文向您介绍如何开通计算巢上的`Demo`服务,以及部署流程和使用说明。 | ||
``` | ||
|
||
## 计费说明 | ||
|
||
`(计费说明内容)` | ||
|
||
``` | ||
eg: | ||
Demo在计算巢上的费用主要涉及: | ||
- 所选vCPU与内存规格 | ||
- 系统盘类型及容量 | ||
- 公网带宽 | ||
计费方式包括: | ||
- 按量付费(小时) | ||
- 包年包月 | ||
目前提供如下实例: | ||
| 规格族 | vCPU与内存 | 系统盘 | 公网带宽 | | ||
| --- | --- | --- | --- | | ||
| ecs.r6.xlarge | 内存型r6,4vCPU 32GiB | ESSD云盘 200GiB PL0 | 固定带宽1Mbps | | ||
预估费用在创建实例时可实时看到。 | ||
如需更多规格、其他服务(如集群高可用性要求、企业级支持服务等),请联系我们 [mailto:[email protected]](mailto:[email protected])。 | ||
``` | ||
|
||
## 部署架构 | ||
|
||
`(部署概述内容)` | ||
|
||
## RAM账号所需权限 | ||
|
||
`(权限策略内容)` | ||
|
||
``` | ||
eg: | ||
Demo服务需要对ECS、VPC等资源进行访问和创建操作,若您使用RAM用户创建服务实例,需要在创建服务实例前,对使用的RAM用户的账号添加相应资源的权限。添加RAM权限的详细操作,请参见[为RAM用户授权](https://help.aliyun.com/document_detail/121945.html)。所需权限如下表所示。 | ||
| 权限策略名称 | 备注 | | ||
| --- | --- | | ||
| AliyunECSFullAccess | 管理云服务器服务(ECS)的权限 | | ||
``` | ||
|
||
## 部署流程 | ||
|
||
### 部署步骤 | ||
|
||
`(部署步骤内容)` | ||
|
||
``` | ||
eg: | ||
1. 单击部署链接,进入服务实例部署界面,根据界面提示,填写参数完成部署。 | ||
2. 补充示意图。 | ||
``` | ||
### 部署参数说明 | ||
|
||
`(部署参数说明内容)` | ||
|
||
``` | ||
eg: | ||
您在创建服务实例的过程中,需要配置服务实例信息。下文介绍云XR实时渲染平台服务实例输入参数的详细信息。 | ||
| 参数组 | 参数项 | 示例 | 说明 | | ||
| --- | --- | --- | --- | | ||
| 服务实例名称 | | test | 实例的名称 | | ||
| 地域 | | 华北2(北京) | 选中服务实例的地域,建议就近选中,以获取更好的网络延时。 | | ||
``` | ||
|
||
### 验证结果 | ||
|
||
`(验证结果内容)` | ||
|
||
``` | ||
eg: | ||
1. 查看服务实例。服务实例创建成功后,部署时间大约需要2分钟。部署完成后,页面上可以看到对应的服务实例。 | ||
2. 通过服务实例访问TuGraph。进入到对应的服务实例后,可以在页面上获取到web、rpc、ssh共3种使用方式。 | ||
``` | ||
|
||
### 使用Demo | ||
|
||
`(服务使用说明内容)` | ||
|
||
``` | ||
eg: | ||
请访问Demo官网了解如何使用:[使用文档](https://www.aliyun.com) | ||
``` | ||
|
||
## 问题排查 | ||
|
||
`(服务使用说明内容)` | ||
|
||
``` | ||
eg: | ||
请访问[Demo的问题排查链接](https://www.aliyun.com)获取帮助。 | ||
``` | ||
|
||
## 联系我们 | ||
|
||
欢迎访问Demo官网([https://www.aliyun.com](https://www.aliyun.com))了解更多信息。 | ||
|
||
联系邮箱:[https://www.aliyun.com](mailto:https://www.aliyun.com) | ||
|
||
社区版开源地址:[https://github.com/](https://github.com/) | ||
|
||
扫码关注微信公众号,技术博客、活动通知不容错过: | ||
|
||
`(添加二维码图片)` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
site_name: Aliyun 计算巢 x Demo | ||
theme: | ||
name: aliyuncomputenest |