Cloud Control Panel (CCP) Admin Guide

Transcription

1 Cloud Control Panel (CCP) Admin Guide Version 3.2.0: Copyright 2012 DNS Europe Ltd. All rights reserved. Cloud Control Panel (CCP) Admin Guide v3.2.0

2 Table of Contents 1 Introduction 5 Audience 5 Prerequisites 5 Purpose 5 Using this guide, you will be able to 5 Terms 6 2 Login procedure 7 3 Initial Configuration Steps Adding Private Clouds to the CCP Setting up Parameters Setting up Workers Setting up IP addresses Setting up notification templates Setting up other Global Configurations Setting up Constants Understanding Metadata Understanding Applications, Templates & User-Templates Importing included User-Template Applications Importing your own Applications & Templates Set User-Template Customising in-page Help 30 4 Managing Applications Listing a User s applications Listing a Private Cloud s applications Application details Configuring CCP settings for Applications Setting a Template Application as a User-Template Deleting & managing deleted Apps 37 2

3 4.7 Creating a new Cloud Server application (Admin User) 38 5 Managing Private Clouds Adding a Private Cloud Retrieving Private Cloud details Private Cloud function buttons Deleting a Private Cloud 43 6 Using the Job Console Job List Workers 45 7 Managing Users Adding a new User Listing Users Manage User features 47 8 Managing IP Pools 48 9 Using Subnets Adding a subnet Adding subnet constants Assigning a subnet to an IP pool Managing Orders Listing Orders New order process for existing customers Configuring Welcome for End-Users Content Snippets Global content snippets Application-based snippets Managing your Account Visually Customising CCP Using the CCP API Configuration 62 Metering API functions 63 Ordering API functions 63 Invoking Functions 63 3

4 Output formats 64 Units notation 64 Method Descriptions 65 Sample Code Integrating existing order form with payment processor 82 External Order form process 82 3rd Party payment integration 82 Creating a payment processor integration script 84 Non Payment Gateway integration 84 Visual customization of order form Language localization Download dictionary file Dictionary format, file name and preview options Dictionary file contents Uploading your translations Template translation 89 4

5 1 Introduction Welcome to the DNS Europe AppLogic Cloud Control Panel (CCP) Administrators Guide. Audience CCP administrators who are responsible for installing, configuring and maintaining the CCP. An intermediate competency of AppLogic is required. Prerequisites Before attempting to use this manual, please ensure you have successfully initialized your CCP application using the CCP Installation Guide document. You will also need the following information & resources: IP range assigned to any Private Clouds that you want to be managed by your CCP installation. The controller IP address of any Private Clouds that you want to be managed by your CCP installation. Access to default values (e.g. gateway, netmask) for any Private Clouds that you want to be managed by your CCP installation. Purpose The purpose of this document is to guide the configuration and operation of your CCP after the initial installation. It provides detailed instructions on topics ranging from adding private clouds to your CCP, to managing users, cloud server user-templates and advanced settings. Using this guide, you will be able to Enter initial settings to get started quickly Import your Private Cloud(s) to be managed by the CCP Customise, import and configure Applications & Templates Configure metadata for your CCP end users Add and manage CCP users Manage your IP addresses with the CCP IP Pool 5

6 Audit user activities & jobs with the Job Console View & Manage Cloud server orders Terms Grid and Cloud AppLogic has historically used the term Grid to describe their product however DNS Europe uses the term Cloud. Both of these terms may be used interchangeably in this document specifically when making references to AppLogic s native information. Templates The CCP requires that Application templates be imported to the CCP and then converted to User-Templates in the CCP. After this they can then be automatically deployed, managed and scaled through the CCP GUI. The Eval version of the CCP includes 2 default templates (CentOS basic server & CentOS LAMP server). You many also import your own applications and templates for use within the CCP. Cloud Server and Application We refer to any application that is deployed in a Private Cloud from a template as a Cloud server or an Application. Both of these terms may be used interchangeably in this document. Bandwidth Bandwidth referred to in this documentation is the internal Bandwidth (Bw) assignments for AppLogic applications and components. It does not relate to the external Internet bandwidth that users may consume through use of their Cloud Servers. 6

7 2 Login procedure To login in to your CCP, enter the username & password defined during the CCP Installation process. Figure 1: CCP Login screen Once you have completed the login step, you will be presented with the Dashboard screen from where all CCP functions can be accessed. Figure 2: The Dashboard The following options are accessible from the CCP Dashboard: 1. Dashboard List applications by Username or SupportID 2. Applications managing the applications 3. Private Clouds managing your Private Clouds 4. Job Console - reviewing and managing various system jobs 5. Users - managing CCP users 6. IP Pool - managing the IP Pool 7

8 7. Orders - managing orders 8. Account - managing account information 9. Configurations configure and global settings 10. Help Link to configurable help resource URL 11. Logout ending your CCP session 8

9 3 Initial Configuration Steps To start using the CCP, you must first add a Private Cloud. This means that the Private Cloud will then be accessible and controllable from the CCP admin interface. 3.1 Adding Private Clouds to the CCP To add a Private Cloud to CCP 1. Login to the CCP as an Admin user 2. Click the Private Clouds primary navigation tab from Dashboard 3. Click Add Private Cloud button on secondary navigation 4. Complete the following form details: Private Cloud - (New name for Cloud within the CCP, e.g. My First CCP Cloud*) Controller IP Address - (IP address of controller for your Grid, e.g ) Description - (e.g. Cloud added to CCP for testing) Private Cloud Name - (From AppLogic, field Grid Name **) AppLogic version - (From AppLogic, field AppLogic Version **) * must be unique ** output from grid info command from AppLogic shell Once you have submitted these form details, click Toggle Details to view the new CCP Private Cloud information. NOTE: please allow a minute or so for the CCP to pull Private Cloud details from AppLogic after you have clicked Toggle Details. NOTE: If you do not see the Private Cloud details after a minute, the most likely explanation is that the ssh keys have not been correctly installed. Please refer this issue to your Administrator who was responsible for carrying out the initial CCP installation. Instructions for testing whether ssh keys are correctly installed: 1. Open AppLogic GUI 2. Click on application ccp-xe_v Right click on COREAS and select Login 4. Type: su web then enter 5. Type: ssh root@<controller IP address> 3t grid info [note: omit <> characters] 6. You should then see a list of Grid Information starting with Grid Name, 9

10 Grid Description etc. If you cannot see this info list, please advise your Administrator to re-install ssh keys. If you can see this info list, please contact for assistance. 3.2 Setting up Parameters Parameters define the limits of selectable resources such as CPU, RAM and Volume Size that can be assigned to component or appliance on your Private Cloud. As well as defining limits, parameters can also set the dependencies between CPU and RAM to ensure that with a given selection for CPU, there is a minimum and maximum RAM restriction. The purpose of this feature is to avoid the potential situation (for example) where all CPU resources on your Private Cloud are fully assigned without a corresponding utilisation for RAM resources. If you do not require this limitation for your own purposes, a sufficiently wide tolerance can be set to ensure any combination of CPU and RAM assignments are achievable. To access and configure parameters 1. Click Private Clouds primary navigation tab 2. Click Parameters button next to the Private Cloud in question Understanding Parameter fields On the parameters page you will see the following field types: Global Settings Admin Settings for Minimum CPU: this is the minimum number of CPU cores that can be assigned by the admin-user to a component either for a 32-bit or 64 bit application. The theoretical minimum can never be lower than Admin Settings for Maximum CPU: this is the maximum number of CPU cores that can be assigned by the admin-user to a component either for a 32-bit or 64-bit application. This can never exceed the amount of CPU cores available on one physical server in your Private Cloud. Admin Settings for Memory Min: this is the minimum amount of RAM that can be assigned by the admin-user to a component either for a 32-bit or 64-bit application. The theoretical minimum can never be lower than 64M. Admin Settings for Memory Max: this is the maximum amount of RAM that can be assigned by the admin-user to a component either for a 32-bit or 64-bit application. This can never exceed the amount of RAM available on one physical server in your Private Cloud. 10

