quick start doc

docs/quick-start-zh.md

@@ -0,0 +1,109 @@
+
+# 快速入门
+
+## 安装客户端工具
+```sh
+pip install pody
+```
+
+## 连接到服务器 
+首先，从管理员处获得一个节点IP、账号和密码，例如三者分别为`10.254.29.178:8000`，`limengxun`和`123`，
+然后设置好相应环境变量：
+```sh
+export PODY_API_BASE_URL=http://10.254.29.178:8000;
+export PODY_API_USERNAME=limengxun;
+export PODY_API_PASSWORD=123;
+```
+
+::: tip
+此处我们使用`pody`命令行工具，更多信息请参考[这里](/pody-cli.md)。
+:::
+
+接着，你可以使用`pody`命令来管理pod了，首先测试一下是否能够连接到服务器，如无问题则会返回用户信息：
+```sh
+pody fetch user/info
+```
+::: details 结果示例
+```json
+{'user': {'name': 'limengxun', 'is_admin': 0}, 'quota': {'max_pods': -1, 'gpu_count': -1, 'memory_limit': -1}}
+```
+:::
+
+
+## 创建一个容器
+然后，拉取可用镜像名称列表：
+```sh
+pody fetch host/images
+```
+::: details 结果示例
+```json
+['ubuntu:18.04', 'nvidia/cuda:11.0-base', 'nvidia/cuda:11.0-runtime', 'nvidia/cuda:11.0-devel']
+```
+:::
+
+从中选取一个需要的镜像，例如`nvidia/cuda:11.0-base`，然后创建一个容器：
+```sh
+pody fetch pod/create image:nvidia/cuda:11.0-base ins:main
+```
+`Pody fetch`命令使用`<key>:<value>`的形式传递参数，
+其中`ins:main`表示创建一个名为`main`的pod实例。
+
+## 查看容器状态
+```sh
+pody fetch pod/info ins:main
+```
+::: details 结果示例
+```json
+{
+    'name': 'limengxun-main',
+    'status': 'running',
+    'image': 'nvidia/cuda:11.0-base',
+    'port_mapping': ['20806:22', '20299:8000'],
+    ...
+}
+```
+:::
+此时可以看到`main`容器已经运行起来了，且映射了两个端口，其中22端口映射到20806端口，可以通过`ssh`连接到容器。
+
+## 运行命令
+虽然可以通过`ssh`连接到容器，但是我们首先需要确保ssh服务已开启，并且将我们的公钥添加到容器的`~/.ssh/authorized_keys`文件中，
+可以通过以下命令来执行容器内的命令：
+```sh
+pody fetch pod/exec ins:main cmd:"service ssh start"
+```
+::: details 结果示例
+```json
+{'exit_code': 0, 'log': ' * Starting OpenBSD Secure Shell server sshd       \x1b[80G \r\x1b[74G[ OK ]\r\n'}
+```
+:::
+
+添加公钥到容器可以通过以下方式来执行：
+```sh
+pody fetch pod/exec ins:main cmd:'mkdir -p ~/.ssh && echo $(cat ~/.ssh/id_rsa.pub) >> ~/.ssh/authorized_keys'
+```
+::: details 结果示例
+```json
+{'exit_code': 0, 'log': ''}
+```
+:::
+
+:::tip
+如果要执行多条命令，可以直接写成脚本，然后以管道传递。
+```sh
+# 构建脚本
+echo "service ssh start && \\" > init.sh
+echo "mkdir -p ~/.ssh && \\" >> init.sh
+echo "echo $(cat ~/.ssh/id_rsa.pub) >> ~/.ssh/authorized_keys" >> init.sh
+# 执行脚本
+cat init.sh | pody fetch pod/exec ins:main cmd:
+```
+:::
+
+在上述操作后我们就可以通过`ssh`连接到容器了🎉：
+```sh
+ssh -p 20806 root@10.254.29.178
+```
+
+## 更多操作
+更多操作请参考[API文档](/api.md)。  
+关于Pody-CLI的更多信息请参考[这里](/pody-cli.md)。