Scyld Cloud Manager User Guide
Preface This guide describes how to use the Scyld Cloud Manager (SCM) web portal application. Contacting Penguin Computing 45800 Northport Loop West Fremont, CA 94538 1-888-PENGUIN 1-888-736-4846 Technical Support Online Support Portal Login or register - an email address is all that is required.
Revision History Date Revision Comments 7/14/14 1.0 Initial document deliverable. Collaboration effort.
Table of Contents The Scyld Cloud Manager Portal... 5 About Scyld Cloud Manager... 5 About Penguin Computing on Demand... 5 SCM Workflow... 5 Account Owners and Managed Users... 6 Getting Started... 7 Creating a System Account... 8 Creating a Server-Instance... 8 Controlling Virtual Machines... 12 Power On, Power Off, and Reboot VMs... 12 Usage and Reports... 14 Usage... 14 Filtering... 15 Reports... 17 Glossary... 18 Scyld Cloud Manager User Guide 4
The Scyld Cloud Manager Portal About Scyld Cloud Manager The Scyld Cloud Manager (SCM) is a comprehensive private cloud and cluster management system. SCM leverages OpenStack for virtual machine (VM) management, paired with the Ceph storage subsystem for block devices. SCM is designed to optionally integrate with Scyld ClusterWare for cluster management and Scyld Insight for infrastructure monitoring and web-based HPC job submission. The SCM portal is a web-based user interface that enables a user to create and manage virtual machines, called server-instances, along with optional management of storage volumes, unix users and groups, and SSH keys. The SCM portal also enables robust reporting of server-instance utilization and, when enabled, storage and compute cluster core-hour utilization. All capabilities present within the SCM portal are built upon the SCM APIs, which are documented in the "SCM API Guide." About Penguin Computing on Demand Penguin Computing on Demand (POD) is Penguin Computing s public HPC Cloud offering and is powered by SCM. Since POD is a public cloud, it requires some additional components beyond those included with SCM, such as the ability to accept credit cards during registration and link to billing and CRM backends. Throughout this document, however, screen shots from the POD version of the SCM portal will be included as representative examples of how the SCM portal works. SCM Workflow SCM is a highly customizable solution, and as such no two deployments are identical. The options and workflows present in the portal are highly dependent on the exact deployment scenario. This document tries to capture the most common ones, and describe what options are available. At a high level, the web portal is a self-service portal that is intended to enable users to provision and manage their own virtual machines. The first step to gaining access to the portal is registration. Registration can take multiple forms, depending on whether SCM is configured to manage users internally, or whether it is linking to an external user management system, such as Active Directory (AD) or LDAP. When AD or LDAP integration is enabled, registration is more akin to just logging in. A user provides their existing credentials (usually an email address and password) and the SCM portal will verify with the external identity management system both the credentials and that the user has been granted access to Scyld Cloud Manager User Guide 5
SCM. Upon the first successful login to the portal, any needed account information will be automatically populated by pulling it from an external source. When AD or LDAP is not enabled, the user will be prompted to register by providing their email address and choosing a password. An email verification will then be sent, containing a link to continue the registration process. This email link is only valid for a 24 hour period after being issued. If 24 hours pass, the registration will be aborted and the process will need to be started all over again. Account Owners and Managed Users SCM provides permissions for two types of users, an Account Owner, and a Managed User. An Account Owner and a Managed User are mutually exclusive a user can only be one or the other. A Managed User is created when an existing SCM user invites another to join their account by sending them an emailed invitation through the web portal. The invited user can then follow the link in the email and follow a modified version of the registration process. A Managed User cannot invite other users. An Account Owner can create VMs and grant any of their Managed Users the following permissions on the VMs they create: activate_instance: allows reboot, power on, and power off of a VM. delete_instance: allows deletion of a VM. manage_instance_userlist: allows user to grant and revoke "access_instance" permission to other users under the same Account Owner. create_instance: allows creation of new VMs. access_instance: allows user to login to specified VM. An Account Owner can launch any type of VM and see information related to their Managed Users in addition to their own. A Managed User is comparatively more limited. The tasks a Managed User is able to perform are determined by the permission set assigned to them by their Account Owner. A Managed User is not able to launch or manage VMs by default, but may be granted those permissions on a per- VM basis. If a Managed User is granted the "create_instance" permission, and they create a VM, they are automatically granted full rights on that instance, which would include activate, delete, and manage functions. Scyld Cloud Manager User Guide 6
Getting Started The registration process begins using the SCM Welcome screen. The example below illustrates the registration process when LDAP is not enabled. 1. Navigate to the SCM portal provided by your administrator. 2. Follow the prompts for registration. 3. In this example, an email verification link will be sent to you containing a link. Follow the link provided to complete the registration process. Scyld Cloud Manager User Guide 7
Creating a System Account An SCM system account is required when SCM is integrated with an HPC cluster, such as Scyld ClusterWare. If LDAP integration is present, the system account will be created automatically, otherwise the user needs to create one. This will be a Linux username. 1. Create a System Account user name. 2. Enter in a username according to the text box instructions. 3. Once, your System Account has been established, proceed to creating a new server -instance. Creating a Server-Instance Located on the left navigation panel of the SCM screen, the Manage My Server Instances selection allows you to create and manage your virtual machines. When creating a VM, you will need to give the VM a descriptive name and choose an image and instance type. A VM server-instance includes the VM size, how many CPU cores are present, and how much RAM it has. A VM image includes which operating system the VM has and what software is installed on the VM disk. Both images and instance types are administratively defined and created. If there are multiple clusters, that can be selected as well. On non- POD installations this can also give you a choice as to how much local disk space the VM has. Scyld Cloud Manager User Guide 8
1. Click Manage My Server Instances located in the left panel navigation area. 2. The My Server Instances screen provides access to the virtual machine creation wizard. Create a Login Node Scyld Cloud Manager User Guide 9
3. Enter a meaningful name for your new VM in the following screen and select from the available attribute radio buttons, to choose a VM instance type. You will be able to specify an image (this controls what OS and software is installed in the VM) and an instance type. Available serverinstance types are defined by your system administrator. Note: A VM Build should typically take between 1 to 3 minutes. Watch the Status column on the screen to check for progress or errors. 4. Click Continue. Scyld Cloud Manager User Guide 10
Upon successful VM creation, a confirmation message will be displayed informing you that the VM has been created and BUILD will appear in the Status column. Following a successful build, your IP address will appear in the IP column and Status will be ACTIVE. Scyld Cloud Manager User Guide 11
Controlling Virtual Machines Power On, Power Off, and Reboot VMs The My Server Instances screen provides easy access to server functions. 1. To power on or off your server, select the Power Off/Power On button located below your VM details area. 2. Confirm your selection. Scyld Cloud Manager User Guide 12
A successful power cycle will change the server status in the Status column. When the server is powered off, no IP address will be displayed in the IP column. When a VM is powered on from an off state, the IP address subsequently displayed may not be the same IP address previously displayed. If the VM has instead experienced a reboot (not power recycled) the IP address will not change. Note: Once you successfully power on or power off a VM you will receive a confirmation like the one shown above. Otherwise, you will see an error message like the one shown below. Scyld Cloud Manager User Guide 13
Usage and Reports Selecting Usage and Reports from the navigation panel on the left side of the screen will display your current and past SCM usage in graph form. You can also download usage reports for core-hours, serverhours, storage, and completed jobs that have been submitted. Usage and Reports displays usage data based on billing cycles. Billing cycles are monthly with the cycle ending on midnight GMT on a given day of the month. Not all SCM implementations will include rates. Only the SCM implementations that have a Rate Manager configured (mm-driver in the settings section) will display rates. All users have the ability to view their own data. Account Owners can view the usage data of all of their Managed Users. Any Managed User who has been granted access can also see the other users in their account. Reports reports can be filtered by unix groups, if they are present. Core-Hours storage and core-hours can be customized based on the SCM configuration. History history reports can be downloaded in.xls or.csv file formats. Usage Generally usage statistics are reported in real-time; however core-hour reporting is often delayed from the job scheduler. Scyld Cloud Manager User Guide 14
Filtering The usage graph shown below displays the amount of storage allocated, core-hours, and active login node hours over time for a given month. Account Owners and Managed Users with special permissions can also filter usage data by user with the dropdown selection menu. The summary bar, shown in the portion of the screen below the usage graph, is a summary of all usage for the current billing period. Visibility of these values follow account privileges, i.e. an Account Owner will be able to see usage from all users, while a Managed User may only be able to see their own, unless they have been granted access to see more. Scyld Cloud Manager User Guide 15
Compute Usage and Storage Detail provides a way to filter usage by user via a selection menu. Compute Usage by Project displays usage by project, an optional qsub flag. Login Node Usage Detail displays hours, rate, and total by Server Instance. Scyld Cloud Manager User Guide 16
Reports The Usage History portion of the screen offers individual downloadable files, as well as a combined report option which includes all four reports together. Scyld Cloud Manager User Guide 17
Glossary Ceph LDAP Instance Type OpenStack POD SCM Server Instance SSH A free software storage platform designed to present object, block, and file storage from a single distributed cluster. Lightweight Directory Access Protocol is an open, vendor-neutral, industry standard application protocol used for accessing and maintaining distributed directory information services over an IP network. A server-instance defines the resources for a virtual machine, meaning its RAM, core count, hard disk space. A free and open-source software cloud computing platform, primarily deployed as an infrastructure-as-a- solution (IaaS) and released under the terms of the Apache License. Penguin Computing On Demand. Scyld Cloud Manager. Synonymous with Virtual Machine. It is a virtualized compute resource comprised of an instance type and an image. A cryptographic network protocol for secure data communication, remote command-line login, remote command execution, and other secure network services between two networked computers. Scyld Cloud Manager User Guide 18