11 CPU step: The value in this field defines the steps that CPU will increase or decrease when the user is assigning the exact CPU amount they require per application component. Memory step: The value in this field defines the steps that RAM will increase or decrease when the user is assigning the exact RAM amount they require per application component. Minimum Volume Size: This defines the minimum volume size that can be selected when the user is assigning the sizes of volumes per application component. The theoretical minimum can never be lower than 1M. Maximum Volume Size: This defines the maximum volume size that can be selected when the user is assigning the sizes of volumes per application component. Minimum Bandwidth: Setting this value will allow you to define the minimum internal application bandwidth that can be set between components within any application on the Private Cloud. Maximum Bandwidth: Setting this value will allow you to define the maximum internal application bandwidth that can be set between components within any application on the Private Cloud. 32-bit OS Min CPU: this is the minimum number of CPU cores that can be assigned by the enduser to a component for a 32-bit application. This can never be lower than Max CPU: this is the maximum number of CPU cores that can be assigned by the enduser to a component for a 32-bit application. This can never exceed the amount of CPU cores available on one physical server in your Private Cloud. Min Memory: this is the minimum amount of RAM that can be assigned by the end-user to a component for a 32-bit application. This can never be lower than 64M. Max Memory: this is the maximum amount of RAM that can be assigned by the enduser to a component for a 32-bit application. This can never exceed the amount of RAM available on one physical server in your Private Cloud. NOTE: MB are denoted by M after a numerical value, GB are denoted by G after a numeric value. e.g. 256 MB = 256M, 4 GB = 4G. Angle of Min Line: this defines the relationship between CPU and RAM selections at the lower end of RAM selections. For 1 CPU core selected, the minimum amount of RAM that can be selected is defined by the value in this field. For 1.5 CPU cores, the minimum RAM is 1.5 x the value in this field. Offset of Min Line: The value in this field can be positive or negative and applies a modifier to the Angle of Min Line in a similar fashion to the way Offset of Max Line applies to the Angle of Max Line. 11

12 Angle of Max Line: this defines the relationship between CPU and RAM selections at the upper end of RAM selection. For 1 CPU core selected, the maximum amount of RAM that can be selected is defined by the value in this field. For 1.5 CPU cores, the maximum RAM is 1.5 x the value in this field. Offset of Max Line: The value in this field can be positive or negative and sets a modifier applied to the maximum RAM selection available. Where as the Angle value defines a fixed ratio between CPU & RAM, the offset will apply as a fixed value, for any value for CPU that is selected. E.g. If the Angle of Max Line is 1024, then the maximum amount of RAM that can be selected for 1CPU core is 1024M. However, if the Offset of Max Line is set at 512, then the maximum amount of RAM that can be selected for 1 CPU is increased to 1536M ( ). Additionally, for a CPU selection of 2 cores, the maximum amount of RAM that can be selected is 2560M ((2 x 1024) + 512). 64-bit OS Since 64-bit applications are capable of employing more than 4GB RAM, the parameters in this section allow the CCP admin to configure different values than that of the 32-bit OS section. The function of these parameters otherwise follow the same descriptions as the 32-bit OS parameters above. Testing different Parameter settings Before setting & saving parameters for a Private Cloud, admin users can try out different configurations that are then represented by a slider selection tool without impacting the actual Parameter settings for the Private Cloud. Figure 3: Slider selection tool 1. Click Private Clouds primary navigation tab 2. Click Parameters button next to the Private Cloud in question 3. Click Test Sliders button NOTE: Any changes made on the Test Sliders page cannot be saved and must be transferred manually to the Parameters page if changes you want to save those changes. 12

13 3.3 Setting up Workers The CCP executes Jobs (actions on your Private Cloud) using a system module called a Worker. These tasks that these workers execute on the Private Cloud exert load and therefore you can define exactly how many workers you wish to have Started. The fewer workers that are started, the lower the maximum load on your Private Cloud can be. NOTE: We recommend a minimum of 3 started Workers for the CCP to function. To access the Worker Watcher, Click the from the Job Console. button on secondary navigation WARNING: The task that places the highest load on a Private Cloud is Volume Resize. We recommend that if you are planning a Volume Resize, that you temporarily reduce the number of started Workers to minimise the overall load on your Private Cloud. Workers Watcher Figure 4: Workers Watcher List From the Workers Watcher List you can access the following information and features: Name: the system-generated name of the Worker Last Seen Time: the last time the Worker has been active Timeout: the timeout period (measured in seconds) set for the Worker. This period can be changed by clicking the Set Period button in the Actions column on the Workers List. OS User: the username of the owner of the PHP script that owns the Worker process Server: The application/cloud Server name where the CCP Worker is running. Process: the Linux process number created by running the Worker PHP script Time Logon: the time the Worker was started Action: the description of the current action being carried out by the Worker 13

14 Command: the current command being executed by the Worker on the Private Cloud Job: the system-generated job description currently being executed by the Worker Actions: the available Worker actions: Start: click this to start the Worker Stop: click this to stop the Worker (and free its resources to the Private Cloud) Restart: click this to restart the Worker if required Set Period: set the desired frequency for worker to check if there are new jobs (note: time measured in seconds) 3.4 Setting up IP addresses When you have successfully added a New Private Cloud to the CCP, click IP Pool on the primary navigation to add new IP addresses. IP addresses can then be automatically assigned to new Cloud Servers deployed by the CCP. To create a new IP Pool in the CCP: 1. Click Pool List secondary navigation button 2. Click Add Pool 3. Provide a name for the IP Pool (no spaces or - characters) You should the see the new IP Pool in the Pool list. Figure 5: IP Pool List To remove an IP Pool: An IP Pool must be empty of all IP addresses before it can be removed. When an IP Pool has no IP addresses assigned, the Delete IP Pool button appears in the Action column of the IP Pool List page. To assign an IP Pool to a Private Cloud: 1. Click Private Cloud Pools secondary navigation button 2. Select the radio button to the left of the IP Pool in question 3. Click Next 14

15 4. Select the checkbox on the left of the Private Cloud to assign the IP Pool to 5. Enter a sortweight to define in which order IP addresses are listed on the IP Address Search page. Lower sortweight = higher position on IP list. Figure 6: Assigning an IP Pool The CCP will now be able to automatically assign the newly added IP addresses to Cloud Servers as they are deployed based on the order in which IP addresses appear on the list. NOTE: The CCP requires 4 IP addresses assigned to it in order to function correctly. These IP addresses will have been entered during the CCP Installation process. If these IP addresses are included within the range that has been added to the CCP during this configuration process, it is very important to remove these addresses from a specific pool (later in this section we explain how to remove IP addresses from a pool) so that the CCP does not try to re-assign them to new Cloud Servers. NOTE: Any IP address added to the CCP IP Pool must first have been added at the AppLogic native Grid level via the 3t shell. To add IP addresses to an IP Pool: 1. Click the Pool List secondary navigation button 2. Click the Insert IP Address button on the right of Pool list (see Figure 5) 3. Enter IP address range (Start & End) To move an IP address from one IP pool to another: Figure 7: IP Pool Search 15

