Versions Compared

Old Version 17

changes.mady.by.user Frances Fleming

Saved on

compared with

New Version 18

changes.mady.by.user Frances Fleming

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To access Concept-Level Sentiment in your Luminoso on-site virtual machine, you must at minimum attach a GPU that is appropriate for your instance type. 

Luminoso Compass instructions

Luminoso Compass install and update instructions have not changed from v2.3. Use the most recent credentials your CSM provides to you and follow the v2.3 instructions for your hosting type.

For AWS and Azure installations – Scale up or down your vCPU or GPU resources

...

  1. Stop the Daylight application from running using the on-site menu.
    Note: If you skip this step, Daylight will not run properly after the vCPU or GPU scaling is changed. 

  2. Completely stop the machine that hosts Daylight. 

  3. Change the machine’s instance type to update the amount of available vCPU or GPU resources.

  4. Power on the machine. 

  5. Start the Daylight application using the on-site menu. 

Microsoft Azure

Install Luminoso

...

Daylightc On-Site

Background 

To use Luminoso on-site for Azure, you must have a valid Azure subscription and Azure Command Line Interface (Azure CLI) installed on your machine. Luminoso provides on-site image(s) per contract, shared with the Azure tenant ID you provide.

...

  1. Sign in the service principal for Luminoso using the <app_ID>, the <app_registration_password>, and the <Luminoso_tenant_ID> that your Luminoso CSM provided. Enter the commands like this:

    az account clear

    az login --service-principal -u '<app_ID>' -p '<app_registration_password>' --tenant '<Luminoso_tenant_ID>'

    az account get-access-token

    Note: your access token is only valid for an hour.

    For reference, your result will look something like this: 

  2. Sign in the service principal again, this time using the <customers_tenant_id> for the Azure account. Use the <app_ID>, the <app_registration_password>, and the <customers_tenant_id>.
    Note: <customers_tenant_id> is the same tenant ID that you provided to your Luminoso CSM as part of the image build request. 
    Enter the commands like this: 

...

  1. Use the Azure CLI to deploy a VM using a command like the following template. Make sure that you have the <image_version_object_id> that your Luminoso CSM shared with you. 

    • To enable Concept-Level Sentiment in your instance, you must at minimum specify Standard_NC6 as the --size <VM_SIZE>. 

    • For quicker Concept-Level Sentiment processing, specify Standard_NC24, as the --size <VM_SIZE>.  

    • As minimum requirements for any machine running Luminoso products, we recommend 4vCPUs and 16 GiB of RAM. This minimum is for relatively low workloads. Please upgrade your instance size based on workload and performance expectations if needed. If you select a virtual machine type below this level, Luminoso functionality does not run properly. This configuration will not include Concept-Level Sentiment.

      az vm create --name <VM_NAME> --resource-group <YOUR_RESOURCE_GROUP> --image <image_version_object_id> --size <VM_SIZE> --data-disk-sizes-gb <DATA_DISK_SIZE_IN_GB> --storage-sku <STORAGE_TYPE> --subnet <YOUR_SUBNET_OBJECT_ID_FOR_DEPLOYMENT> --subscription <YOUR_AZURE_SUBSCRIPTION_ID>.

      Note: You can use the following command to find <YOUR_SUBNET_OBJECT_ID_FOR_DEPLOYMENT>:
      az network vnet list

...

  1. Confirm that you have a Luminoso-client-[client name] given the contributor role for the resource group you are using for the upgrade process:

    • If you have used this resource group for Luminoso on-site before, use the Access control (IAM) menu to check that the role is present and correct.

    • If this is a new resource group for Luminoso on-site deployment, open the Access control (IAM) menu and add a role using steps 4-6 of “Set up the Azure Environment for Luminoso VM Deployment.” 

  2. Sign in the service principal for Luminoso using the <app_ID>, the <app_registration_password>, and the <Luminoso_tenant_ID> that your Luminoso CSM provided. Enter the commands like this:

    az account clear

    az login --service-principal -u '<app_ID>' -p '<app_registration_password>' --tenant '<Luminoso_tenant_ID>'

    az account get-access-token

    Note: your access token is only valid for an hour.
    For reference, your result will look something like this:

  3. Sign in the service principal again, this time using the <customers_tenant_id> for the Azure account. Use the <app_ID>, the <app_registration_password>, and the <customers_tenant_id>.
    Note: <customers_tenant_id> is the same tenant ID that you provided to your Luminoso CSM as part of the image build request. 
    Enter the commands like this: 

    az login --service-principal -u '<app_ID>' -p '<app_registration_password>' --tenant '<customers_tenant_id>'
    az account get-access-token

  4. Use the Azure CLI to deploy a VM using a command like the following template. Make sure that you have the <image_version_object_id> that your Luminoso CSM shared with you.

    az vm create --name <VM_NAME> --resource-group <YOUR_RESOURCE_GROUP> --image <image_version_object_id> --size <VM_SIZE> --attach-data-disks <NEW_DATA_DISK_NAME_CREATED_FROM_SNAPSHOT> --storage-sku <STORAGE_TYPE> --subnet <YOUR_SUBNET_OBJECT_ID_FOR_DEPLOYMENT> --subscription <YOUR_AZURE_SUBSCRIPTION_ID>.

    Note: You can use the following command to find <YOUR_SUBNET_OBJECT_ID_FOR_DEPLOYMENT>:
    az network vnet list

    • Filled out, your command might look like this:

    • You receive a success message like this one:  

  5. SSH to the upgraded VM deployed from the new Luminoso on-site image. It may take a few minutes to configure the application on the first boot. The Daylight on-site menu opens. 

  6. For configuration steps, refer to the appropriate Luminoso Daylight or Compass On-site product documentation.

