fbpx

How Can We Help?

You are here:
Print

Getting Starting – IT Portal

Cloudockit IT Portal automatically scans your cloud and on-premises infrastructures to obtain a full overview of your applications, resources, and the IT documentation related to them. It is fully operated in SharePoint Online.

Cloudockit IT Portal works with Cloudockit Desktop and Cloudockit Container.

To set up Cloudockit IT Portal, it is necessary to perform various operations on SharePoint Online, on Cloudockit Desktop, or Cloudockit Container.

After your installation, visit Navigate Cloudockit IT Portal.

Prerequisites

PRE-REQUISITES TO DEPLOY CLOUDOCKIT IT PORTAL

  • The user is a SharePoint admin
  • The global App Catalog already exists. If not, follow the instructions in Step 1 below, Create the App Catalog in SharePoint
  • Have access to Cloudockit Desktop or Cloudockit Container available with a 25-user license

PRE-REQUISITES TO PROVISION DATA INTO CLOUDOCKIT IT PORTAL

Option 1 – Cloudockit Desktop

  • Install Cloudockit Desktop. Click here for the instalation guide
  • Please note that Cloudockit Desktop needs to be installed on a Virtual Machine that is constantly running or that automatically starts or shuts down to allow scheduled generation.

Option 2 – Cloudockit Container

If you would like to set up Cloudockit Container, we will provide you with a complete script that will automatically do the setup for you. Contact us with your product key to receive the script.

If you prefer doing the setup manually, please refer to the documentation below depending on which provider you plan on using.


Setting up IT Portal in SharePoint Online

There are two ways to deploy Cloudockit IT Portal in SharePoint Online: manually or automatically by

running a script. If you want to run the script, use the following command in the Cloudockit IT Portal

folder.