16 1. Click IP address search secondary navigation button 2. In the list of IP addresses, click Move button next to IP address to move 3. In the pop-up window, select the desired IP pool It is possible to move multiple IP addresses to another IP pool, provided that they are not assigned to any application. Select the desired IP addresses and click the Move IPs button in the top-right corner of the IP Pools Search page. To remove an IP address from an IP Pool: 1. Before removing an IP address, make sure that is it not assigned to any application 2. Click the Delete button to the right of the any free IP address (this option will only appear for an IP address which is not assigned to an application). It is possible to remove multiple IP addresses from an IP Pool, provided they are not assigned to any applications. Select the desired IP addresses and then click the Delete IPs button in the top-right corner of the IP Pools Search page. To assign an IP addresses to a specific user/application: To be able to assign and IP address to a specific user or application, first check that it is not assigned to another application. 1. Click the Edit button to the right of the relevant free IP address 2. Change User to another user 3. Select the Cloud Server to assign the IP address to It is also possible to add multiple IP addresses to a specific user. Select the desired IP addresses and then click the Add IPs to User in the top right corner of the IP Pools Search page. IP addresses which are assigned to a specific user (but not assigned to an application by the CCP) can be reassigned, or Returned to IP Pool. NOTE: If the goal is to assign an IP address to a specific application, it must first be assigned to a specific user who owns the application in question. If an application is imported into the CCP from the Grid (already configured with specific IP addresses belonging to one of the IP pools), that IP address should first be assigned to the user in question. This will prevent the CCP from assigning it to another application and causing an IP conflict. 3.5 Setting up notification templates The CCP allows administrators to configure templates for various notifications provided by the system to Admin and End Users. 16

17 Linking the CCP to external SMTP server functionality is enabled by configuring the CCP to work with an external SMTP server by editing a configuration file (config-ccp.ini) via ssh/ftp connection. NOTE: Instructions for setting up the CCP to work with your external SMTP server can be found in the CCP Installation Guide. To configure an template: 1. Click Configurations primary navigation tab 2. Click Configurations secondary navigation button 3. Click on the Name of the template you would like to configure 4. Complete the required details for Names, addresses, Subject and Body 5. Click Send to activate automated sending 6. Click Save to activate changes NOTE: In the current version of the CCP, %% tags may only be used in the Body, not the subject. 3.6 Setting up other Global Configurations Additional global configurations are required to ensure correct operation of the CCP application. These can be found by: 1. Click Configurations primary navigation tab 2. Click Global Configuration secondary navigation button From the Global Configuration page you can define the following parameters: Fallback address & name: the CCP will use this as a fallback address in case that sending to any address configured, or customer s address fails. Order form settings Use CCP order form: Setting this to On will enable external order form for new customers. If this is set to Off, only customers with a CCP account will be able to order new Cloud Servers/Apps. See 14 Using the CCP API on page 62 Order Processing Mode: This setting controls whether or not new orders from existing customers (i.e. made through the CCP account, Order New Cloud Server tab) are provisioned automatically or manually by the administrator. 17

18 NOTE: Setting of automated or manual processing from new customer orders via the external order form is configured in the API Ordering script. See 14 Using the CCP API on page 62 Display prices for existing users: Setting this to on will allow End Users to see and calculate the pricing for new applications ordered within the CCP. Currency Code: This 3-digit currency code is used where a price is shown to the User, for instance on the external order form. Ordering API secret passphrase: Used while authenticating access to the CCP when integrating external Ordering API scripts. Online payment URL: Used when integrating the order provisioning process with a 3rd party payment gateway. Custom URL for internal order form: URL of external location where your custom-built order form for logged-in CCP users resides. It will replace Order New Cloud Server URL on the EndUser CP. API Settings Enable Metering API: Setting this to On will allow external systems to access the resource metering data via an API provided with the CCP. See Metering API functions on page 63 Enable Ordering API: Setting this to On will allow external access to the ordering process via an Ordering API provided with the CCP. Username for Metering API: used for authenticating access to the CCP when integrating external Metering API scripts. This Username should be for a user set up in the CCP with a billing role. Password for Metering API: used for authenticating access to the CCP when integrating external Metering API scripts. This password should be for a user set up in the CCP with a billing role. User Limits Maximum allowed CPU, Memory, Volume & Bandwidth for User: here the administrator can define what the maximum allowable total assignment is per user, in total for all of their applications. This is a system-wide setting for all grids and all users managed by the CCP instance. Help content Here the administrator can define their own URL for help content and URL for Support details of services, terms, etc 18

19 3.7 Setting up Constants Each Private Cloud added to the CCP has a set of default values (Constants) that may need to be referenced when provisioning Cloud Servers. These are fixed values such as gateway, IP address, dns server, netmask, passwords etc. During this initial configuration you will need to tell the CCP what these values are for your Private Cloud. Each template that you import/create may require access to different Cloud-level constants. For initial configuration, please create the constants defined below. These will allow the CCP to function correctly with the two provided templates (CentOS basic & CentOS LAMP): To add a constant: 1. Click Private Clouds primary navigation tab 2. Click Constant button next to the Private Cloud in question 3. Click Add Constant from the secondary navigation 4. Provide Name, Value and a Description (Label) Initial Constants required: Name Value Description/Label any address /0 Any address admin admin Admin Username dns1 Enter your real value Primary DNS server dns2 Enter your real value Secondary DNS server gateway Enter your real value Default gateway hostname Enter a temporary value Hostname for Private Cloud mail hostname Enter a temporary value Hostname for server firewall password Enter a temporary value Firewall appliance password netmask Enter your real value Subnet mask rootpassword Enter a complex password Root password for all appliances webmasterpassword Enter a complex password Webmaster password for web server zero 0 System requirement NOTE: Value can be numerical IP addresses or alphanumeric without spaces. 19

20 3.8 Understanding Metadata The CCP s Metadata function allows the administrator to define exactly which properties of an application are presented to the end user, whether or not they are editable, and even in which language they are presented. To access application metadata 1. Click Applications primary navigation tab 2. Select the Private Cloud in question from the drop-down 3. Click Get List button 4. Click on an application name from the list 5. Click button at top of application details page Metadata options Template: If the application was provisioned from a user-template through the CCP, this field will show the name of the user-template used to create the app. However if the app was provisioned directly, i.e. not using the CCP, Admin user can enter the name of the application or template used. OS Icon: choose from the provided list of OS icons. Visible resources: Here you can control whether or not end-users can see the CPU, RAM and Bw (Bandwidth) resource values for their Cloud Servers. NOTE: Bw (Bandwidth) here refers to the internal AppLogic application bandwidth settings rather than the external internet-facing traffic allowance that may be defined elsewhere for your Cloud Servers. As many end-users are unaware of this feature of AppLogic, it is normally advisable to have the Bw visibility set to off. Cloud Server Info: This information is the same as an AppLogic admin would see through executing the application info command in AppLogic 3tshell. Whether or not this information is shown to Admin users can be changed by ticking or un-ticking the appropriate checkbox. In addition to setting visibility, admin can also provide a more user-friendly metadata name for use within the CCP as well as a sorting order for the item on the Cloud Server Info list. Admin can also set the Meta Conversion field that provides a drop-down containing options for different field types that will be shown. For example, if Boolean is selected, the admin will see a drop down field with yes or no options. If the field is designed for any type of information, or is a type not listed on the Conversion drop-down, then leave this blank. 20

