diff --git a/docs/community.rst b/docs/community.rst index 900589e..bbdab81 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -1,17 +1,17 @@ .. community . ----------- -社区支持 ----------- +------------- +Community +------------- -Nano采用MIT许可，无论自用或者商业OEM均可使用。 +Nano uses MIT license, which is free for modification, personal or commercial use. -代码库地址： https://github.com/project-nano +Git Repository: https://github.com/project-nano -API文档地址： https://nanocn.docs.apiary.io/ +Blueprint for REST API: https://nanoen.docs.apiary.io/ -QQ群： Nano Cloud(819161083) +This manual: https://nanocloud.readthedocs.io/projects/guide/en_US ---- -感谢关注Nano，衷心期待您的加入 +Thanks for your attention, and sincerely looks forward to your joining us. diff --git a/docs/conf.py b/docs/conf.py index fc1a9a9..6641a60 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- project = u'Nano Quick Start Guide' -copyright = u'2018, Akumas' +copyright = u'2019, Akumas' author = u'Akumas' # The short X.Y version @@ -58,7 +58,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = u'zh_CN' +language = u'en_US' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/faq.rst b/docs/faq.rst index 43c8d62..6978f0a 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,75 +1,74 @@ .. faq . -.. contents:: 本章目录 +.. contents:: Chapters :depth: 2 --------- -常见问题 +FAQ --------- -安装Nano有什么要求？ -============================= +Install requirements for Nano? +=================================== -- 支持虚拟化的X86服务器或者打开嵌套虚拟化的虚拟机 -- 2核4G内存50GB磁盘和一个网络设备 +- Virtualization enabled X86 servers, or nested virtualization enabled virtual machines +- 2 cores/4 GB memory/50 GB disk/1 network interface - CentOS 7.6(1810) Minimal -- 操作系统安装完成并且网络就绪 +- Operation system installed with network ready -能否在虚拟机安装Nano？ -=============================== - -理论上支持嵌套虚拟化的技术都可以使用，已测试虚拟化技术： +Can Nano be installed on a virtual machine? +================================================== -- VMware Station，可以安装，需要打开CPU的嵌套虚拟化开关 -- VMware ESXi，可以安装，需要启用网络混杂模式 -- VirtualBox，不可安装 +All products enable nesting virtualization is possible in theoretically. Tested products: -能否在公有云安装Nano？ -=============================== +- VMware Station, test OK with Intell VT-x/AMD-V enabled +- VMware ESXi, test OK with Promiscuous Mode +- VirtualBox, test fail -不行，目前已知大部分公有云平台都不允许使用虚拟化技术 +Can Nano install on a public cloud like AWS? +================================================ -Nano安装过程中网络中断 -============================= +No, most public cloud platforms do not allow virtualization. -Installer安装过程中，会构建桥接网络并且重启网络服务，对于常见的Dell系列服务器和VMware实例，该操作不会中断网络连接。 +Network/SSH disconnected when installing Nano +================================================== -但是确实有部分服务器可能因为网络驱动原因，会导致网络中断，这种情况请使用服务器的IPMI或者类似远程管理界面进行安装，而不要使用SSH。 +The installer will configure network bridge and restart network service during installation, which does not affect the network connection for most Dell series servers and VMware instances. +However, it is true that some servers may cause network disconnection due to network drivers, which should install using the server's IPMI or similar remote administration interface instead of SSH. -Installer或者Cell启动时提示"no default route available" -=================================================================== +Prompt "no default route available" when Installer or Cell starts +===================================================================== -Nano所在服务器必须配置好默认路由才能正常工作，如果模块检测不到默认路由，则需要手工配置再启动服务。 -假设网络中默认网关为192.168.1.1，则在安装Nano的服务器上执行指令： +Nano requires a default route configured to work, manually configure a new one and restarted. +Assuming that the default gateway in the network is 192.168.1.1, execute below command. :: $ip route add default via 192.168.1.1 -Cell启动提示"query timeout" -========================================== +Prompt "query timeout" when starting Cell +============================================= -Cell模块启动时需要通过连接Core模块完成自我发现和组网，请检查Core模块是否启动。如果已经启动，请检查服务器网络配置和模块的通讯域配置信息是否一致 +The Cell requires a running Core process to complete self-discovery and networking. Check if the Core module and network are running correctly or the domain parameters are identical to Core's configure. -升级0.9.1之后看不到原有云主机和镜像了 -=============================================== +All instances and images absent after upgrading 0.9.1 +============================================================= -由于新版本只能查看自己拥有的云主机和镜像，请执行以下指令修改资源归属并重启服务，否则会无法看到自己的云主机和镜像资源。 -以当前用户为nano，用户组为admin为例 +Since the new version can only view the instances and images you created, execute the following instructions to modify the ownership of resources and restart the modules, otherwise you will not be able to see your instances and images. +Take the user 'nano' and group 'admin' as an example: :: - 更新Core模块镜像归属 + Update ownership of images in the Core module $sed -i 's/\"owner\": \"admin\"/\"owner\": \"nano\"/' /opt/nano/core/data/image.data $sed -i 's/\"group\": \"manager\"/\"group\": \"admin\"/' /opt/nano/core/data/image.data - 更新Cell模块云主机归属 + Update ownership of instances in the Cell module $sed -i 's/\"user\": \"admin\"/\"user\": \"nano\"/' /opt/nano/cell/data/instance.data $sed -i 's/\"group\": \"manager\"/\"group\": \"admin\"/' /opt/nano/cell/data/instance.data -升级之后为什么看不到日志和可见性管理菜单 -================================================== +No "log" or "visibility" menu available after upgrading +=========================================================== -旧版本升级之后，需要在角色管理中，为相应角色勾选"log"或者"visibility"菜单，用户重新登陆后即可 +Check on the "log" or "visibility" menu for the corresponding role in the permission management, and log in again. diff --git a/docs/images/4_change_password_cn.png b/docs/images/4_change_password_cn.png deleted file mode 100644 index 1ef92dc..0000000 Binary files a/docs/images/4_change_password_cn.png and /dev/null differ diff --git a/docs/index.rst b/docs/index.rst index 31becba..dd8e2e8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,10 @@ This manual provides an overview of the basic concepts about the Nano platform, Welcome to the official website https://nanos.cloud/en-us/ for more information. +Author: Akumas (bokuore@github.com) + +Git Repository: https://github.com/project-nano + Introduction ================== @@ -55,6 +59,7 @@ Chapters .. toctree:: :maxdepth: 2 + index concept deployment instance diff --git a/docs/platform.rst b/docs/platform.rst index d5bf977..3c11248 100644 --- a/docs/platform.rst +++ b/docs/platform.rst @@ -1,154 +1,160 @@ .. platform . -.. contents:: 本章目录 +.. contents:: Chapters :depth: 2 - ---------- -平台管理 ---------- -Nano提供了一系列便捷的管理功能，用于简化管理员的日常运维工作。 +------------------- +Manage Platform +------------------- -仪表盘 +Nano provides a bunch of utility functions to simplify the daily maintenance. + +Dashboard =========== -Nano门户首页提供了整个平台级别的资源用量仪表盘，包含虚拟资源和物理资源的用量，便于随时了解系统负载情况，及时对资源进行扩充或者调整。 +The landing page of the web portal provides a global usage dashboard, which covers both virtual and physical resources, helps to understand the real-time system load. .. image:: images/4_dashboard.png -管理员可以点击仪表盘，下钻查看资源池、Cell节点或者云主机实例的实时用量 +You can click on the dashboard to drill down to see the detail usage of resource pools, host nodes, or instances. .. image:: images/4_instances.png -增加资源节点 -============= +Add Resource Node +===================== -当系统负载较大时，可以通过添加新的资源节点，来扩充池内可用资源。 +When the system load is heavy, you can add a new Cell node to increase the resources available in the pool. -首先需要在新的服务器上部署并启动Cell模块，然后在资源池的节点清单中，选择"Add Cell" +First, you need to deploy and start the Cell module on a new server, and then click the "Add" button in the Cell list. .. image:: images/4_add_cell.png -在下来菜单中选择新装的Cell节点进行添加 +Choose the newly installed node from the drop-down menu. .. image:: images/4_select_cell.png -当资源池中Cell节点状态变为Online时，就可以承载新建的云主机实例了。 +When the status of the Cell node changes to Online, it will able to host new instances. .. image:: images/4_new_cell_status.png +Build Template Image +======================== -构建模板镜像 -============= - -Nano可以将任意云主机的系统磁盘制作成磁盘镜像，然后从镜像快速克隆出与原模板主机系统、软件一样的新实例，以便大幅度提升管理员部署实例的效率。 +Nano can make the system data of any instance into a disk image, and then quickly clone a new one from the image. The cloned instance has an operating system and software identical to the original one. .. image:: images/4_image_transport.png -要构建模板镜像，首先应该创建一个不含数据磁盘的空白云主机，然后通过加载系统光盘和网络方式安装好系统和软件。 +To build a template image, you should create an empty instance without a data disk, and then install the operating system and software by uploaded ISO and network. -以CentOS7为例，构建模板主机时，建议进行如下设置： +When building a template instance, consider the following steps. (Take the CentOS 7 as an example) -- 设置模板主机名和默认用户密码 -- 默认启用网络并设置为DHCP获取地址 -- 安装acpid服务支持关机和重启操作 -- 安装qemu-guest-agent以支持实时密码修改、内存用量监控等功能 -- 使用yum更新软件版本 -- 如果需要使用Nano的Cloud Init服务对实例进行自动初始化设置，则需要安装cloud-init/cloud-utils组件 +- Set default hostname and password. +- Bring up the network and enable DHCP to get IP. +- Install the ACPID service to enable shutdown and restart. +- Install the qemu-guest-agent to support online password modification, memory usage monitoring, etc. +- Update the latest software using yum. +- Install the cloud-init/cloud-utils if automatically initialization required. -上述设置完成后，关闭云主机，通过"Images" => "BUILD"，进入镜像构建界面，在下拉菜单中选择模板云主机，点击创建 +After configuration completed, shut down the instance. Click the "BUILD" button in the "Images" page, select previous template from the drop-down menu, and click to create. .. image:: images/4_build_image.png +When the image built finished, you can clone from it when you create a new instance. -当镜像制作完毕后，你就可以在新建云主机时选择从该镜像克隆实例了。 +User Management +=================== -用户管理 -=========== +Administrators can manage the accesses of users, groups, and roles. -Nano提供用户、组、角色三个层级的权限管理，来满足团队对于安全内控的要求。 +The access control is base on the menu items. A role defines the menu items can access. A group has multiple roles. -Nano目前权限控制按照功能菜单来划分，一个角色可以选择可以使用的功能菜单列表；一个用户组可以拥有多个角色；用户登录后，根据所属用户组的角色来获得自己可用的功能。一个用户只能属于一个用户组。 +After the user logs in, the menu list creating based on the roles of user group belongs. A user can only belong to one user group. -角色权限 ------------- +Role +-------- -管理员可以创建多个角色，可以为每个角色设置其可以使用的功能菜单，对应用户登录后，系统会根据角色权限生成管理界面。 +A system can have multiple roles, and each owns a set of menu items it can use. .. image:: images/4_role.png -用户 +User -------- -用户账户是登录管理平台必要的身份凭据，后续也会涉及到资源所属的管理。增加用户时，只需要在用户清单点击新建，然后输入用户信息即可。 +A user account is an identity to log in the system, and also the required key to check resource owner and visibility. Click the "New" button in the user list, and input required info to create a new account. .. image:: images/4_create_user.png -**请注意，新建用户虽然可以登录，但是必须加入用户组才能获得相应的菜单权限。** +**Note: Although the new account can log in, it must add to a user group to access menu items.** -用户组 ----------- +User Group +-------------- -用户组是权限管理的核心，一个用户组能够拥有多个角色，能使用的功能菜单为所有角色所属菜单的集合。 +The user group is the core of permissions. A group can have multiple roles. And the member can access all menu items of roles belongs to the group. .. image:: images/4_group.png -在用户组清单中，进入目标组的成员清单，点击添加，选择要加入该组的已创建用户。 +In the group list, enter the list of members. Click the "Add" button and choose an existed user you want to add to the group. .. image:: images/4_add_member.png -添加成功后，该用户登录时就可以访问相应的功能菜单了 +After the addition, the user can access the authenticated menu when login. -资源可见性 ------------- +Resource Visibility +----------------------- -云主机实例、磁盘镜像和光盘镜像都是系统资源，默认情况下，系统资源仅能由创建者访问。管理员可以通过可见性设置，允许访问同一组内其他用户创建的资源，以便实现组内资源共享。 +Instances, disk images, and media images are system resources which only visible by their creator by default. -密码修改 ------------- +Through visibility settings, administrators can allow access to resources created by other users within the same group for resource sharing. -已登录用户可以点击底部的按钮，修改自己的登陆密码 +.. image:: images/4_visibility.png -.. image:: images/4_change_password_cn.png +Password Modification +------------------------- -系统操作日志 -=========== +Logged-in users can click the button at the bottom to change their password. -Nano记录包括登录失败在内的用户操作日志，用于审计用户操作，排查系统故障。当日志过多时，也可以通过日志管理界面进行清除。在需要的用户角色里，添加“log”菜单即可。 +.. image:: images/4_change_password.png -版本升级 -=========== +Operate Logs +================ + +Nano records user operating logs, including login failures, to audit user operations and troubleshoot. + +.. image:: images/4_opreate_log.png -Nano所有模块使用go编译为二进制可执行文件，无需外部库依赖，配置和数据文件格式通常保持后向兼容，无需用户干预。 +Upgrade System +================== -Nano能够通过两种方式进行升级，启动Installer并且选择"4"可以进行自动升级，自动升级会根据用户输入的安装路径，检查已经安装模块进行替换，并且自动停止并重启运行中的模块，是推荐的升级方式。 +All modules of Nano are compiled binary without any external library dependency, and configuration and data file formats are usually backward compatible. -当自动升级方式出现问题时，可以选择手动升级，只需要使用"./模块名 stop"停止运行中的模块文件，替换可执行文件后使用"./模块名 start"重新启动服务即可。 +It highly recommends that executing the installer and selecting "4" to upgrade all modules automatically. The installer will check which module installed need to update, and stop and restart a running module automated. -唯一例外是FrontEnd模块还包含前端页面文件，所以升级时，除了要替换可执行文件，还需要手工将页面和js脚本文件从发布包中复制resource目录下进行覆盖。 +When you have a problem with the automatic upgrade, you manually upgrade all modules. -以升级到1.0.0为例，假定旧版本已经安装在/opt/nano目录下 +All you need is stop a running module, replace the binary and restart. The only exception is that the FrontEnd module also contains resource files need to replace. + +Assuming all modules installed in the path "/opt/nano". :: - 下载并解压新版本 + Download and unzip $cd ~ $wget https://nanos.cloud/media/nano_installer_1.0.0.tar.gz $tar zxfv nano_installer_1.0.0.tar.gz - 替换Cell模块 + Replace Cell $cd /opt/nano/cell $./cell stop $cp ~/nano_installer/bin/cell . $./cell start - 替换Core模块 + Replace Core $cd /opt/nano/core $./core stop $cp ~/nano_installer/bin/core . $./core start - 替换FrontEnd模块 + Replace FrontEnd $cd /opt/nano/frontend $./frontend stop $cp ~/nano_installer/bin/frontend . @@ -156,37 +162,38 @@ Nano能够通过两种方式进行升级，启动Installer并且选择"4"可以 $./frontend start +Network Change +================== -网络变更 -=========== +Core and FrontEnd use the specified address to provide services, when the server IP changes, you need to modify the configuration IP and restart the module. -Core与FrontEnd使用指定地址为用户提供服务，所以当所在服务器IP发生变化时，需要修改config目录下的配置IP，然后重启模块完成变更。 +When the IP of the Cell Server changed, you only need to restart the module. It will discovery the networking using the multicast protocol and rejoin the communication domain automated. -Cell模块通过组播协议和Core模块自动发现所在服务器地址并完成组网，所以当Cell服务器IP变化时，只需要重新启动Cell模块，后续地址变更、组网和实例网络调整由可以由系统自动完成，无需网络干预。 +When migrating the whole system or moving to a different network, modify the listening IP and multicast configuration at first. Please remember starting the Core before the Cell, finish new network discovery and switching. -当整个平台整体迁移或者变更到完全不同的网络时，请首先调整Core模块的监听IP和组播信息，确保Core模块正常启动后，再启动Cell模块，完成新网络识别和自动切换即可。 +Failover +============ -故障迁移 -========== +You can enable the Failover in the resource pool using shared storage. -当计算资源池使用共享存储作为后端存储时，可以开启故障迁移(Failover)开关。功能开启后，如果Nano平台检测到某一Cell节点失联，会自动将该节点管理的云主机实例迁移到集群内的一个或者多个Cell节点上。 +If a Cell node lost when the Failover enabled, all instance on that node will migrate automatically to other nodes in the same pool. .. image:: images/4_enable_failover.png -如果原实例设置了自动启动，则迁移完成后，系统会自动将实例启动进入服务状态。 +If the instance is autostarting, the new node will automatically start it after the migration. -**如果失联Cell节点恢复并重新加入Nano集群，系统将自动清除该Cell上的所有实例，并将该Cell置于禁用状态，管理员需要手动重新启用节点。** +**If the lost Cell node rejoins the pool, all instances on the Cell clear automatically and the Cell is disabled. The administrator needs to enable the node manually after that.** -禁用节点 -========== +Disable Node +================ -默认情况下，Nano会在资源池中选择负载较低的活动Cell节点创建云主机实例，但是用户可以选择手动禁用Cell节点，来避免在该节点上分配新的云主机实例，便于进行维护或者控制节点负载。 +Nano will select the node with the lowest load to create a new instance by default. But users can disable the Cell node manually to avoid host new instances on that node, easy to maintain or balance node load. .. image:: images/4_disable_cell.png -禁用的节点上云主机依然正常运行和管理，不受影响。禁用节点可以稍后手动重新启用，恢复承接新实例。 +On the disabled node, all instances work without any different. Disabled nodes can enable manually later to resume hosting new instances. -多语言 -======== +Multilingual +================ -Nano管理页面目前支持中文、英文两种语言，可以在界面开关切换，Nano会记住用户选项，只需选择一次，不用反复设置。 +The web portal currently supports both Chinese and English, switch it in the page footer.