Managing an Ark Console¶
The Dashboard tab displays icons that provide quick access to Ark information and features. If the tab is accessed from the top-level Ark Servers node, it includes informational links that are applicable to all consoles. If the tab is accessed from a console name node, the tab includes information specific to that console:
The Quick Links icons allow you to:
- Click the Create Cluster icon to define a new cluster on the selected console.
- Click the Installation Properties icon to review the deployment properties for the selected console.
- Click the Download Console Logs icon to download the log files for the selected console.
The Resources icons provide access to:
- Click the Instances icon to review information about the instances that reside on the console.
- Click the Snapshots icon to review information about console backups.
- Click the Events icon to review information about events that have been logged for the selected console.
The EDB Ark Tutorials & Documents icons provide access to information that is specific to the Ark version that is deployed on the console:
- Click the Ark 3.0 Release Notes icon to review the release notes.
- Click the Getting Started Guide icon to review a usage guide for the Ark console.
- Click the Administrative User Guide icon to review the Ark Administrative User Guide.
To view console properties, select the name of a console in the PEM Browser tree control and select the Properties tab.
Panels on the Properties tab display configuration details for the console.
The General panel displays:
- The Name field displays the console name.
- The Host name displays the IP address of the console.
- The Port field displays the port at which a browser can connect to the console.
- The Protocol field displays the connection protocol used to connect to the console.
- The API version field displays the version of the API used to manage console objects.
- The Connected? field displays the current state of the console.
The Connection panel displays:
- The Username field displays the name of the user that deployed the console.
- The Tenant/Role field displays the name of the tenant or role in which the console is hosted.
- If deployed on an OpenStack host and using API version 3.1 or later, the Domain name field displays the OpenStack domain in which the console is hosted.
You can use options on a console’s context menu to manage the console.
Use options on the Ark Server context menu to manage a server registration; right-click on the console name in the PEM Browser tree control and select from the menu options:
|Refresh||Select Refresh to update the definition of the server or server objects that reside on the console.|
|Connect Server||Select Connect Server to connect to the selected Ark console. After authenticating with the Ark console host, the tree control will display a host-specific icon to the left of the console name. Expand the tree control to review and manage objects that reside on the console.|
|Delete/Drop||Select Delete/Drop to delete the registration of the selected Ark console. Please note that deleting a console registration does not remove the console from the backing database. PEM will confirm that you wish to delete the registration before removing it.|
|Download console logs||Select Download console logs to download the log files from the selected console.|
|Installation options||Select Installation options to open the Installation options dialog and review or modify console deployment properties.|
|Disconnect Server||Select Disconnect Server to disconnect from the selected Ark console.|
|Properties||Select Properties to review the properties specified when registering an Ark console; if the server is disconnected, you may modify the property values. After modifying property values, select Save to preserve your changes.|
Downloading Console Logs¶
Use options on the console Dashboard panel or context menu to download a zip file that contains the server logs for the underlying application server. You can use the log file to confirm changes to server status or verify server activity. To download a console log you can either:
- Right click on the console name in the PEM Browser tree control and select Download console logs from the context menu.
- Highlight a console name in the tree control and navigate to the Dashboard tab; then, select the *Download Console Logs option from the Quick Links panel.
A popup will ask you to confirm your selection; click OK to download the log file.
You can also review the console logs via an ssh session. Log files are stored in /var/log/edb-ark; the current log file is /var/log/edb-ark/ark.log. Use the Linux tail utility to display the most recent entries in any of the server logs. For example, to review the last 10 lines in the server log file, use SSH to connect to the console host’s backing database and enter:
Where file_name specifies the complete path to the log file. Include the -F option to instruct the tail utility to display only the last 10 lines of the log file, and new log file entries as they are added to the file:
tail -F file_name