21 NOTE: In general, most of this information will not be meaningful to the end-user and so visibility should be set to off. However the amount of information that an admin agent can have access to requires more detailed consideration.cloud Server Config: This is perhaps the most complex part of configuring the Metadata settings and relates directly to the properties of the AppLogic application or template that has been imported from your Private Cloud into the CCP. Cloud Server Config fields Property: property name, for example dns1, dns2, gateway. WARNING: Any Property with a. in the name, should NOT be visible to Admin or End-Users otherwise later app configuration processes may fail. Property: property name, for example dns1, dns2, gateway. Value: if a value is defined within your AppLogic application, it will be displayed here. Name: this can be set by the CCP administrator to be clear and memorable. Sort: this defines the list order in which with the property appears to users. User visible: if this field is checked, then the property will be visible to the end-user. User lock: if this field is checked, then the end-user cannot change this value. Agent visible: if this field is checked, then the property will be visible to agent users. Agent lock: if this field is checked, then an agent user cannot change this value. Component: If you wish to present information about this property to the end-user as a component-specific property, rather than in the general application properties, you would use this drop-down field to select the component to which the property applies. Mand: if this field is checked, then the end-user is required to enter a value in this field. Value: this can be defined by the CCP or blank. If it is CCP defined, then the end-user will be unable to change it via the CCP. If this field is left blank, then it is user-definable. How the value for this field is set, relates to the selection in the next column Function. WARNING: If field is a Password, values should contain alphanumeric characters only Function: in this field you have the option to define whether the value is to be taken from a Private Cloud Constant, from an IP pool, from a Subnet Constant, or entered by the user (leave field blank). 1. If it is a constant, then please ensure Constants have been configured (See 3.7 Setting up Constants on page 19). 2. If the value is an IP address, and IP Pool is selected, the CCP will assign the next available IP address to this field, provided that IP Pools have been configured for the Private Cloud (See 3.4 Setting up IP addresses on page 14). 21

22 3. If the value is a Subnet Constant, in the next column (the Constant drop-down menu) a list of configured subnet constants will be offered (See 9 Using Subnets on page 49). 4. This Function field should only be left blank if the previous field Value is also blank. In such cases, provided the property is visible it will be presented as blank and editable field to the end-user. The Random string option allows you to generate random strings for use when creating passwords. If you want to hide characters, then select the Password option in the Type column. Constant: if the Function field has Constant selected, then here you will need to select which Constant is to be used. If the Function field has Subnet Constant selected, then here you will need to select which Subnet Constant is to be used. Type: This field need only be specified if the property is either a password (in which case the field value is always shown as asterisks) or a Windows template hostname (in which case the field value must not contain a. ). These rules will then be forced on the enduser view of applications properties. Conversion: this field offers a drop-down containing options for different field types that will be shown to end-users. For example, if Boolean is selected, the end-user will see a drop down field with yes or no options. If the field is designed for any type of information, or is a type not listed on the Conversion drop-down, then leave this selection blank. Components: these fields allow you to define exactly what is displayed to an end-user if that field has been defined as being visible (tick checkbox Meta Visible ). You are also able to control if the end user is NOT allowed to change the resources of this component (tick checkbox Meta Locked Resources ) and to define whether or not the component is 64-bit (which will allow higher RAM allocations if the checkbox 64-bit? is ticked). Admin can also define a more user-friendly Meta Name for this field. NOTE: The Metrics for resource usage presented to an End-User (Dashboard > Graphs & Billing ) can be configured to NOT record certain component metrics if required. Hidden components, which are not visible to End-users, are automatically excluded from metering data as customers might be confused that their visible resources equate to less that the metrics which appear in the billing graph. To hide a component, uncheck Meta Visible. Visible components with unlocked resources (End-Users can adjust component resources) are automatically metered. Metering is mandatory. To set a component to be visible and unlocked, check Meta Visible and uncheck Meta Locked Resources. Visible components with locked resources have the option of disabling metering. This would be useful, for example, if you choose to exclude the resources used by locked components (where End-Users cannot adjust resources) from the Metrics recorded for 22

23 a customer s cloud server. Instead, you may then choose to account for those fixed component resources within a fixed monthly fee for the service. To set your component to be visible, with locked resources that are metered, then check Meta Visible, Meta Locked Resources and Metered. To disable metering, uncheck Metering. Volumes: all volumes attached to the application are listed here on a per-component basis. User-friendly names can be assigned to these volumes (Meta Name) and you can define if the volumes are NOT visible to end-users (tick checkbox Meta Visible ). NOTE: The CCP records actual resource metrics only for volumes that are visible and connected to a component that is also visible. Volumes attached to non-visible components are not metered and should therefore be accounted for in the base monthly cost of the application. Previewing your metadata changes Once you have completed your Metadata setup, you can preview the changes you have made as follows: 1. Click Save Metadata button 2. Either: click Cloud Server Details Admin Preview button 3. Or: click Cloud Server Details User Preview button 4. Or: click Order Form Preview button NOTE: You can also copy metadata configurations from another Cloud Servers by clicking the Copy Metadata. This is useful if two configurations are largely the same. 3.9 Understanding Applications, Templates & User-Templates Applications In the classical AppLogic sense, an Application is a pre-configured encapsulated entity with appliances and virtual infrastructure components. However an Application need not necessarily be a Template or a User-Template. Any AppLogic Application my be imported into the CCP and controlled via the CCP GUI. However automatic provisioning of copies of this application will not be possible within the CCP. Templates Templates are AppLogic Applications that have been constructed according to 3tera s guidelines for creating Application Templates. 23

24 Any AppLogic Template my be imported into the CCP and controlled via the CCP GUI. However automatic provisioning of copies of this Template will not be possible within the CCP, until this Template has been defined as a CCP User-Template (see next section). NOTE: An AppLogic Template is fundamentally the same as an AppLogic application, with two important differences: 1. You need to tell AppLogic that the Application is a Template (by setting the template parameter within AppLogic) 2. You need to ensure that when Applications (or Cloud Servers) are provisioned from the Template, that they will run automatically after creation. This is generally achieved by cleaning up any test settings/parameters in the application before converting to a template. You may then need to create and include scripts within the template that configure the necessary parameters to ensure those applications (created from the template) will operate correctly. For more information, please see the 3Tera documentation. User-Templates User-Templates are AppLogic Templates that have been defined as User-Templates within the CCP. This allows the CCP to create copies of this Template through the Order Form section of the CCP. See 4.5 Setting a Template Application as a User-Template on page Importing included User-Template Applications Provided with the CCP are two pre-prepared Cloud Server templates: Basic CentOS 32bit Cloud Server (cos57_32_v3) LAMP CentOS 64bit Cloud Server (cos57_64_lamp_ftp_v3) You can import these templates to your private cloud by first downloading from our FTP server, directly to your Grid controller and then importing them as follows: NOTE: To enable download of the templates, your controller IP address should be enabled on our FTP server s firewall, so if not, contact ccp-support@dnseurope.net 1. Go to your controller s /vol/_impex directory and issue the following commands: wget -r --user=<username> --password= <password> ftp://ccp.gridsrv. net/cos57_32_v3 wget -r --user=<username> --password= <password> ftp://ccp.gridsrv. net/cos57_64_lamp_ftp_v3 As with the CCP application and Catalog, these templates need to be moved from the download folder, to /vol/_impex directory. To do that, issue the following commands: mv /vol/_impex/ccp.gridsrv.net/cos57_32_v3 /vol/impex/ 24

