Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
275 lines (150 sloc) 15.7 KB
title description services author toc_rootlink toc_sub1 toc_sub2 toc_sub3 toc_sub4 toc_title toc_fullpath toc_mdlink
Getting Started Guide for the UKCloud Portal | UKCloud Ltd
Provides information to get up and running with the UKCloud Portal
portal
Sue Highmoor
Getting Started
UKCloud Portal
Getting Started Guide/ptl-gs.md
ptl-gs.md

Getting Started Guide for the UKCloud Portal

Overview

The UKCloud Portal is the gateway to your UKCloud services. In the Portal, you can:

  • View information about your UKCloud services, including UKCloud for VMware, UKCloud for OpenStack and Cloud Storage

  • View notifications relating to the UKCloud platform

  • Create compute services, virtual data centres (VDCs) and edge gateways within your UKCloud for VMware environment

  • Access vCloud Director to work with your UKCloud for VMware environment, for example to create and manage virtual machines (VMs), build VDC networks or configure your firewall

  • Raise and monitor support tickets

  • Access Knowledge Centre articles to help you understand and work with the UKCloud platform

This Getting Started Guide provides an overview of the functionality available within the Portal.

Intended audience

This Getting Started Guide is intended for any user with access to the Portal.

[!NOTE] The options you can see and tasks you can perform within the Portal depend on the permissions you've been granted by your Portal administrator.

Before you begin

You should have received your Portal login credentials from your Portal administrator. If you're the Portal administrator, your Customer Success Manager (CSM) will have provided you with your login credentials.

The Portal works with Google Chrome, Microsoft Internet Explorer and Mozilla Firefox. However, if you'll be using vCloud Director, we recommend that you use the Firefox ESR browser as this is also supported by the Web Console for the version of vCloud Director used by UKCloud for VMware.

More information! Browser requirements for services on the UKCloud platform

Logging in to the UKCloud Portal

The first thing you need to do is log in.

  1. Go to the appropriate URL, depending on the security domain in which your service is located:

    • Assured OFFICIAL: https://portal.ukcloud.com

    • Elevated OFFICIAL: Contact your Portal administrator or Customer Success Manager (CSM)

  2. On the Log in page, enter your credentials and click Sign in.

    UKCloud Portal Log in page

    [!TIP] If you've forgotten your password, click the Forgotten password? link to request a password reset.

    If this is the first time you've logged in, use the temporary password you were given by your Portal administrator or CSM. You'll be prompted to change this temporary password.

  3. If your Portal administrator has enabled memorable word authentication, you'll be prompted to enter three randomly-selected letters from your memorable word. (IF this is the first time you've logged in, you'll be prompted to create a memorable word.)

    Memorable word dialog box

    [!NOTE] If you incorrectly enter your password three times, you'll be prompted to enter a captcha code until you successfully log in. If you incorrectly enter the captcha code or your password another three times, a seventh unsuccessful login attempt will result in your account being locked. You'll need to contact your Portal administrator to unlock your account.

  4. If your Portal administrator has enabled Two-Factor Authentication (2FA), you'll be prompted to enter a six digit code. Use your 2FA app to generate the code and enter it here. (If this is the first time you've logged in, you'll be prompted to set up 2FA).

    Two-Factor Authentication dialog box

    [!NOTE] If you incorrectly enter your password three times, you'll be prompted to enter a captcha code until you successfully log in. If you incorrectly enter the captcha code or your password another three times, a seventh unsuccessful login attempt will result in your account being locked. You'll need to contact your Portal administrator to unlock your account.

Getting to know the UKCloud Portal

After you log in, you'll see the Portal Home page. A Portal page is made up of three main areas:

  • Toolbar

  • Navigation panel

  • Content area

UKCloud Portal home page

Toolbar

Each user account is associated with one or more customer accounts. Within the Portal, you can work within any customer account to which you have access. From the toolbar, you can switch between different customer accounts.

Account menu

[!NOTE] When you switch between accounts, you may be prompted to enter letters from your memorable word again if this additional security measure has been enabled by your Portal administrator.

In the toolbar, you can also click your username to access the following options:

User menu

  • Notifications - List all Portal notifications. Unread notifications are displayed in bold. Click the View button next to a notification to see more details. When you've finished reading a notification, select the Notifications tab to return to the list. If you want to quickly mark all your unread notifications as read, click the Mark all as Read button at the top of the page.

    [!TIP] The number next to the Notifications menu option (and next to your username in the toolbar) shows how many unread notifications you have.

  • Update contact details - Change your name, email address and telephone numbers. You can also opt to have Portal notifications sent to your email address.

  • Change Password --- Change your password or memorable word. We recommend that you change your password at least every 90 days (see How to reset your UKCloud Portal password or memorable word).

    [!NOTE] Your Portal administrator may have implemented a password expiration period; in which case, you'll be prompted to change your password after the specified number of days.

  • API - View the information you need to use the vCloud API (see How to access vCloud Director through the vCloud API).

  • Feedback - Send an email to UKCloud with feedback on the Portal or any other aspect of your UKCloud experience.

  • Log out - Log out of the Portal.

[!TIP] Click the UKCloud logo in the toolbar on any page to return to the Home page. If you hover your mouse over the UKCloud logo, a tooltip displays the current Portal version.

Navigation panel

The Portal navigation panel provides access to all the functionality available in the Portal.

UKCloud Portal navigation panel

[!NOTE] The options you can see in the navigation panel depend on your Portal permissions and the services associated with your account.

Content area

The content area displays the main content of the page. While the toolbar and navigation panel remain the same in most Portal pages, the content area changes depending on what task you're performing in the Portal. For example, the content area of the Home page contains a dashboard that provides quick access to various areas of the Portal, including notifications, My Calls and the Knowledge Centre.

Logging out of the UKCloud Portal

When you've finished working in the Portal, we recommend that you log out to prevent unauthorised access.

[!TIP] After you've been inactive in the Portal for some time, you'll be automatically logged out.

  1. In the toolbar, click your username.

  2. From the menu, select Log out.

Log out menu option

Using the UKCloud Portal API

The Portal also provides an API to enable you to interact programmatically with your UKCloud environment. For example, you can use the Portal API to create, manage and monitor support tickets, view information about the components of your environment and create compute services, virtual data centres and edge gateways.

The entry point URL for the Portal API is:

https://portal.skyscapecloud.com/api

For reference information about the various endpoints offered by the Portal API, see the UKCloud Portal API User Guide.

For more information about how to use the API, including examples showing how to use the API to create a VDC and edge gateway, see How to use the UKCloud Portal API.

Next steps

In this Getting Started Guide, you've learned the basics about the Portal and the functionality it provides to help you interact with your UKCloud environment. For more details about a specific service, see the appropriate Getting Started Guide.

Related videos

Glossary

This section provides a glossary of terms specific to the UKCloud Portal.

account  Within the UKCloud VMware environment there are two types of account:

  • customer account - A collection of related compute services associated with a particular customer or partner.

  • user account - The account you use to log in to the Portal or authenticate with the Portal API. Your user account determines which customer accounts you have access to. Each user account can be associated with multiple customer accounts.

compute service  An Enterprise Compute Cloud top-level container within a customer account that includes a vCloud Director organization and its VDCs, catalogues, users and resources.

Customer Success Manager (CSM)  A UKCloud Customer Services role aimed at providing you with any assistance you require during onboarding and the first 90 days of using a UKCloud service.

Knowledge Centre  UKCloud's repository of articles created in collaboration with subject matter experts to provide information about how to use our products and services. Article types include:

  • Service Definitions describe what a service does

  • Service Scopes provide technical detail for a service or service option

  • Factsheets provide a brief overview of a service or service option

  • FAQs answer commonly asked questions about a service or service option

  • Blueprints explain how our platform helps address business needs

  • Getting Started Guides step through the basic tasks required to get a service or service option up and running

  • How To Guides provide step-by-step instructions for performing specific tasks within our platform

  • Quick Ref Guides to provide general information to help understand a particular aspect of our platform

Memorable word  An optional second level of authentication to provide an additional layer of security for the Portal. Users are prompted to enter random letters from their memorable word after they have entered their log in credentials.

My Calls  An area of the Portal where you can raise and monitor support tickets.

Navigation panel  An area on the left side of the Portal that provides access to Portal functionality.

Toolbar  An area along the top of the Portal that enables you to switch accounts, access notifications, change your password or contact details and log out of the Portal.

Two Factor Authentication (2FA)  An optional second level of authentication to provide an additional layer of security for the Portal. Users are prompted to enter a one-time code generated by registered device, such as an iPhone or Android Phone.

Feedback

If you find an issue with this article, click Improve this Doc to suggest a change. If you have an idea for how we could improve any of our services, visit UKCloud Ideas. Alternatively, you can contact us at products@ukcloud.com.