AWS AMI: Install Luminoso Daylight

...

On-site

Background

Luminoso provides virtual appliances to run Luminoso Compass and Luminoso Daylight in clients’ data center. Follow these instructions to install the virtual appliance so you can configure and use the product.

...

  1. Log into your AWS Account and navigate to EC2. The EC2 Dashboard opens. 

  2. Under Images select AMIs and search for the AMI using the AMI ID that Luminoso provided.

  3. Select the AMI that matches your build number and click Launch to open the Launch Wizard.

  4. Choose an Instance Type: 

    • To enable Concept-Level Sentiment in your Daylight instance, you must specify a g4dn.xlarge instance type for minimum processing requirements. 

    • For quicker Concept-Level Sentiment processing, choose g4dn.12xlarge.   

    • For Luminoso Compass instances, you must specify a r5a.xlarge instance type for minimum processing requirements. 

    • The minimum requirements for Luminoso deployments are 4vCPUs and 16 GiB of RAM. This requirement is for relatively low workloads. We recommend using the r family because it is memory-optimized and better for large amounts of text data. Please upgrade your instance size based on workload and performance expectations if needed. If you select an instance type below the specifications outlined above Luminoso functionality will not work as intended. This configuration will not include Concept-Level Sentiment. 

  5. Click Next: Configure Instance Details. The Step 3: Configure Instance Details page opens. 

  6. Use the options to configure your instance based on your company requirements.

  7. Click Add New Volume to add and configure the data disk.
    Warning: For installations with Concept-Level Sentiment, ignore the ephemeral0 volume. The ephemeral0 volume type cannot be treated as a data disk for Daylight, so you must still add a new volume.

    • For new installations, new disk size depends on the number of projects processed. Your Luminoso Account Manager is responsible for communicating the recommended size of the data disk

    • For upgrades, enter the Snapshot ID of the previous instances’ data volume snapshot so the new system starts with a data volume based off that snapshot.

  8. Select "Delete on Termination" or "Encryption" based on your company requirements for the data disk added in Step 7.

  9. Click Next: Add Tags. Step 5: Add Tags opens.

  10. Add tags as applicable to your organization. If you don’t need tags, skip this step. Within AWS, tags allow you to place arbitrary labels on resources that help you report. If you have a tagging policy that says “every resource needs to have a tag” then you can see what resources everyone is using 

  11. Click Next: Configure Security Groups. 

  12. Configure security groups as required by your organization.

  13. Click Review and Launch. The Review Instance Launch page opens. 

  14. Review the details and confirm that the settings you selected are correct. 

  15. Click Launch. A Select an existing key pair or create a new key pair window opens. 

  16. Select Proceed without a key pair. The Luminoso Daylight image is prepopulated with credentials that your CSM provides. 

  17. Click Launch Instances. Your instance begins the launch process. 

  18. For configuration steps, refer to the appropriate Luminoso Daylight or Compass On-site product documentation.Upgrade Procedure for AMI Deployment