25 mv /vol/_impex/ccp.gridsrv.net/cos57_64_lamp_ftp_v3 /vol/impex/ To complete importing of templates, type the following commands app import cos57_32_v3 app import cos57_64_lamp_ftp_v3 NOTE: Please replace USER and PASSWORD with information sent to you in your Welcome (Download username & Download password). 2. Start then Stop both templates in AppLogic NOTE: Any Template must be started and stopped at least once on your private cloud before importing into the CCP. This ensures that temporary volumes (volcaches), that are created on first runtime, are imported to the CCP along with non-volatile volumes. 3. Click Applications primary navigation tab 4. Click Private Cloud server List from the secondary navigation 5. Choose your Private Cloud from the drop-down and click Get List button 6. Click on Refresh Cloud Server list 7. Locate the Cloud Server (Application) that you want to import and tick the checkbox to the left of the Cloud Server Name. 8. Click Import to CP button on right, above Cloud Server list Once the import process is complete, these app templates will be visible from the Cloud Server List for your Private Cloud and need to be converted to User-Templates: See 3.12 Set User-Template on page 29 The next step will be to configure metadata for the two included templates: Set metadata for Basic CentOS 32bit Cloud Server template To access the template s metadata: 1. Click Applications primary navigation tab 2. Select the Private Cloud in question from the drop-down 3. Select Only Templates from the Show User Templates drop-down 4. Click on template name (cos57_32_v3) from the resulting list Enter required(!) template description data: 5. Click Edit name and description button 6. Enter name: Basic Centos 32bit Cloud Server 7. Enter a more detailed Description & Save. 25

26 For an example of how you might configure metadata specific to this template, please see setting from the screenshots below: Figure 8: Example metadata configuration for Basic Centos 32bit Cloud Server template NOTE: The example metadata configuration shown is only one possible way in which metadata can be configured for this template. You may require a different configuration depending on your deployment requirements. More information on this template can be found at: Cloud-Server 26

27 Set metadata for LAMP CentOS 64bit Cloud Server template Unlike the previous, single component template (Basic), this LAMP template is based on a more complex multi-component application visualized below: Figure 9: LAMP Centos 64bit Cloud Server template To access the template s metadata: 8. Click Apps primary navigation tab 9. Select the Private Cloud in question from the drop-down 10. Select Only Templates from the Show User Templates drop-down 11. Click on template name (cos57_64_lamp_ftp_v3) from the resulting list Enter required(!) template description data: 12. Click Edit name and description button 13. Enter name: LAMP Centos 32bit Cloud Server 14. Enter a more detailed Description & Save. 27

28 For an example of how you might configure metadata specific to this template, please see setting from the screenshots below: Figure 10: Example metadata configuration for LAMP Centos 32bit Cloud Server template NOTE: The example metadata configuration shown is only one possible way in which metadata can be configured for this template. You may require a different configuration depending on your deployment requirements. More information on this template can be found at: 28

29 3.11 Importing your own Applications & Templates This process is exactly the same as the previous steps, except that your applications and templates should already be imported to your Private Cloud, and metadata configurations will be specific to your own requirements Set User-Template To be able to rapidly provision Cloud Servers from a template using the CCP, the first step is to create your application as a Template in AppLogic and then import it into the CCP. When the Template is imported, it is not automatically recognised as a User- Template so you must convert the application to a User-Template in the CCP. NOTE: Any Template must be started and stopped at least once on your private cloud before importing into the CCP. This ensures that temporary volumes (volcaches), that are created on first runtime, are imported to the CCP along with non-volatile volumes. To change an application to a User-Template in CCP: 1. Click the Change icon next to the application in question The following page will be displayed: Figure 11: Set user Template 2. Select Template Status. Test Preview will create a Template only available to the Admin User. 3. Choose Start (mandatory) and End (optional) dates for Template availability 4. Enter a user-facing description of the Template 5. Save Changes 29

30 A new CCP Template has now been created based on the imported application and it will be available to end-users from the Order New Cloud Server tab in the end-user GUI Customising in-page Help On the right hand side of Admin and End-User CCP interfaces, there is a provision for creating in-page help assistance for your users/customers. To customise in-page help for Admin users: 1. Log in to Admin CCP as Admin user 2. Navigate to the required page of the Admin CCP interface 3. Click the Content Edit function icon below in-page help content 4. Type required text and save. To customise in-page help for End Users: 1. Log in to Admin CCP as Admin user 2. Click on the Users primary navigation tab 3. Generate a list of users by clicking Get List 4. Click on the pen icon to the left of any user and select Switch to from the pop-up menu 5. Navigate to the page where you wish edit the in-page help 6. Click the Content Edit icon below in-page help content 7. Type required text and save. To completed the modification, you will need to copy the files from the Administrator s content directory in the FTP component to the End-User s content directory. This is because when the Admin user creates help content for the End-User interface, the content is stored in the Administrator s content directory, but it must be copied to the End-User s content directory if all users are to see it. To transfer the End-User help files from the Admin content directory to the End-User content directory: 1. Log into the FTP component 2. Download the content of the folder /adas/help/en/apps/ to your local machine 3. Upload the content of /adas/help/en/apps/ via FTP to /euas/help/en/apps/ overwriting all files 30

31 4 Managing Applications There are two ways in which you can retrieve a list of applications from the CCP: 1. List applications associated with a User 2. List applications associated with a Private Cloud 4.1 Listing a User s applications The Dashboard is displayed by default once you log into the system. If you wish to open it while browsing other sections, click the Dashboard primary navigation tab. The Dashboard allows you to search for users and their applications based on either their username or Support ID: 1. Click Dashboard primary navigation tab 2. Enter either a Username or Support ID 3. Click the Get Apps button Once you click Get Apps the system will display the user s applications as shown: Figure 12: List of user applications The information displayed for each application shows: 1. The application name 2. It s Status 3. The Private Cloud the application resides on 31

32 4.2 Listing a Private Cloud s applications See 4.4 Configuring CCP settings for Applications on page Application details By clicking the Cloud Server (Application) name from the application list, you will then be presented with the Cloud Server Details page. Information about the application s details, configuration, components and volumes is presented similar to below: Figure 13: Application details sample The information displayed on the screen above shows details that have been imported from AppLogic into the CCP with the application and additional Application Metadata configured by the CCP administrator. Change component state By clicking on the State icon in the Components section of the Application Details page, you are able to Start, Stop or Restart individual application components. 32

33 4.4 Configuring CCP settings for Applications The Apps section allows you to list your CCP applications, view and configure their details. To generate a list of applications: 1. Click Applications tab on primary navigation 2. To refine your search choose options from Private Cloud, Status and Template lists 3. Click Get List Figure 14: Cloud Server (Application) List Once you click Get List the system will display the relevant applications. To view details of an application, click on its Name. At the top of the Application Details page, two buttons allow you to Start/Stop the application or Delete it. NOTE: Deleting the application on this page will actually remove the application from the CCP and it will then be listed on the Deleted Cloud Servers List (See 4.6 Deleting & managing deleted Apps on page 37). From this page you can also configure how the CCP handles the Application or Cloud Server. The following options are available to you: Figure 15: CCP config options for applications 33

