Dashboard Guide

Objective

This guide explains how to use Dashboard Guide on Ruk-Com Cloud PaaS, with ordered procedures and practical verification points.

Before you begin

• Sign in with an account permitted to manage the relevant environment.
• Confirm the target environment, region and resources before saving changes.
• Create a backup or rollback plan before changing a production system.

The following instructions will provide you with the necessary information on using the Ruk-Com Cloud dashboard and will help you familiarize yourself with all of the essential features that can be divided into sections. เป็นหมวดหมู่ใหญ่ๆได้ดังนี้

• การสร้างและจัดการ Environment
• ไอคอนและสัญลักษณ์ต่างๆของ Dashboard
• การตั้งค่า และ ปรับแต่ง Environment
• ไอคอนและสัญลักษณ์ต่างๆของแต่ละ instance
• Importing Environment and Cloud Script data
• Using the Marketplace
• Creating a Group for the Environment
• Using the search box
• Deployment management system
• Platform tasks and activities
• User settings
• Help Center

การสร้างและจัดการ Environment

First of all, the author would like to use the word ENV instead of the word Environment for ease of calling and use.

1. Press NEW ENVIRONMENT in the top left corner of the screen.

2. A Popup will appear. We call this display page the Topology Wizard. This screen will allow you to customize anything freely.

Explain in detail each display box.

• Name: ในช่องนี้จะแสดง ชื่อ Env, ชื่อ Domain สำหรับเข้าถึง (alias), แสดงที่ตั้งของ Server สามารถกดแสดงรายละเอียดได้เพิ่มเติมได้ที่ไอคอนด้านหน้าชื่อ Env
  
• Status: ในช่องนี้จะใช้สำหรับบอก Status ของ Env โดยจะมีรายละเอียดทั้งหมดดังนี้ (Running,Sleeping,Stopped,Creating,Launching,Stopping,Cloning,Redeploying,Exporting,Installing,Migrating,Deleting)
  
• Tag: ใน Column นี้เราสามารถเพิ่ม Tag สำหรับเรียกชื่อ Project, Version, หรือตั้งเป็นหมวดหมู่ของงานได้

• Usage: ในช่องนี้จะแสดงการใช้งานทรัพยากรณ์ของ Container ปัจุบัน (การใช้งาน Cloudlet และ Disk Space) อีกทั้งยังสามารถดูยอดใช้ค่าบริการผ่านการกดไอคอนรูปถุงเงินสีทอง To be able to see expenses per Env

ไอคอนและสัญลักษณ์ต่างๆของ Dashboard

1. Edit the ENV name with the pencil icon.

2. สามารถเอาเมาส์เลื่อนผ่าน Environment และจะเห็น ธงชาติ หรือชื่อ Datacenter ที่ใช้งานหากต้องการย้าย Datacenter สามารถทำได้ด้วยการ Migration (ในส่วนนี้จะพูดในหัวข้อถัดไป)

3. You can press Open in Browser to open the website and enter that Env.

4. เมนู Settings สามารถปรับแต่ง Env ได้อีกมากมายสามารถดูรายละเอียดเพิ่มเติมได้ที่configuration panel

5. Menu Change Environment Topology สำหรับปรับแต่ง Topology Wizard กรณีต้องการปรับแต่ เพิ่มลด Container หรือเพิ่มลดทรัพยากรณ์ต่างๆ

6. เมนู Clone Environment สำหรับทำการโคลน Env ทั้งหมดไปเป็น Env ใหม่สามารถโคลนไปทั้ง Datacenter เดิมและข้าม Datacenter หรือสามารถทำเป็น Dev, Staging, Production ได้ทันที

Additional informationFor Clone Environment

• Clone Environment
• Application Live Cycle Management

7. Menu for editing server status, such as turning on/off Env.

Note:

เมื่อ ENV เป็นสถานะ Stop จะมีบาง Function ใน Setting ที่จะไม่สามารถใช้งานได้ เนื่องจาก Container ทั้งหมดใน ENV จะถูก Stop ไปด้วย

8. Delete Environment menu for deleting Envs that we don't want to use. ระบบจะทำการถามรหัสผ่านของ Account ก่อนทุกครั้ง เพื่อป้องกันการกดผิดพลาด

9. เมื่อเลื่อมเมาส์ผ่านช่องที่ชื่อว่า Tag จะสามารถตั้งชื่อโปรเจคหรือชื่อกลุ่มให้กับ Env ได้ด้วยเมนู Edit Environment Group

Environment settings and customization

ในส่วนของ Settings จะมีทั้งหมด 11 หัวข้อที่จำเป็นต้องใช้งานในการจัดการ Env

• Custom Domains
• Custom SSL
• SSH Access
• Endpoints
• Firewall
• Monitoring
• Collaboration
• Change
• Owner
• Migration
• Export
• Info