.\cloudockit-it-portal-install.ps1 -siteAdminUrl {your-site-admin-url} -
siteTitle {your-site-title} -siteUrl {your-communication-site-url

Since Cloudockit IT Portal is deployed on your SharePoint site, you will have to give Azure

AD API access to Cloudockit IT Portal by following the next 6 Steps.

If you want to install it manually, you will first need to create an App Catalog in SharePoint. The App Catalog has an important role for deploying Cloudockit IT Portal. If you already have one, you can skip Step 1 below.

STEP 1 – CREATE THE APP CATALOG IN SHAREPOINT (MANUAL INSTALLATION)

1 – Go to the SharePoint Admin Center by entering the following URL in your browser. Replace yourtenantprefix with your Microsoft 365 tenant prefix.

  • Commercial Tenant HTTP: https://{your-tenant-prefix}-admin.sharepoint.com
  • GCC High Tenant HTTP: https://{your-tenant-prefix}-admin.sharepoint.com

2 – Click on More features

3 – In the Apps section click on Open

4 – Click on App Catalog

5 – Keep the first option selected, then click on OK

6 – Wait until the App Catalog is created

Your App Catalog is now available. In step 2, you will know how to create a new communication

site.

STEP 2 – CREATE A COMMUNICATION SITE

1 – Go to the SharePoint Admin Center by entering the following URL in your browser. Replace

yourtenantprefix with your Microsoft 365 tenant prefix.

  • Commercial Tenant HTTP: https://{your-tenant-prefix}-admin.sharepoint.com
  • GCC High Tenant HTTP: https://{your-tenant-prefix}-admin.sharepoint.com

2 – Click on Active sites in the Sites section and then on Create

3 – Click on Communication site

4 – On the Communication Site form choose a Blank design then fill the form and click on Finish. You will be redirect to your newly created communication site.

5 – Click on Browse templates

6 – Select a blank template

7 – Click on Use Template

8 – The blank template is now applied to your communication site

In the next step, we will show you how to add the site App Catalog.

STEP 3 – ADD AN APP CATALOG TO THE COMMUNICATION SITE

Currently, there is no way to add a site app catalog manually from the SharePoint platform. The only

way to do so is with a PowerShell script. You will find it in the following path in the Cloudockit-it-portal

folder.

Path of the script: cloudockit-it-portal\scripts\create-AppSiteCatalog.ps1

You will have to enter the communication site URL, your SharePoint admin site URL you’ve created

before and log in with your credentials.

Execute the following command:

.\create-AppSiteCatalog.ps1 -siteAdminUrl {your-site-admin-url} -siteUrl
{your-communication-site-url}

In the next step, you will learn how to deploy Cloudockit IT Portal.

STEP 4 – DEPLOY CLOUDOCKIT IT PORTAL

1 – Navigate to your communication site and click on Settings and Site contents

2 – Click on App for Sharepoint

3 – Drag and drop the cloudockit-it-portal.sppkg file in the App Catalog. A pop-up will appear

and invite you to trust and deploy Cloudockit-client-side-solution (Cloudockit IT Portal).

Click on Deploy

4 – Go back to site content and click on +New and select App

5 – Click on Add in cloudockit-client-side-solution card

6 – Navigate to the communication site and click on Edit

7 – On the left-hand side click on + and on the full-width section

8 – In this section, multiple web parts will appear. Select Cloudockit. Click on republish to validate changes.

Cloudockit IT Portal will initialize and you will be invited to make your Cloudockit generation

9 – For a better experience we recommend you to set the Dark Blue theme by clicking on settings, then select Change the look, and finally select Theme and click on Dark Blue.

In the next section, you will see how Azure AD API can give access to Cloudockit IT Portal.

STEP 5 – ALLOW ACCESS TO AZURE AD GRAPH API

Cloudockit IT Portal needs to access Azure AD Graph API to ensure all Microsoft 365 applications function.

1 – Go to the SharePoint Admin Center by entering the following URL in your browser. Replace yourtenantprefix with your Microsoft 365 tenant prefix.

  • Commercial Tenant HTTP: https://{your-tenant-prefix}-admin.sharepoint.com
  • GCC High Tenant HTTP: https://{your-tenant-prefix}-admin.sharepoint.u

2 – Under the Advanced section click on API access

3 – Select the Cloudockit Graph with the package cloudockit-client-side-solution and click on Approve.

Cloudockit IT Portal is now accessible with Azure AD Graph API from SharePoint.

In the next section, we will see how to make the provisioning of Cloudockit IT Portal with Cloudockit Desktop or Container.


Provision Cloudockit IT Portal

PROVISION WITH CLOUDOCKIT DESKTOP

1 – To make the provisioning of Cloudockit IT Portal you may first create a service account on SharePoint and give privilege access to Cloudockit as in the following instructions: Drop-off in SharePoint Online/Teams.

2 – In the Cloudockit IT Portal section of your Cloudockit interface fill in the information about your service account with your site URL.

Note: You must repeat this process for each Cloud Provider from where you want to generate data for Cloudockit IT Portal.

You are now ready to use Cloudockit IT Portal. For that, just navigate to your communication site and start your Cloudockit IT Portal experience.

PROVISIONING WITH CLOUDOCKIT CONTAINER

Follow the documentation linked in the prerequires to provision Cloudockit IT Portal. Here are some examples to generate documentation in Cloudockit IT Portal.

Examples: Payload for an AWS environment scan:

{
  "ApiKey": "xxxx",
  "ADKCloudType": "Azure",
  "TenantID": " xxxx.onmicrosoft.com",
  "SubscriptionID": "xxxx",
  "AppClientIdForAutomation": "xxxx",
  "AppClientKeyForAutomation": "xxxx",
  "GenerateDocumentationInSharePointOnline": true,
  "SharePointOnlineUrl": "https://xxxxx.sharepoint.com/teams/xxxx",
  "SharePointOnlineClientID": "xxxx",
  "SharePointOnlineClientSecret": "xxxx",
  "AzureStorageNameForDropOff":"full_connection_string"
}
{
  "ApiKey": "xxxx",
  "ADKCloudType": "AWS",
  "AWSAccessKeyId": "xxxx",
  "AWSSecretAccessKey": "xxxx",
  "SubscriptionID": "xxxx",
  "GenerateDocumentationInSharePointOnline": true,
  "SharePointOnlineUrl": "https://xxxx.sharepoint.com/teams/xxxx",
  "SharePointOnlineClientID": "xxxx",
  "SharePointOnlineClientSecret": "xxxx",
  "AzureStorageNameForDropOff": "full_connection_string"
}
{
  "ApiKey": "xxxx",
  "ADKCloudType": "GCP",
  "GCPServiceAccountCredentials": "credentials_in_JSON_Format",
  "GenerateDocumentationInSharePointOnline": true,
  "SharePointOnlineUrl": "https://xxxx.sharepoint.com/teams/xxxx",
  "SharePointOnlineClientID": "xxxx",
  "SharePointOnlineClientSecret": "xxxx",
  "AzureStorageNameForDropOff": "full_connection_string"
}

You are now ready to use Cloudockit IT Portal! Simply navigate to your communication site and start the Cloudockit IT Portal experience.

Table of Contents