34 Set CP User Cloud Servers/Applications can be assigned manually to a specific CCP user (for example, if a new custom application is imported into CCP). Clicking the Set CP User button will allow Admin to select the appropriate user: Figure 16: Assigning an application to a CCP User NOTE: User Template applications should not normally be assigned to any User. Remove CP User If you wish to have an application assigned to no CCP User then you can remove the current CCP User assignment by clicking the Remove CP User button. This can be useful for applications where are in a testing phase. Remove from CP Removing an application from the CCP will not remove the application from the Private Cloud but will remove any reference to it in the CCP. If the application is required to be controlled by the CCP at some point in the future, it will need to be imported again. See 3.10 Importing included User-Template Applications on page 24 Configure Here the Admin User is able to view and if necessary change individual parameters for a deployed application. The visible fields are those that are configured in the metadata section for Administrators. See 3.8 Understanding Metadata on page 20 The Admin User is also able to over-ride the total CPU, RAM and Bw resources that a particular application is permitted to use by changing the Min, Max & Default values on this page. Normally this would be used for temporarily limiting the total resources for an application for the purposes of troubleshooting. Limits set here will over-ride the total limits set on a per-component basis for the application. WARNING: If field is a Password, values should contain alphanumeric characters only Set metadata Here the Admin user can configure the metadata details for an application including its components and volumes. See 3.8 Understanding Metadata on page 20 34

35 Configure components Here the Admin user can select the CPU, RAM & Bandwidth (Bw) allocations for an application on a component-by-component basis. Each component will be represented by a separate set of sliders. Figure 17: changing component resources Override Sliders: The relationship between the sliders will have been configured through the Parameters section (See Understanding Parameter fields on page 10). However if the Admin User wishes to override these relationship settings, they can do so by clicking the Override Sliders button. This allows the Admin User to select specific values for Min, Max and Default for each resource that will apply to a specific application only. NOTE: For Resource changes to take permanent affect, it is necessary to Save and Restart App. However in the short-term it is quicker to just restart the component so that the Application restart can be carried out a later, more convenient time if required. Save & Restart Component: Once you have set the resource values that you require, you can save these to the Component by clicking this button. It is necessary for the component to be restarted for the new resource assignments to be applied. Save & Restart App: Once you have set the resource values that you require, you can save these at the application level by clicking this button, if it is a convenient time to have the application unavailable for the time taken for it to restart. Resize Volumes Using this form, you can resize and existing volume by entering a new value into the New Size field and clicking the resize button. When entering a new size be sure to use an M (for MB) or G (for GB) after the numeric value. 35

36 NOTE: Before doing a volume resize, the component to which the volume is attached must be stopped. Since resizing can take 2-3 minutes per GB of data, we recommend that this process be carried out when enough time is available. Alternatively and additional volume could be added to the application through AppLogic and then re-imported to the CCP. Invalidate Cache When a new volume is added to an application component, it is necessary to instruct the CCP to update its cached list of attached volumes for the application, to include the newly attached volume. The Invalidate Cache button should therefore be used after a new volume has been added and before the application component has been restarted. Resource Metric The Resource Metric pop-up provides information on which resource measurements are being saved to the CCP at a given time. Last sampled metric for the application provides the last saved value for the total resources of the visible and unlocked components for an application. Current metric for the application shows the current value of the total resources of the visible and unlocked components for an application. This is particularly useful for Admin Users who are making changes during the period between sampling, so they can compare new resources settings to old, thus allowing them to confirm all components have been correctly configured and are being measured correctly for resource usage. NOTE: The CCP records actual resource usage only for components that are visible and unlocked. Components that are locked (either visible or invisible) are considered fixed resource allocations and should therefore be accounted for in the base monthly cost of the application. Resources that are visible and unlocked are the variable usage/ cost components and therefore the cost associated with these resources is recorded for variable price billing purposes. Edit Name & Description This allows you to edit the application name and description as it appears to CCP users. These should be user-friendly names and they do not alter the system level name of the application. 4.5 Setting a Template Application as a User-Template To be able to rapidly provision Cloud Servers from a template using the CCP, the first step is to create your application as a Template in AppLogic and then import it into the CCP. When the Template is imported, it is not automatically recognised as a Template so you must convert the application to a Template in the CCP: To change an application to a User-Template in CCP: 36

37 See 3.12 Set User-Template on page Deleting & managing deleted Apps To delete a Cloud Server Either: 1. Locate the Cloud Server to be deleted 2. From the application list, click the icon to the left of the application in question 3. Confirm the delete instruction on pop-up window Or: 1. From within the Application Details page 2. Click the button at the top of the page 3. Confirm the delete instruction on pop-up window NOTE: The Delete function for applications will remove the App from the active application list but will not delete it from the Private Cloud. A list of deleted applications for any Private Cloud in the CCP can be found in the Deleted Cloud Server List (See below). To view Deleted Cloud Server List 1. Click Apps tab on primary navigation 2. Click Deleted Cloud Server list button on secondary navigation 3. Select a Private Cloud 4. Click Get List Figure 18: Deleted Cloud Servers List To remove (Destroy) an application using the CCP In addition to being able to remove applications from the CCP, you are also able to permanently delete an application from a Private Cloud using the CCP. This is referred to as application Destroy. 37

38 1. Click Destroy link on left of Cloud Server application to be permanently deleted from your Private Cloud. 2. Confirm the delete instruction on pop-up window NOTE: Once you have confirmed you wish to Destroy the Cloud Server, you can monitor the progress of this action through the Job Console, accessible from the primary navigation. See 6 Using the Job Console on page 44 To restore a deleted Cloud Server A Cloud Server that has been deleted (not Destroyed) will still exist on your Private Cloud. In order to restore that Cloud Server, you will need to re-import it to the CCP See 3.10 Importing included User-Template Applications on page 24 NOTE: When an application is deleted any IP addresses assigned to it will be released and returned to the IP pool for use with another application. When restoring a deleted application the CCP may assign a different IP address to the restored application. 4.7 Creating a new Cloud Server application (Admin User) If the Admin User wishes to create new Cloud Servers directly, we advise creating a new end-user (e.g. AdminTest) and use the end-user GUI for provisioning those Cloud Servers. After that, the Cloud Server can then be reassigned to any other CCP user, simply by clicking on specific application, and then Set CP User. 38

39 5 Managing Private Clouds The CCP can manage multiple Private Clouds (Grids) in multiple locations, provided that they have been added to the CCP. NOTE: To control a Private Cloud from the CCP, you must ensure that the CCP s ssh key has been installed on each Private Cloud to be controlled. Please see the CCP Installation Guide for more detailed instructions. 5.1 Adding a Private Cloud See 3.1 Adding Private Clouds to the CCP on page 9 Once a Private Cloud has been added to the CCP, you can perform a number of functions including retrieving Private Cloud information and configuring Constants and Parameters. 5.2 Retrieving Private Cloud details 1. Click Private Clouds tab on primary navigation 2. A list of Private Clouds with basic information is displayed as below: Figure 19: Private Cloud Basic Information The information shown on the basic information screen above are values which are set when Adding a new Private Cloud, or can be changed by clicking the button. WARNING: You can change Description and Version to be any memorable value that you wish to appear on the Private Cloud summary. However, Private Cloud name, IP Address should be the exact Name and IP of the Grid Controller and should not be changed. 39

40 The following is shown when you click the button. This information is extracted by the CCP from the AppLogic Private Cloud on demand and shows the live values: Figure 20: Private Cloud Detailed Information NOTE: This information is the same as can be seen by executing the grid info command from 3tshell. 5.3 Private Cloud function buttons In addition to retrieving information on your Private Clouds from AppLogic through the CCP, there are a number of other functions that you can use whilst on the Private Clouds details page: Figure 21: Private Cloud function buttons 40