1. The Custom Domain menu is used for setting the Domain Name that you want to connect to Env. There are 2 submenus: Domain Binding, used for connecting Domains to the system and pointing the Cname to Alias of Env, and the Swap Domains menu is used for changing domain names to connect to other Envs.

Additional information

• Custom Domain Name
• Swap Domains
• Application Lifecycle Management

2. Custom SSL menu for setting up SSL yourself in case you already have a Certificate file. There will be a field to upload Certificate, Key and CA and press Save.

If you want to use a custom SSL certificate, you will need to request one.Public IPto the Load Balancer first only.

Additional information

• Self-Signed Custom SSL
• Custom SSL

3. SSH Access Menu: After entering this menu, you will see 3 tabs at the top: Public Keys, SSH Connection, and SFTP / Direct SSH Access. What is required for this menu is to addpublic SSH keysLog into the system first. หลังจากนั้นช่อง SSH Connection จะมีรายละเอียดเกี่ยวกับ Server ที่เราสามารถเชื่อมต่อ SSH ไปได้

Additional information

• Ruk-Com SSH
• Add SSH Key
• SSH Access via Web Browser
• SSH Access via Local Client
• SSH Protocols

4. เมนู Endpoints ช่วยให้คุณสามารถทำการเชื่อมต่อ Container ผ่านโปรโตคอล TCP/UDP จากภายนอกได้โดยระบบจะทำการ random port ให้ใช้งานสำหรับทดสอบการเข้าถึง Container ได้อย่างง่าย

Additional information

• Endpoints

5. Firewall menu is used to define and limit access to containers within Env. You can set both Inbound and Outbound Rules to determine who can access them and block unwanted traffic.

Additional information

• Container Firewall

6. You can track the status of resource usage with the Monitoring menu, including being able to set notifications when Container resource usage reaches the value we set.

• SubmenuLoad AlertsAllows you to set notifications when the container's resources reach the point we want to know, such as wanting to warn when CPU usage exceeds 70%, etc.
• SubmenuAuto Horizontal ScalingAllows you to set automatic Scale Out machine expansion, which will expand the machine according to specified conditions, such as when the CPU exceeds 70% for more than 5 minutes in a row, automatically add 3 machines, and when the CPU is less than 10% for more than 5 minutes, automatically delete the machine, leaving only 1 machine. The conditions can be determined fromCPU,Memory,Network,Disk I/O, andDisk IOPS
• The entire notification history can be viewed in the submenu.Events History

Additional information

• Load Alerts
• Automatic Horizontal Scaling

7. MenuCollaborationUsed for managing, increasing, decreasing, and setting access rights to that Env, such as wanting to forward this Env to people on the team. Or each department in the organization can invite friends or related people to take care of Env.

From the example, rights have been added to Email [email protected]. To be able to edit and SSH into this Env. If you want to remove permissions, you can remove permissions by pressing the Delete button.

Additional information

• Account Collaboration

8. สามารถโอนสิทธิ์การจัดการ Env ทั้งหมดให้สมาชิกท่านอื่นดูแลต่อด้วยเมนูChange Owner

You can transfer Env to another Ruk-Com Cloud member to take care of the work by simply entering an email and pressing Send Request. When the destination clicks to accept, the Env will be transferred to the admin immediately and all service fees will be charged to the member taking care of it.

Additional information

• Environment Transferring

9. You can move Datacenter or move Region with the menu.Migration

Used in cases where you want to move a Region, such as wanting to move from Thailand to Singapore or wanting to put Env on other Public Clouds such as Google Cloud or Aws, etc. In this menu, Ruk-Com Cloud plans to continually add Regions or Datacenters according to customer needs.

Additional information

• Environment Migration between Regions

10. You can store Config values including all Env data files with the menu.Export

Currently, if using an Image that isWindows,Storage,Elastic VPS,Maven, andDocker containersWill not be able to export data that is in the Container, only the values will be obtained. Configuration หากต้องการเก็บข้อมูลจำเป็นต้อง Backup แยกออกมาจากช่องทางอื่นเช่น SFTP / SSH หรือ Clone ENV

Additional information

• Environment Export
• Environment Import

11. Show details of Env such as project owner name, creation date, server location in the Info menu.

Instance icons and symbols

You can press the arrow in front of an Env to expand it to see details of all Container groups of that Env, including IP Address numbers including Public IP / Private IP and others.

Here there will be many icons for use, each function will be explained as follows.

