File tree Expand file tree Collapse file tree 4 files changed +174
-0
lines changed Expand file tree Collapse file tree 4 files changed +174
-0
lines changed Original file line number Diff line number Diff line change
1
+
2
+ name : build
3
+ on :
4
+ push :
5
+ branches :
6
+ - main
7
+ jobs :
8
+ deploy :
9
+ runs-on : ubuntu-latest
10
+ steps :
11
+ - uses : actions/checkout@v2
12
+ - uses : actions/setup-python@v2
13
+ with :
14
+ python-version : 3.x
15
+ - run : pip install mkdocs
16
+ - run : pip install mkdocs-aliyun-computenest
17
+ - run : mkdocs gh-deploy --force --clean --verbose
18
+ - run : |
19
+ full_repo_name="${{ github.repository }}"
20
+ repo_name=${full_repo_name#*/}
21
+ curl -X POST -H "Content-Type: application/json" -d "{"ServiceDocRepoNames":["${repo_name}"]}" "http://1119821156893882.eventbridge.ap-southeast-1.aliyuncs.com/webhook/putEvents?token=d7ae8f64e0ce42c7b757f9013e3bbd13920fe8ea7c2b4d2cb3d2e8e9dfbd4230afc9f9dfb37448448e416da1a85dc2fc81627b00fecd4909bb47e536833d1bae"
22
+
Original file line number Diff line number Diff line change
1
+ # QuickStart Demo
2
+
3
+ 查看服务实例部署在线文档,请访问 [ 服务实例部署文档] ( https://aliyun-computenest.github.io/quickstart-demo )
4
+
5
+ 本文档通过 [ MkDocs] ( https://github.com/mkdocs/mkdocs ) 生成,请参考[ 使用文档] ( https://www.mkdocs.org/getting-started/#installation )
6
+
7
+ 1)安装和使用:
8
+
9
+ ``` shell
10
+ $ pip install mkdocs # or use pip3 安装文档工具
11
+ $ pip install --upgrade mkdocs-aliyun-computenest # or use pip3 安装计算巢主题
12
+ $ mkdocs serve # in root folder
13
+ ```
14
+ 2)本地预览:本地在浏览器打开 [ http://localhost:8000/ ] ( http://localhost:8000/ ) 。
15
+
16
+ 3)本地新建分支后,提交 ` Pull request ` 到 ` main ` 分支。
17
+
18
+ 4)合并至 ` main ` 分支后,查看 pages 部署结果。
Original file line number Diff line number Diff line change
1
+ # Demo服务实例部署文档
2
+
3
+ ## 概述
4
+
5
+ ` (服务概述内容) ` 。
6
+
7
+ ```
8
+ eg:
9
+
10
+ Demo服务是计算巢提供的示例。
11
+ 本文向您介绍如何开通计算巢上的`Demo`服务,以及部署流程和使用说明。
12
+ ```
13
+
14
+ ## 计费说明
15
+
16
+ ` (计费说明内容) `
17
+
18
+ ```
19
+ eg:
20
+
21
+ Demo在计算巢上的费用主要涉及:
22
+
23
+ - 所选vCPU与内存规格
24
+ - 系统盘类型及容量
25
+ - 公网带宽
26
+
27
+ 计费方式包括:
28
+
29
+ - 按量付费(小时)
30
+ - 包年包月
31
+
32
+ 目前提供如下实例:
33
+
34
+ | 规格族 | vCPU与内存 | 系统盘 | 公网带宽 |
35
+ | --- | --- | --- | --- |
36
+ | ecs.r6.xlarge | 内存型r6,4vCPU 32GiB | ESSD云盘 200GiB PL0 | 固定带宽1Mbps |
37
+
38
+ 预估费用在创建实例时可实时看到。
39
+ 如需更多规格、其他服务(如集群高可用性要求、企业级支持服务等),请联系我们 [mailto:[email protected] ](mailto:[email protected] )。
40
+
41
+ ```
42
+
43
+ ## 部署架构
44
+
45
+ ` (部署概述内容) `
46
+
47
+ ## RAM账号所需权限
48
+
49
+ ` (权限策略内容) `
50
+
51
+ ```
52
+ eg:
53
+
54
+ Demo服务需要对ECS、VPC等资源进行访问和创建操作,若您使用RAM用户创建服务实例,需要在创建服务实例前,对使用的RAM用户的账号添加相应资源的权限。添加RAM权限的详细操作,请参见[为RAM用户授权](https://help.aliyun.com/document_detail/121945.html)。所需权限如下表所示。
55
+
56
+
57
+ | 权限策略名称 | 备注 |
58
+ | --- | --- |
59
+ | AliyunECSFullAccess | 管理云服务器服务(ECS)的权限 |
60
+
61
+ ```
62
+
63
+ ## 部署流程
64
+
65
+ ### 部署步骤
66
+
67
+ ` (部署步骤内容) `
68
+
69
+ ```
70
+ eg:
71
+
72
+ 1. 单击部署链接,进入服务实例部署界面,根据界面提示,填写参数完成部署。
73
+ 2. 补充示意图。
74
+ ```
75
+ ### 部署参数说明
76
+
77
+ ` (部署参数说明内容) `
78
+
79
+ ```
80
+ eg:
81
+
82
+ 您在创建服务实例的过程中,需要配置服务实例信息。下文介绍云XR实时渲染平台服务实例输入参数的详细信息。
83
+
84
+ | 参数组 | 参数项 | 示例 | 说明 |
85
+ | --- | --- | --- | --- |
86
+ | 服务实例名称 | | test | 实例的名称 |
87
+ | 地域 | | 华北2(北京) | 选中服务实例的地域,建议就近选中,以获取更好的网络延时。 |
88
+ ```
89
+
90
+ ### 验证结果
91
+
92
+ ` (验证结果内容) `
93
+
94
+ ```
95
+ eg:
96
+
97
+ 1. 查看服务实例。服务实例创建成功后,部署时间大约需要2分钟。部署完成后,页面上可以看到对应的服务实例。
98
+ 2. 通过服务实例访问TuGraph。进入到对应的服务实例后,可以在页面上获取到web、rpc、ssh共3种使用方式。
99
+ ```
100
+
101
+ ### 使用Demo
102
+
103
+ ` (服务使用说明内容) `
104
+
105
+ ```
106
+ eg:
107
+
108
+ 请访问Demo官网了解如何使用:[使用文档](https://www.aliyun.com)
109
+ ```
110
+
111
+ ## 问题排查
112
+
113
+ ` (服务使用说明内容) `
114
+
115
+ ```
116
+ eg:
117
+
118
+ 请访问[Demo的问题排查链接](https://www.aliyun.com)获取帮助。
119
+ ```
120
+
121
+ ## 联系我们
122
+
123
+ 欢迎访问Demo官网([ https://www.aliyun.com ] ( https://www.aliyun.com ) )了解更多信息。
124
+
125
+ 联系邮箱:[ https://www.aliyun.com ] ( mailto:https://www.aliyun.com )
126
+
127
+ 社区版开源地址:[ https://github.com/ ] ( https://github.com/ )
128
+
129
+ 扫码关注微信公众号,技术博客、活动通知不容错过:
130
+
131
+ ` (添加二维码图片) `
Original file line number Diff line number Diff line change
1
+ site_name : Aliyun 计算巢 x Demo
2
+ theme :
3
+ name : aliyuncomputenest
You can’t perform that action at this time.
0 commit comments