41 View Private Cloud Physical Servers info By clicking the Servers function button, you will be able to access a list of physical servers on which the Private Cloud is running along with details of the physical resources and applications running on specific servers as shown below: Figure 22: Physical Server Information NOTE: This information is the same as can be seen by executing the srv list server_ name command from 3tshell. Get Cloud Server IPs To assist Admin users in managing the IP Pools for the Private Clouds under their control, we have included a function that allows you to list the IP addresses that have been assigned to an application running on a Private Cloud. To access this list: 1. Click Get Cloud Server IPs function button on Private Cloud Details page 2. A pop-up window will inform you that Get App IP List job has been triggered, click ok 3. You will automatically be redirected the to the Job Console where you will see that a new job is in-progress. 4. When the Job Status changes to OK, click View Log to see the IP list. The information provided in the Log will include: Application name: the name of the application to which the IP address is assigned Property Name: Metadata Name for property to which the IP address has been assigned (configured in Apps > Metadata) IP address: the relevant IP address 41

42 NOTE: The list of applications and IP addresses returned includes ALL applications that are on the Private Cloud, even if they have not been imported into the CCP. Constants Each Private Cloud added to the CCP has a set of default values (Constants) that may need to be referenced when provisioning Cloud Servers or Cloud Applications. These are fixed values such as gateway, IP address, dns server, netmask, passwords etc. Each user-template that you import/create may require access to different Cloud- level constants. See 3.7 Setting up Constants on page 19 By clicking the Constants function button on the Private Cloud Details page, you will be able to see a list of Constants that have been configured for the Private Cloud in questions. Figure 23: Private Cloud Constants List From this list you can Edit or Delete Constants previously configured for a specific Private Cloud. WARNING: Deleting a Constant that is currently in use by an application in the CCP may result in application malfunction. Please ensure a constant is not in use before deletion. You can also create new Constants by clicking the secondary navigation. button on the Parameters Parameters define the limits of selectable resources such as CPU, RAM and Volume Size that can be assigned to component or appliance on your Private Cloud. As well as defining limits, parameters can also set the dependencies between CPU and RAM to ensure that with a given selection for CPU, there is a minimum and maximum RAM restriction. See 3.2 Setting up Parameters on page 10 42

43 5.4 Deleting a Private Cloud NOTE: A Private Cloud may only be removed from the CCP s control (deleted) if there are no Appliations or Templates that have been imported to, or provisioned on, the Private Cloud in question. Therefore to delete a Private Cloud you must first remove any Applications or Templates on that Private Cloud through the CCP. You can remove a Private Cloud from the CCP by clicking the Private Cloud details page. button on the Before deleting a Private Cloud, you must first remove key references in the CCP to that Private Cloud before it can be deleted. To prepare your Private Cloud for deletion, complete the following procedure: 1. Delete any applications on the Private Cloud from the CCP 2. Delete any Constants previously configured for the Private Cloud 3. Release any IP Pools associated with the Private Cloud: 1. Go to Private Cloud Pools in IP Pools tab 2. Select the Private Cloud, click Next 3. Uncheck all IP Pools, click Update. NOTE: Deleting a Private Cloud from the CCP will not affect the status of the AppLogic Private Cloud, only the information and access to that Private Cloud from the CCP. 43

44 6 Using the Job Console Many administrative and user actions in the CCP will execute a process on the CCP database or the AppLogic Private Cloud itself. We call these processes Jobs. NOTE: Some CCP actions are not executed instantaneously as they involve a process of interaction with AppLogic that may take several minutes. You can monitor the progress of such actions through the Job Console. Jobs can be monitored from the Job Console tab on the primary navigation. 6.1 Job List By default the Job List shows Jobs that have been created either today or yesterday. However you can generate a job list based on a defined time period, a specific Private Cloud and/or a particular Cloud Server by configuring the drop-down filter fields below: Figure 24: Generating a Job List The generated Job List will provide you with details for each Job that has been Fired (triggered) by either any CCP users: Figure 25: the Job List 44

45 Job List features From the Job List you can access the following information and features: Status: this shows the current status of the Job and can be either: NEW: displayed immediately after the job has been created IN-PROGRESS: displayed while the job is being executed. These jobs can be canceled by clicking the button on the right. OK: the status for successfully completed jobs FAILED: displayed if there was a problem with the job and it could not been completed successfully. In this case the administrator has the option to reactivate the job execution by clicking the button on the right. RESUME: this will be displayed in the Status column when a FAILED Job has been reactivated. Submitted on: the time and date the job has been submitted Started on: the time and date the job has been submitted Finished on: the time and date the job has been completed (successfully or not) Job Name: displays the system-generated job description View Log: click this option to view the job log Fired by: the identity (username) of the user who started the job 6.2 Workers See 3.3 Setting up Workers on page 13 45

46 7 Managing Users The CCP allows for multiple user roles currently including Admin, Agent, User and Billing. Future versions of the CCP will also include the ability to create custom roles. You can generate a User List by configuring the drop-down filter fields below: Figure 26: Generating a User List 7.1 Adding a new User New users can be added by clicking the navigation. button on the secondary NOTE: New users do not automatically receive a welcome with their CCP access details. The Admin user should inform new CCP users of their access details. 7.2 Listing Users Filter fields Status: select the user status filter required All: all users Active: only active users New: newly created users Deleted: deleted users Role: select the user role filter required All: All CCP users Administrator: only Admin users Agent: Support Agent super -users Billing: Users with usage reporting access 46

47 User: general CCP users Customer assignment: select whether user is external customer All: either internal user or external customer Has Customer Assigned: User has customer details added No Customer Assigned: User has NO customer details added 7.3 Manage User features From the User List, administrators can access various user management features by clicking the Change icon to the left of the Username: Figure 27: Accessing Manage User features From the Manage User Features you can access the following features: Delete: this will delete the User profile from the CCP. NOTE: to successfully delete a user, you must first delete or re-assign any applications that are currently assigned to that user. See Set CP User on page 34 Set Password: to change a user s CCP password Edit: to change a user s Name, and/or Status. Switch to: this allows Admin and Agent users to switch to the user s view of the CCP. This option is not available for Billing Users. Add Customer: For users who are external customers, this feature will allow Admin to enter Company details, Technical & Billing contact details for the account. This option is not available for Billing Users. 47

48 8 Managing IP Pools See 3.4 Setting up IP addresses on page 14 48

49 9 Using Subnets The CCP is able to manage multiple IP subnets, allowing applications assigned to a given subnet to automatically inherit properties such as netmask, gateway, IP pool etc. This enhances security by segregating your network into subnets ensuring applications are configured correctly during automated provisioning. A Subnet in the CCP is more than just a segment of an IP pool. A CCP subnet is an object which contains several predefined constants (e.g. gateway, netmask, dns ) that can be used to automatically set application configuration when provisioning. The number of subnets is not limited. 9.1 Adding a subnet Initially there is one default subnet, which you can also use for filling in application properties. The default subnet cannot be deleted (it s there because of backward compatibility issues). You can add other subnets with desired names, and subnet constant values. To add a subnet: 1. Go to the IP Pool primary navigation tab, and click on the Subnets button (secondary navigation tab) 2. Click the Add subnet button, and pop-up window for adding subnet will appear. It s necessary just to fill the name field. Constant value fields can be filled later (every subnet property value can be edited later). Figure 28. Adding Subnets 49