• Set AliasUsed to edit the Container name to make it easier to manage. You can view additional information.here
• Open in BrowserUsed for accessing Env through a Web Browser such as Google Chrome / Firefox, etc. It can only access the Load Balancer and Application layers. It cannot access the Storage or Container sections that are built by itself.
• Restart Node(s)Used for restarting containers. Can be ordered either one container at a time or restart the entire Env layer.
• ConfigUsed for accessing various Config values of the Container, including accessing various files and folders. Can learn morehere
• LogUsed for viewing the Log of each Container. Each layer of the application has a file name that follows. You can see more information about the Log atLog File
• StatisticsUsed for viewing resources used including CPU, RAM, Network, Disk space, and IOPS. You can view containers in real time.
• Web SSHSSH can be accessed via Web Browser.
• Redeploy Container(s)Used to reset various values of the Container to default values or change the Version of the Container according to the Tag. More information can be found atUpdate Node
• Add-OnsUsed for installing add-on programs to the Container, such as installing additional libraries or installing other monitoring systems, etc.
• AdditionallyFor additional settings such as (Variables,Links,Volumes,CMD / Entry Point) or set the Scale setting, etc. See more details atcontainer settings

Importing Environment and Cloud Script data

Next to the NEW Environment menu, next comes the Import menu, used to upload a script to create an Env which will support file extensions..json,.jps,.cs,.yml, or.yamlThat is used for making add-ons or customizing Env. This section will help you to apply additional things if you want to do. Infrastructure as code is easier.

After pressing IMPORT, a window will appear. In this section you can write Custom Scripts. You can view the syntax and see ready-to-use examples atJPS Collection

• Local FileFor uploading JPS Script files from your computer.
• URLUsed for uploading via URL (both HTTP and HTTPS protocols are supported).
• JPSFor writing Script that is JSON/YAML or customizing it from an existing JPS Collection, it can be done in this menu.

Additional information

• Environment Import

Using the Marketplace

If you click on the menuMarketplaceAt the top of the Dashboard you will find various CMS systems and best practice solutions that we have grouped together.

The Marketplace is separated into 2 main categories:

• ApplicationsFor creating a new Env using the automatic system to connect each Container together, including doing Pre Configuration. Ready to use
• Add-OnsFor adding capabilities to the Env that we already have.

Additional information

• Marketplace

Creating a Group for the Environment

Ruk-Com Cloud allows you to create Env groups. For example, system administrators managing projects for multiple companies or departments can separate groups and can even create subcategories, for example:development/testing/production,servers/databases/storagesetc.

You can managenetwork isolationthrough Env groups

Additional information

• Group Creation
• Navigation Across Groups
• Group Management

Using the search box

The Dashboard search menu is an important function because it helps you find exactly what you're looking for. The menu will be in the upper right box or you can use the keyboard shortcut by pressing CTRL+F/CMD+F.

Deployment management system

The Deployment Manager menu is located at the bottom of the Dashboard. You can upload applications or source code that will be used to create Env later. It is separated into 2 main functions:

• ArchiveTo store the application as a compressed file, you can upload it from your Compuer or upload it through a URL.
• Git / SVNFor connecting to projects via GIT/SVN, you can enter credentials and connect to your own repository via pressing the menu.Add Repo

After you have successfully connected your project, you can use the function.automatically deployedGo through the manual in the next sections.

Types of VCS Deployment for Java Applications can be viewed in the manual.Maven build nodeYou can add more.

Platform tasks and activities

The Task section in the lower left corner of the page shows the activities of the Ruk-Com Cloud Platform from the start of the process to the end of the process. Used for analyzing problems and being able to view past activities of team members.

The following information describes each field.

• StatusUsed for telling various work status. Rotating symbol (in progress), green dot (Success) and red dot (Error)
• Time: Shows the start time of that job. (Will be grouped on a day-to-day basis)
• Environment: Displays the name of the Env where the action is performed. and will show a - sign if you don't know which Env number it is.
• Task: Used to explain details when an error is found. or failed to complete that task

• Duration: Shows the total time spent on that task.
• search: Can be used to search for Tasks by time period or by Env.

User settings

Click on the Settings heading in the top right corner of the Dashboard. Details will be displayed at the bottom of the screen. This section deals with all User settings, with details as follows.Account,Access Tokens,SSH KeysandCollaboration

• AccountAllows you to increase your security by turning on 2-Step Verification (two-factor authentication)
  
  
  

• Access TokensYou can create a Token to use for API usage (personal access tokens)
  
  
  
  
  

in the menuSSH Keys / SSH AccessThere will be 4 submenus as follows:

• Public Keys: Used for storingPublic KeyTo be used for SSH connections remotely or from within the platform.
• Private Keys: Used for storingPrivate Key(Used for connecting to private Git repository via SSH protocol)
• SSH Connection: Displays information for connecting via SSH.SSH Gateand shows how to access SSH through a web browser (Web SSH)
• SFTP / Direct SSH Access: Displays information for connecting by protocol.SFTP/FISH

Help Center

Help menu for finding usage information including contact channels from Ruk-Com Cloud's Support department.

In case you want to inquire Or report a problem via Ruk-Com Cloud. There are 4 channels to help everyone.

• Line Official : @Ruk-Com
• Email : [email protected]
• Telephone: 02-1054385
• Facebook Group :https://www.facebook.com/groups/637973426292134