fbpx

Knowledge Base

You are here:
Print

Getting Starting – IT Portal

Cloudockit scans your cloud and on-premises infrastructures to obtain a full overview of your applications, resources, and the IT documentation related to them.

Cloudockit IT Portal consumes this data to render it in a user-friendly graphical interface. It is fully operated in your SharePoint Online environment.

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, and on Cloudockit Desktop or Cloudockit Container.

After your installation, visit Navigate Cloudockit IT Portal.

Prerequisites

PRE-REQUISITES TO DEPLOY CLOUDOCKIT IT PORTAL

  • The used account must have SharePoint administrator role
  • The global App Catalog must already exist. 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 installation 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 documentation generation.

Option 2 – Cloudockit Container

If you want 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.

To run the script, we recommend you use the Windows Terminal or PowerShell 7.x.

Use the following command in the Cloudockit IT Portal folder:

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

Example:

.\cloudockit-it-portal-install.ps1 -siteAdminUrl https://yourCompany-admin.sharepoint.com -SiteUrl https://yourCompany.sharepoint.com/sites/ITPortal

At some point, the script will request that you perform a manual operation (dropping the .sppkg package file to a designated url). After you’ve done it, you’ll just need to restart the script with the same parameters.

Since Cloudockit IT Portal is deployed on one of your SharePoint sites, you will have to give Azure AD API access to Cloudockit IT Portal by following the following 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 TENANT APP CATALOG (MANUAL INSTALLATION)

You’ll need an account with SharePoint Administrator role.

1 – Go to the SharePoint Admin Center by entering the following URL in your browser (replace {your-tenant-prefix} with your Microsoft 365 tenant prefix):

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

2 – Click on More features

3 – In the Apps section click on Open

4 – Depending on whether your tenant has been updated with the latest version or not, you’ll see one of the following screens.

If you see this, go to STEP 2 – CREATE A COMMUNICATION SITE

If you see the following, click on App Catalog and carry on with point 5 below.

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

6 – Wait until the App Catalog is created

Your App Catalog is now available.

STEP 2 – CREATE A COMMUNICATION SITE

1 – Go to the SharePoint Admin Center by entering the following URL in your browser, (replace {your-tenant-prefix} with your Microsoft 365 tenant prefix):

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

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 redirected 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.

Please refer to the Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog#create-a-site-collection-app-catalog

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 the cloudockit-client-side-solution card

6 – Navigate to the communication site welcome page 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.
If the Cloudockit web part does not appear, wait a couple of minutes, refresh the page and try again.

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 {your-tenant-prefix} with your Microsoft 365 tenant prefix):

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

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 prerequisites 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",
  "Classifiers": [{"Name": "Application","TagManuallySelected": true,"TagName": "TheTag"}] //Fill the attribute TagName with your application tag use commas separators for multiple tag values
}
{
  "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",
  "Classifiers": [{"Name": "Application","TagManuallySelected": true,"TagName": "TheTag"}] //Fill the attribute TagName with your application tag use commas separators for multiple tag values
}
{
  "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",
  "Classifiers": [{"Name": "Application","TagManuallySelected": true,"TagName": "TheTag"}] //Fill the attribute TagName with your application tag use commas separators for multiple tag values
}

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