50 9.2 Adding subnet constants To add a subnet constant: 1. Go to Subnet constant page (under the IP Pool primary navigation tab). 2. By clicking the Add constant button, the pop-up window for adding constant is appearing. Both name and description fields need to be filled. 3. Description value can be edited later, and this value will appear in the Subnets table. Figure 29: Adding Subnet constants To assign a value to subnet constants for each subnet: 1. Go to the Subnets page, and click the Edit button in the table, for specific subnet. 2. After adding a subnet and defining the subnet constants, it needs to be assigned to the specific IP pool before it is activated. 50

51 9.3 Assigning a subnet to an IP pool To assign to a specific IP pool: 1. Go to the IP Pools page (under the IP Pool primary navigation tab). 2. In the IP Pool list table second column is Subnet, and by clicking the Change subnet button in it, you can assign specific subnet to the IP pool. 3. One subnet can be assigned to several IP pools, and one IP pool can have just one subnet attached. Figure 30: Assigning a subnet to an IP pool On the provisioning of a new application, the CCP first needs to determine which IP(s) will be assigned to that application. The target IP pool will be the one with the lowest sort weight, and with enough free IP addresses. To use defined subnet constants as properties for newly provisioned applications, metadata options need to be set for that: 1. In the drop-down menu of the Function column, there is one new option - Subnet Constant. 2. When this option is chosen, the Constant column drop-down menu will offer available, defined subnet constants (to use Cloud, global, constants Function dropdown menu must be set to Constant). Figure 31: Using Subnet constants as metadata properties 51

52 Example usage: A typical example of subnet use could be in the situation where you have two separate IP pools on the grid, with different subnet masks and gateways, but you want to use them both for application provisioning in the CCP. There is one template and the metadata is set for it to use the global constants for gateway and subnet mask. The current IP pool in use has a lower sort weight, and global Cloud constants are appropriate for that pool. If the CCP uses all the IP addresses on new applications, it will start using the next IP pool that has free IP addresses and the lowest sort weight. But, when the next application is provisioned, it will be configured with the wrong subnet mask and gateway (which are appropriate for the previous IP pool), so it will be inaccessible from the Internet. With subnets, when CCP uses all IPs from one pool, it will then start to use another, but if the application is set to use subnet constants for metadata properties, it will be configured with the appropriate values. Without subnets, administrators would have to do the switching to new metadata properties manually. 52

53 10 Managing Orders Admin & Billing users are able to search orders that have been generated through the CCP. You can generate a User List by configuring the drop-down filter fields below: Figure 32: Order List generator 10.1 Listing Orders Filter fields From & To: select date rage User: select to filter by a specific user Status: select the order status filter required All: all orders New: new orders not yet processed Processed: processed orders Cancelled: cancelled orders Paid: orders for which payment has been received Cloud Server Name: filter by specific Cloud Server Name given by customer Order Refcode: filter for system-generated order reference code Figure 33: Order List From the Order List you can access the following information and features: Order Refcode: system-generated order reference code. Status: status of the order, either New, Processed. Username: username of account from which the order was placed. Grid: name of the Private Cloud from which the order was placed. 53

54 Template: name of the user-template on which the ordered Cloud Server is based. Grid Cloud Server Name: system-generated name of the new Cloud Server ordered. Cloud Server Name: name given by the user to the new Cloud Server ordered. Created on: date the order was generated. Expires on: Not implemented in this version. Actions: Manual actions not implemented in this version. NOTE: whether or not new orders form existing customers are processed manually or automatically, can be set in Parameters Configuration page under the Configurations Tab, field Order Form Mode. When this field is set to Manual Mode, new orders will be held for processing manually by the CCP administrator. NOTE: Setting of automated or manual processing from new customer orders via the external order form is configured in the API Ordering script. See 14 Using the CCP API on page New order process for existing customers The following is a description of the new order process: 1. User creates orders a new Cloud Server in the CCP through the Order New Cloud Server tab on the primary navigation 2. If Order Form Mode is set to automatic, CCP receives the order and sends a command to the Private Cloud to provision the Cloud Server from a template 3. If Order Form Mode is set to manual, CCP receives the order and waits for the Admin to trigger the provisioning process manually. 4. User receives a welcome with the Cloud Server access details (note: this could be before the Cloud Server has been fully provisioned as it is sent when provisioning begins.) 5. Cloud Server is provisioned on the Private Cloud. Progress can be monitored by the Admin user or End user through the Job Console. 6. User will not be able to access the new Cloud Server until the provisioning process is complete and the status on the Job List shows OK Configuring Welcome for End-Users When a new cloud server is ordered, the CCP will send the User a Welcome with access details for the new Cloud Server. NOTE: See 3.5 Setting up notification templates on page 16. The relevant template for this purpose is User - Welcome 54

55 11 Content Snippets Using a Snippets system, content from external systems can be embedded within the CCP portal pages. This content could be HTML, images, text files, flash etc, which is presented to the CCP by 3rd party software for managing external storage, network monitoring or customer portal systems etc. Each snippet is linked to a predefined position on the relevant page within the CCP. The HTML content of the snippet is injected directly into the content of the page. There are two types of snippets: global content snippets and application-based snippets When an external URL is defined for a snippet, it is called by the CCP using curl. A URL is appended with some parameters to be used by a programmer writing an external script. Parameters are passed via HTTP POST method Global content snippets Global Content Snippets can be shown to all users as static content (the same content for all users), or as a dynamic content (specific content is shown only to specified users). To set Global Content Snippets: 1. Go to the Configuration primary navigation tab, and then to the Content Snippets secondary navigation tab 2. Insert a URL to the external content Figure 34: Setting global content snippets Admin-users can configure two pre-defined global content snippets that, provided a URL is inserted in the External URL field, are shown on the Account page of the End-User control panel (The page which you open by clicking on the Account primary navigation tab, from the End user control panel): 55

56 accntbottom - positioned at the bottom of the Account page (recommended content width is 740px) accntright - positioned on the right side of the Account page, below the in page help (recommended content width is 190px) Snippet content should be generated based on the Cloud Server name ( appname POST variable). There are several variables that can be submitted (using POST) in the scripts used with global content snippets: hash - security code. For global snippets hash is calculated as md5 ($secretword. $username.$sessionid) username - username of the user logged in to CCP that invokes the call of this script sessionid - current session id of the user s session on the CCP http_user_agent - CCP user s browser, should be used to provide better browser compatibility clientip - CCP user s current IP address language - 2-letter language code, that user currently uses for the CCP. Recommended if CCP is configured with multiple languages Application-based snippets To set an Application-based snippet: 1. Go to the specific Cloud server configuration page. 2. There is a Content Snippet button on the Set Metadata page for each application. Figure 35: Application-based content snippets 56

57 In the Cloud Server Content Snippets page every snippet is described in the Description column. Figure 36: Cloud server content snippets Snippet content should be generated based on the Cloud Server name ( appname POST variable). There are several variables that can be submitted (using POST) in scripts for application-based snippet loading: hash - security code. For application-based snippets hash is calculated as md5 ($se cretword.$username.$sessionid) appname - name of the Cloud server (application), for which we need the custom snippet grid - name of the Private Cloud that the Cloud server (application) is running on username - username of the user logged in to CCP that invokes the call of this script http_user_agent - CCP user s browser, should be used to provide better browser compatibility clientip - CCP user s current IP address language - 2-letter language code, that user currently uses for the CCP. Recommended if CCP is configured with multiple languages. 57