AWS AMI Upgrade Instructions

  1. Shut down the previous on-site VM.

  2. Click Volumes and select the data volume of your old instance.

  3. Go through the steps on the Create Snapshot page. Click Create Snapshot and record the snapshot ID provided on the page. 

  4. Follow the steps in the installation guide to create a new on-site VM. Instead of adding a new data disk, attach the snapshot from the previous on-site version.
    Note: If you are upgrading to use Concept-Level Sentiment, make sure to select an instance type that uses GPU. 

    1. On the Add Storage page, select a size that is either the same as or larger than your previous data disk. 

    2. You must change the device name when you add this disk. 

    3. In the Device column, use the menu to change /dev/sdb to /dev/sdf.

  5. Start the new VM and connect via ssh with admin credentials. The system runs any necessary data migrations. If the upgrade involves large schema changes, or if you have many existing projects, this may take a while. We recommend running it overnight.
    Note: The new admin password should work, so you don’t need to remember the admin password for the previous machine. 

  6. Check the configuration to ensure that your settings were imported correctly.

  7. Start the application.

VMware: Install Luminoso Daylight

...

On-site

Upload the virtual appliance

...

  1. Right click the VM instance and select Power > Power on the virtual machine.

  2. Refer to the appropriate Luminoso Daylight or Compass on-site product documentation for the configuration steps. 

...

  1. Shut down your old machine. 

  2. Deploy a new machine and keep both machines powered off. 

  3. In Storage, under the correct datastore, select the directory of your old virtual machine. 

  4. Select your data disk and click Copy to and copy the data drive from your old Luminoso virtual machine directory to the new one. The copy progress displays in the Recent Tasks pane. 

  5. Right click your new machine and select Edit Settings. The Edit Settings window opens. 

  6. Click Add New Device and select Add Hard Disk. A file explorer opens. 

  7. In the Datastores column, select your new virtual machine. In the Contents column, select the disk you copied from your previous machine. 

  8. Click OK. The File explorer closes. 

  9. Click OK. The Edit Settings window closes. 

  10. Power on your new machine. 

Luminoso Compass Onsite: Configuration Guide

Getting Started with Compass

  1. Select Manage Compass Service from the Main Menu and press ENTER. The Manage Compass Service menu opens. 

...

  1. Select Edit Compass Environment Variables. 

...

A list of available variables displays with blank slots for you to fill in. ALLOWED_HOSTS is used for a (list of) domain/host name(s) where you access the Compass service. If you use multiple hostnames, separate them with commas.
Note: Do not enclose values in quotation marks. Tab to the OK button in the bottom right and press ENTER to finish and save your values. If you press CANCEL, you exit without saving changes and erase all values.

...

  1. You are now ready to start the Compass service. Select Manage Compass

  2.  Service -> Manage Service -> Start Compass. The startup sequence begins. This may take up to two minutes during the first deployment. 

...

The names of the services being started appear on the screen. A screen like this appears when the sequence is finished:

...

  1. Tab to the OK button and press ENTER. A screen like the following appears:

...

  1. Use tab to highlight the OK button and press ENTER to return to the main menu. Your Compass Service is now ready to use. 

  2. Log in to the application using the name master and password master.
    Note: We recommend changing the password for master after your first login.

Additional Configuration Options

To complete any of these tasks, you must log in to the on-site virtual machine using admin credentials. 

To make system changes: 

  1. Select Manage System from the menu.

  2. Select the appropriate menu option, make the necessary changes, and click OK.

Change Hostname 

  1. Open Manage System -> Configure Networking -> Configure Hostname

  2. Change the fully-qualified domain name to your preferred domain name.

  3. Select OK.

NOTE: If you have DHCP and are changing the hostname, you must reboot the machine to report the new hostname to the DHCP server.  

Change DHCP to Static IP

  1. Open Manage System -> Configure Networking -> Configure Interface

  2. Change “DHCP” to “Static”.

  3. Enter the desired IP address, Netmask, Gateway, and DNS Server. These fields are only valid if you have selected “Static” above.

  4. Select OK.

Use an internal NTP server

  1. Open Manage System -> Configure Networking -> Configure NTP

  2. Change “DHCP” to “Static”.

  3. Enter the domain name of the NTP server you wish to use.

  4. Select OK.  

NOTE: You must already have successfully changed to a static IP address in order to configure a static NTP server.

Change admin password

  1. Open Manage System -> Change admin password

  2. Change the admin password.

  3. Select OK.

NOTE: You cannot log into the Compass software as “admin”, but must log in as one of the created users.

Configure HTTPS

  1. Open Manage Compass Service -> Configure HTTPS

  2. Select “Enable HTTPS”.

  3. Upload your certificate and key to the Virtual Machine via sftp using a command similar to
    sftp certcopy@[hostname]:https <<< $’put [/path/to/certificate.pem]’
    If prompted for a password, use the admin password.

  4. Your certificate and key should both appear in the lists below; select the certificate file in the “Select Certificate File” list and the associated key in the “Select Key File” list.

  5. Select OK.

