Getting Started

Now that you’ve installed CloudBolt, you can follow this guide to discover some of CloudBolt’s core features.

Explore What Quick Setup Created

Manage Discovered Servers

  1. Note that quick setup logged you out of the ‘admin’ account and into the account created by the quick setup. For security the admin account is automatically deleted at the end of the quick setup process unless you chose to name your first account ‘admin’.
  2. At the end of the quick setup wizard, the “Start Using CloudBolt” link takes you to the Resource Handler List page.
  3. The Resource Handlers page is part of an Intro Tour which gives the user an overview of main CloudBolt components.
  4. The first thing you’ll want to do is set up a resource handler in order to discover existing VMs in one of your compute environments and enable provisioning. Follow the on-screen guidance.
  5. Once you’ve created a Resource Handler, CloudBolt starts a sync job to discover your VMs and create corresponding server records.
  6. Note that they show up with group and owner set to unassigned, but can be reassigned as appropriate.

Provisioning a new VM

  1. Click the “New server” link in the navigation bar (under the “Servers” menu item).
  2. Choose the group you created during quick setup and select one of the environment(s) that was automatically created. The order form can be configured so that it provides different options based on the choice of group & environment.
  3. Watch the order proceed to completion. For more details on the server provisioning process, click the link for the “Provision Server Job” that was started.

The next sections of this document will discuss some ways to customize the order form so that you can show just the options that make sense for your users. See the Order Form Customization document for full details on this process.

Customize CloudBolt to Suit Your Needs

Now that you have seen the basic data that the CloudBolt Quick Setup wizard created for you, you will want to set it up to suit your needs & further explore its capabilities.

Customizing the order form for an environment

  1. Go to the environment list, click on an environment that was created automatically, and change its name to something relevant to you. (We’ll use “NYC QA Lab” for the rest of this tutorial.)
  2. Also click the “Auto Approve All Orders” checkbox for this environment.
  3. Now, click on the Parameters tab and add the following parameters to the group: Annotation, CPUs, Disk Size, Expiration Date, and Mem Size.
  1. Click the pencil in the Options column to add specific options for these parameters.
  2. Click New Server and choose NYC QA Lab to see how your changes affect the form.

Next, we will eliminate the hostname input and allow users to request more than one server at a time.

  1. Back on the Parameters tab for this environment, click to add more parameters.
  2. Add the “Hostname Template” and “Quantity” parameters.
  3. Add a single option for the “Hostname Template” field - ‘cbtest-00X’.
  1. Now try requesting a new server for this environment. Note that the hostname field is gone, and there are now “Hostname Preview” and “Quantity” fields.

Now, we’ll customize the Annotation field so that you get a personalized annotation for each of your new servers. This field is only supported on VMware and AWS. You can also skip this section, and users will be able to add their own user-defined notes on servers using CloudBolt’s powerful Annotation Specification system.

  1. Click Environments -> “NYC QA Lab” -> Parameters.

  2. Click the pencil icon in the Options column for the Annotation field.

  3. Provide a nice template for your servers to help your admins and users figure out where this server came from. The sample here is provided on all new servers and can be set as a global default from the Annotation parameter detail view.

    Built by {{ server.owner }} using CloudBolt ({{ portal.site_url }})
    on {{ server.add_date|date:"SHORT_DATE_FORMAT" }}
    [Job ID={{ }}, Order ID={{ }}]
  4. Click Add Option and then Save.

  5. Since this is the only configured option, you can hide it from the form. Click the Parameter’s name (Annotation) to configure its global settings.

  6. On the Parameter’s details page, press the Edit button.

  7. Check “Required”: this prevents the field from appearing when it is constrained to a single option by preventing the inclusion of a blank option.

Now we will set up some networking options for the end user:

  1. Go back to the environment and click the Networks tab.
  2. Click Make Changes
  3. Add another network choice for the first interface (NIC 1).
  4. Open the New Server dialog and notice that the user is given a network choice now that there are 2 options.
  5. Click on one of the networks -> Edit and enter a net mask, gateway, DNS server 1, and change the addressing schema to static.
  6. Add an IP Range for the network.
  7. Open the New Server dialog and note that selecting the network you just updated produces the message “IP addresses will be assigned from a resource pool.”

Intro Tour

New users with Super Admin or CloudBolt Admin permissions will see an Intro Tour on the first log in of CloudBolt. The first person to set up the CloudBolt account using Quick Setup will start the tour from the Resource Handlers page. Subsequent users will start the tour from the Dashboard.

Dismiss the tour temporarily by clicking Dismiss. The tour will start up again when the user navigates to another page included in the tour. Check Disable Tour, then click Dismiss to turn off the tour completely. To turn tours back on, click Profile, Manage Profile, and check View Tour.

Next Steps

From here, there are many more features to explore. Here are some ideas to get you started:

  • Use the global search feature in the toolbar to navigate around. There is also an admin search/ spotlight feature on the Admin page to help you find some of the setup pages.

  • Check and potentially change the configuration of your CloudBolt instance using Admin -> System -> Miscellaneous Settings.

  • Try managing Preconfigurations (ex. server size, software stack, etc.) from Admin -> Internal Entities -> Preconfigurations.

  • Set up rates from Admin -> Internal Entities -> Rates.

  • Learn more about what you can do with your resource handler from Admin -> Resource Handlers -> click your initial handler.

  • Server change tracking - try changing a VM attribute, such as memory, from the resource handler’s own UI, wait 30 minutes (or press the ‘Refresh Info’ button on the server in CloudBolt), then look at the server’s history tab.

  • The Group tree:

    • Set up more groups & group types.
    • Set quota limits and look at the quota usage view of the group tree.
    • Delegated group administration - set someone else as the group admin and then remove yourself from the group.
    • Manage user permissions - set up a user who is a requestor only to explore what they can see and do.
  • Support for additional resource handlers - from Admin -> Resource Handlers, try adding another Resource Handler of a different technology you have in your IT shop.

  • Upload a new logo to include your own branding - from Admin -> System -> Branded Portals.

  • Integrate with your AD for single sign on - from Admin -> Security -> LDAP Authentication Settings.

  • If you are interested in support for provision engines, configuration management systems, network virtualization, etc. call us to explore enterprise functionality beyond what’s found in the documentation.

  • Job Runtime Triggers - explore the orchestration framework and actions and contact us for more info if you would like to integrate with other systems during the provisioning process. We make it easy!