Proxy Settings

If your deployment requires one or more http reverse proxies in front of Luminoso on-site, we recommend configuring all proxies so that requests are limited to 200 MiB in size. 200 MiB is Luminoso’s internal limit.

Compass Documentation: Managing Users and Accounts

Manage Accounts and Users via API commands on your Compass admin account. For a detailed list of endpoints, refer to the Compass API documentation, which outlines how to accomplish typical user management tasks.  

Note: You can access the DRF via browser to the Compass API. The screenshots displayed used here were taken with DRF.

You can log in to the application with login name master and password master. We recommend you change the password for master after you first log in.

Overview

...

Action

...

Details

...

Step 1: Add an Account

...

You can create one or more accounts in Compass. Accounts are containers for projects and users receive permissioned access to accounts. Typically, accounts segregate users and their projects to specific groups or departments.

Use the POST /api/accounts/ endpoint to create and specify the name of the account (“Marketing” in the example below). 

...

Save or copy the ID of the account for future steps.

...

Step 2: Add a User

...

Use the POST /api/users endpoint to add a user and specify the user’s email, name, default account and admin option. Once you call the endpoint, it creates the user (as seen below)

...

Note: Since admin users have full access to the system, including creating other users and accounts assign the option sparingly.

...

IMPORTANT: Save the user id and temporary password for future steps.

Note: If you forget to save the temporary password, call this endpoint to reset it: /api/users/USERID/password/reset

...

Step 3: Assigning Permissions

...

Grant the user you created a permission on the account. The available permissions are:

  • read: provides read-only access to projects, can only view projects, not create or edit them

  • readwrite: provides create and edit permissions on projects in the account

  • manage: (to be expanded in the future, but for now the same as readwrite) provides create and edit permissions on projects in the account

  • listener: reserved, do not use

To give the user a permission on the account, use the POST /api/permissions/ endpoint and specify 

the User ID from Step 2, the account from Step 1 and the Level. 

...

Now the user is granted a permission to the account:

...

You have now created an account, a user, and have given the user desired access to the account. Lastly, tell the user their temporary password that you set in Step 2.

...

  1. . 

  2. Click OK. The Edit Settings window closes. 

  3. Power on your new machine. 

Luminoso Daylight On-site Configuration Guide

...

  1. Select Manage System from the menu, select the appropriate menu option, and make any necessary changes, 

  2. Click OK.

Change Hostname 

  1. Open Manage System -> Configure Hostname

  2. Change the fully-qualified domain name to your preferred domain name.

  3. Select OK.
    Note: If you have DHCP and are changing the hostname, you will have to reboot the machine to report the new hostname to the DHCP server.

Change DHCP to Static IP

  1. Open: Manage System -> Configure Interface

  2. Change “DHCP” to “Static”.

  3. Enter the desired IP address, Netmask, Gateway, and DNS Server. These fields are only valid if you selected “Static” above.

  4. Select OK.

...

  1. Open Manage System -> Configure Inactivity Timeout

  2. Update the Inactivity Timeout and Maximum session length values in seconds.

  3. Select OK.

Use an internal NTP server

  1. Open Manage System -> Configure NTP

  2. Change “DHCP” to “Static”.

  3. Enter the fully-qualified domain name of the NTP server you wish to use.

  4. Select OK.  

Note: You cannot use NTP via DHCP if you are not using DHCP to assign an IP address.

Change admin password

  1. Open Manage System -> Change admin password

  2. Change the admin password

  3. Select OK.

...

NOTE: In order to have the Virtual Machine send alert emails, you need to have configured SMTP.

Configure HTTPS

  1. Open Manage System -> Configure HTTPS

  2. Select “Enable HTTPS”.

  3. Upload your certificate and key to the Virtual Machine via sftp using a command similar to
    sftp certcopy@[hostname]:https <<< $'put [/path/to/certificate.pem]'
    If prompted for a password, use the admin password.

  4. Your certificate and key should both appear in the lists below; select the certificate file in the “Select Certificate File” list and the associated key in the “Select Key File” list.

  5. Select OK.

...

  1. Go to: Manage Users and Workspace -> Rename Workspace

  2. Select a workspace and enter the new name.

  3. Select OK.

Proxy Settings

If your deployment requires the use of one or more http reverse proxies in front of Luminoso On-site, Luminoso recommends configuring any and all proxies so that requests may be up to 200 MiB in size. 200 MiB is the limit Luminoso imposes internally.

Read instructions in PDF form.

...