When the Rubiscape platform is deployed on any instance, the configuration for that instance is monitored and modified using the Settings page. As an administrator, you can visit the Settings page to perform various configuration handling tasks.
Rubiscape provides settings support for the following options.

  • General
  • Storage
  • Cache
  • Auto Scaling
  • Organization

These settings are

  • Common for all tenants
  • Accessible by super admin, root admin, and tenant admins
  • Either instance-level or tenant-level (depending on their functioning)

The following sections discuss each of these settings in detail.

General Settings

General settings are applicable at the instance level.
These settings are useful for

  • Any kind of scheduling activity. For example, scheduling a Workflow or a Dashboard.
  • Running the SSAS and Jupyter URLs

The following table explains various fields in General settings.

Field

Description

Remark

SMTP Server

Simple Mail Transfer Protocol Server.

  • It's an application for mail servers to send/receive/relay an outbound email between its sender and receiver.
  • It has single or multiple addresses.
  • Locate the SMTP email server address in your mail client's account or settings section.

SMTP Port

Simple Mail Transfer Protocol Port

  • SMTP port is a communication endpoint of a device connected to a network.
  • Each port has a particular purpose and is associated with a specific protocol.
  • Usually, outgoing servers employ port 25 as the default SMTP port.

Sender Email ID

Enter the email address you wish to be the default sender ID for all the scheduling purposes.

The Sender Email ID is used

  • As one of the email addresses in the "From" field in dashboard scheduling, the email address should be registered in this domain.
  • As the only email in the workflow scheduling
  • To send emails to users for resetting the password and renewing a forgotten password

Sender Email Password

Enter a valid email password for the above email ID.

  • The password is used internally. So the user need not remember it.
  • If the password is reset at the source, then it needs to be updated in the application

SSAS URL

SQL Server Analysis Services Uniform Resource Locator

  • It is a multidimensional online analytical processing server and analytics engine.
  • It helps you slice and dice a huge amount of data.
  • In Rubiscape, SSAS connection is a part of RubiConnect.
  • The SSAS URL is required to establish the connection.
  • In RubiConnect, the external data connection service runs on the Cloud Windows Virtual Machine (VM). SSAS URL is the connection for that service.

Jupyter URL

Jupyter Uniform Resource Locator

  • Jupyter notebook web application in Rubiscape runs on the Jupyter URL.
  • In Rubiscape, the Jupyter Notebook instance runs on this URL.
  • By default, the Jupyter notebook server runs locally and is accessible only from the localhost.
  • It can be the same as the running instance; however, the port needs to be different. It needs to be validated that the Jupyter instance is running on that server and port configuration.


(warning)
Warning

  • The setting details are provided by the Technical Operations team that deploys Rubiscape and has access to these credentials.
  • Enter the correct credentials; otherwise, a validation error is displayed. For example, if there is an SMTP Server Error, you get the error message, "Connectivity unexpectedly closed".

Storage Settings

In Rubiscape, the storage settings are at the instance level. Currently, Rubiscape supports five types of storage. You can select any storage as required.

  • Local (default)
  • S3 on AWS
  • MinIO
  • Azure Blob Storage
  • Google Cloud Platform

The following sections explain these storage types in detail.

Local

Local storage is the default storage for Rubiscape.
It requires no additional inputs.

S3 on AWS

Amazon Simple Storage Service (S3) is a public cloud object storage service that stores data as objects within buckets. The object is a combination of a file and its metadata. Buckets are containers to store these objects.
The S3 on AWS storage contains the following fields.

The following table explains various fields in S3 on AWS settings.

Field

Description

Remark

AWS Access Key

Enter the AWS Identity and Access Management (IAM) Key.

  • AWS access key is the long-term credential for the IAM user.
  • It is a string-type key with a minimum of 16 and a maximum of 128 characters.
  • The AWS Access Key is maintained by the IT Team of your organization or the AWS S3 Admin on the client-side.

AWS Secret Key

Enter the secret key to sign requests.

  • It is a string-type key used for API calls.
  • The AWS Secret Key is maintained by the IT Team of your organization or the AWS S3 Admin on the client-side.

S3 Bucket Name

Enter a suitable name for the S3 storage container.

  • The bucket is a container for objects that are stored in Amazon S3.
  • The bucket name should
  • Be unique within a partition
  • Have a minimum of 3 and a maximum of 63 characters.
  • Begin and end with a letter or a number.
  • Consist of only lowercase letters, numbers, dots, and hyphens.
  • Neither start with a prefix nor end with a suffix.
  • Not be formatted as an IP address.

MinIO

MinIO is an open-source distributed object storage server. It comes with an S3 storage functionality designed for private cloud infrastructure. MinIO is one of the best servers for storing unstructured data (images, videos, log files, backups, and containers).
The MinIO storage contains the following fields.

The following table explains various fields in MinIO settings.

Field

Description

Remark

MinIO Access Key

Enter the MinIO Access Key to authenticate the user.

  • It is a unique key containing a minimum of 5 characters.
  • It is equivalent to a username.

MinIO Secret Key

Enter the MinIO Secret Key to authenticate the user.

It is a unique key and equivalent to a password.

MinIO Host

Enter a valid IP address to connect to the MinIO host server.

The hostname needs to include the port.

MinIO Bucket Name

Enter a valid MinIO bucket name

  • The bucket name should
  • Be unique within a partition
  • Have a minimum of 3 and a maximum of 63 characters.
  • Begin and end with a letter or a number.
  • Consist of only lowercase letters, numbers, dots, and hyphens.
  • Neither start with a prefix nor end with a suffix.
  • Not be formatted as an IP address.

Azure Blob Storage

Azure Blob (Binary Large Object) Storage is Microsoft's cloud-based object storage solution. It is an optimized storage facility to store a huge amount of unstructured, text, and binary data.
The Azure Blob Storage contains the following fields.

The following table explains various fields in Azure Blob Storage settings.

Field

Description

Remark

Default Endpoint Protocol

Enter the default endpoint protocol HTTPS, which is the default for Azure.

  • HTTPS stands for Hypertext transfer protocol secure. It is encrypted to increase the data transfer security, especially sensitive data.
  • It is a secure version of the primary protocol, HTTP.
  • It is used to transfer data between a web browser and a website.

Account Name

Enter the account name for the Azure storage.

It is user-specific.

Account Key

Enter the account key for the Azure storage

It is user-specific.

Endpoint Suffix

Enter the endpoint suffix for the Axure storage.

The default endpoint suffix is core.

Blob Storage Container Name

Enter a suitable blob storage name for the Azure storage bucket.

Google Cloud Platform

Google Cloud Platform provides an object storage facility to companies of all sizes and data generation capacity. You can store and retrieve data as and when you want.
The Google Cloud Platform contains the following fields.

The following table explains various fields in Azure Blob Storage settings.

Field

Description

Service Account Credential JSON

Click Upload File to upload the JSON file containing the service account credentials.

GCP Storage Bucket Name

Enter a suitable name for the Google Cloud Platform storage container name.


(warning)
Warning

  • Do not forget to click Save Storage Details!
  • If you click Discard, all changes made since the last save get deleted.

Cache

In Rubiscape, the cache settings are at the instance level. Currently, Rubiscape supports six types of caches. You can select any caching method as required.

  • Django
  • Redis
  • S3 on AWS
  • MinIO
  • Azure Blob Storage
  • Google Cloud Platform

The following sections explain these storage types in detail.

Django

Django is the default storage for Rubiscape cache.
It requires no additional inputs.

Redis

Redis is an open-source in-memory data structure store used as a cache in Rubiscape.
The Redis cache contains the following fields.

The following table explains various fields in Redis cache settings.

Field

Description

Remark

Redis Cache Host

Enter the cache host on which the Redis cache is stored.

Usually, the cache is stored on the localhost.

Redis Cache Port

Enter the cache port to which the Redis cache is connected.

The default Redis cache port is 6379.

S3 on AWS

Amazon Simple Storage Service (S3) is a public cloud object storage service that stores data as objects within buckets. The object is a combination of a file and its metadata. Buckets are containers to store these objects.
The S3 on the AWS cache contains the following fields.

The following table explains various fields in S3 on AWS settings.

Field

Description

Remark

AWS Access Key

Enter the AWS Identity and Access Management (IAM) Key.

  • AWS access key is the long-term credential for the IAM user.
  • It is a string-type key with a minimum of 16 and a maximum of 128 characters.
  • The AWS Access Key is maintained by the IT Team of your organization or the AWS S3 Admin on the client-side.

AWS Secret Key

Enter the secret key to sign requests.

  • It is a string-type key used for API calls.
  • The AWS Secret Key is maintained by the IT Team of your organization or the AWS S3 Admin on the client-side.

S3 Cache Bucket

Enter a suitable name for the S3 cache container.

  • A bucket is a container for objects that are stored in Amazon S3.
  • The bucket name should
  • Be unique within a partition
  • Have a minimum of 3 and a maximum of 63 characters.
  • Begin and end with a letter or a number.
  • Consist of only lowercase letters, numbers, dots, and hyphens.
  • Neither start with a prefix nor end with a suffix.
  • Not be formatted as an IP address.

MinIO

MinIO is an open-source distributed object storage server. It comes with an S3 storage functionality designed for private cloud infrastructure. MinIO is one of the best servers for storing unstructured data (images, videos, log files, backups, and containers).
The MinIO cache contains the following fields.

The following table explains various fields in MinIO settings.

Field

Description

Remark

MinIO Access Key

Enter the MinIO Access Key to authenticate the user.

  • It is a unique key containing a minimum of 5 characters.
  • It is equivalent to a username.

MinIO Secret Key

Enter the MinIO Secret Key to authenticate the user.

It is a unique key and equivalent to a password.

MinIO Host

Enter a valid IP address to connect to the MinIO host server.

The hostname needs to include the port.

MinIO Bucket Name

Enter a valid MinIO bucket name

  • The bucket name should
  • Be unique within a partition
  • Have a minimum of 3 and a maximum of 63 characters.
  • Begin and end with a letter or a number.
  • Consist of only lowercase letters, numbers, dots, and hyphens.
  • Neither start with a prefix nor end with a suffix.
  • Not be formatted as an IP address.

Azure Blob Storage

Azure Blob (Binary Large Object) Storage is Microsoft's cloud-based object storage solution. It is an optimized storage facility to store a huge amount of unstructured, text, and binary data.
The Azure Blob cache contains the following fields.

The following table explains various fields in Azure Blob cache settings.

Field

Description

Remark

Default Endpoint Protocol

Enter the default endpoint protocol HTTPS, which is the default for Azure.

  • HTTPS stands for Hypertext transfer protocol secure. It is encrypted to increase the data transfer security, especially sensitive data.
  • It is a secure version of the primary protocol, HTTP.
  • It is used to transfer data between a web browser and a website.

Account Name

Enter the account name for the Azure cache.

It is user-specific.

Account Key

Enter the account key for the Azure cache.

It is user-specific.

Endpoint Suffix

Enter the endpoint suffix for the Axure cache.

The default endpoint suffix is core.

Blob Cache Container Name

Enter a suitable blob cache name for the Azure cache bucket.

Google Cloud Platform

Google Cloud Platform provides an object storage facility to companies of all sizes and data generation capacity. You can store and retrieve data as and when you want.
The Google Cloud Platform contains the following fields.

The following table explains various fields in Azure Blob Cache settings.

Field

Description

Service Account Credential JSON

Click Upload File to upload the JSON file containing the service account credentials.

GCP Storage Bucket Name

Enter a suitable name for the Google Cloud Platform cache container name.


(warning)
Warning

  • Do not forget to click Save Cache Details!
  • If you click Discard, all changes made since the last save get deleted.

Autoscaling

Autoscaling is a cloud computing technique for scaling cloud-based services and dynamically allocating computational resources. Depending upon the user needs, server traffic, and load on a server, the active number of servers (typically called workers) varies automatically. Typically, several workers are activated simultaneously as required when the load peaks, while when there is no substantial traffic on a server, the workers are scaled down (switched off). Hence, the only optimum number of workers are active at any time.
In Rubiscape, the autoscaling settings are tenant-specific. As you change the tenant, these settings also change. It may so happen that one of your projects with a specific workload is handled through one tenant. Hence, separate settings may be required and can be configured for separate tenants.
Currently, two scenarios are possible related to auto-scaling in Rubiscape.

Auto-scaling disabled:

  • NO auto-scaling
  • Worker node configurations are default and are decided by the admin

Auto-scaling enabled:

Rubiscape provides support for the following two cloud providers:

  • Microsoft Azure
  • AWS

The following four drop-downs are the same for Microsoft Azure and AWS.

  • Maximum Workers (Frequency)
  • No. of tasks per worker
  • Instance Type
  • Instance

(info)Notes

  • If autoscaling is disabled, the following are the default settings for the above four drop-downs:
    • Maximum Workers = 10
    • No. of Tasks Per Worker = 1
    • Instance Type = General Purpose
    • Instance = t2.micro
  • When the autoscaling is disabled, the above values are set up by the deployment team. These values can be changed by raising a support request.
  • Currently, these values cannot be changed/modified from the Admin Module.
  • Both Microsoft Azure and AWS are kept as read-only properties. Hence, a normal user cannot change the cloud provider.
  • You can change a cloud provider only through the code or the API.
  • Changing a cloud provider is a migration activity with huge financial and infrastructural liabilities.
  • Maximum workers and the number of tasks per worker decide the concurrency for executing tasks.
  • Instance Type and Instance depend on the cloud provider. They vary from region to region.

The following sections discuss the two cloud providers in detail.

Amazon Web Services (AWS)

The AWS cloud provider contains the following fields.

The following table explains various fields in AWS cloud provider settings.

Field

Description

Remark

Maximum Workers (Frequency)

Enter the maximum number of tasks that can be run simultaneously on a worker.

  • Any task beyond this number waits in the queue till a worker becomes free to take it up.
  • It decides the concurrency capability of the server.

No. of Tasks Per Worker

Enter the number of tasks you want to run at a time on each worker.

  • When an instance gets spawned in the auto-scaling mode, this number decides how many tasks are executed at a time on each server.
  • It decides the concurrency capability of the server.

Instance Type

Select the instance type from the drop-down.

Options:

  • General Purpose
  • Compute Optimized
  • Memory-Optimized

Instance

Select the instance based on the instance type and the computational power required.

  • It gives you a choice to change the instance according to compute required for executing a particular task.
  • For example, for heavy compute requirements, you can select higher version instances in Compute Optimized or Memory Optimized Instance Types.
  • The list of Instances depends upon the selected Instance Type.
  • It changes according to the Instance Type.

Image Id

Enter the Amazon Machine Image (AMI) ID to launch the instance.

  • You need to specify an AMI when you launch an instance.
  • Multiple instances with the same configuration can be launched from a single AMI.

Secret Key

Enter the secret key to launch the instance.

It is like a password.

Subnet Id

Enter the Subnet ID to access a range of IP addresses in your Virtual Private Cloud.

  • AWS itself generates it.
  • It may be unique to a VPC, Account, Region, or the entire AWS.

Region Name

Enter the name of the physical location where your data center (also called the Availability Center) is located.

  • A region is a physical location where the data centers are clustered.
  • AWS maintains multiple geographic regions in North America, South America, Europe, China, Asia Pacific, South Africa, and the Middle East.
  • For more information, visit the link here.

Security Group Ids

Enter the security group IDs for your EC2 instance.

  • The security group ID is important for network interface activities.
  • A security group acts as a virtual firewall to control traffic influx and outflow.
  • A separate set of rules controls the inbound and outbound traffic.
  • When an instance is launched, you can specify one or more security groups.
  • Security group IDs can be listed with a comma (,) used as a separator.

Access Key

Enter your unique user or account identifier key for AWS

  • You first need to sign up for an AWS account to access AWS.
  • The access keys consist of an access key ID and a secret access key.

Key Name

Enter the key name to identify a particular object in the S3 bucket.

  • The key name (also called the object key) is a unique identifier of any object in the S3 bucket.
  • When you create an object, the key name is also specified.

Microsoft Azure

The Azure cloud provider contains the following fields.

The following table explains various fields in Azure cloud provider settings.

Field

Description

Remark

Maximum Workers (Frequency)

Enter the maximum number of tasks that can be run simultaneously on a worker.

  • Any task beyond this number waits in the queue till a worker becomes free to take it up.
  • It decides the concurrency capability of the server.

No. of Tasks Per Worker

Enter the number of tasks you want to run at a time on each worker.

  • When an instance gets spawned in the auto-scaling mode, this number decides how many tasks are executed at a time on each server.
  • It decides the concurrency capability of the server.

Instance Type

Select the instance type from the drop-down.

Options:

  • D Series
  • E Series
  • F Series
  • G Series
  • H Series
  • Ls Series
  • M Series

Instance

Select the instance based on the instance type and the computational power required.

  • It gives you a choice to change the instance according to compute required for executing a particular task.
  • For example, for heavy compute requirements, you can select higher version instances in Compute Optimized or Memory Optimized Instance Types.
  • The list of Instances depends upon the selected Instance Type.
  • It changes according to the Instance Type.

Image Id

Enter the Azure Image ID to launch the instance.

  • You need to specify the Azure Image ID when you launch an instance.
  • Multiple instances with the same configuration can be launched from a single image.

Secret Key

Enter the secret key to launch the instance.

It is like a password.

Subnet Id

Enter the Subnet ID to access a range of IP addresses in your Virtual Private Cloud.

  • AWS itself generates it.
    It may be unique to a VPC, Account, Region, or the entire AWS.

Subscription Id

Enter a unique alphanumeric string to identify your Azure subscription.

  • An Azure subscription links to an Azure account that creates an identity in the Azure Active Directory (AD).
  • It is an agreement between your organization and Microsoft to use its resources.

Tenant Id

Enter your global unique identifier (GUID).

  • The Azure Tenant ID is a Global Unique Identifier (GUID) to identify your Microsoft 365 Tenant.
  • It is also called the Office 365 Tenant ID.
  • It is not the same as your organization/domain name.

Location

Enter the location of your data center.

  • An Azure location or region is a set of data centers.
  • It is deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.
  • An Azure region has discrete pricing and service availability.
  • For more information, visit the link here.

VM User

Enter your Virtual Machine Administrator User name.

  • Azure Virtual Machines (VMs) are image service server-like instances.
  • They provide on-demand and scalable computing resources and offer usage-based pricing.

VM Password

Enter the password for your Virtual Machine Administrator User.

Resource Group Name

Enter a name for your resource group.

  • A resource group is a logical container to deploy and manage various Azure resources (web applications, VMs, database servers, virtual networks, and storage accounts)
  • In Microsoft Azure, when you create a VM, you need to assign it to a resource group.
  • It is used for better governance and cost management.

Network Security Group Name

Enter the name of the network security group.

  • An Azure network security group is used to filter inbound and outbound networks from Azure resources in a virtual network.
  • It contains security rules that allow or deny incoming or outgoing network traffic from several types of Azure resources.
  • The source and destination, port, and protocol can be specified for each rule.

Client Id

Enter your application ID with Azure.

  • When you register your Azure client application, you provide the application to Azure AD.
  • Azure AD then provides a client ID (or application ID) to associate your application with Azure AD at runtime.


(warning)
Warning

  • Enter the correct configuration credentials; otherwise, a validation error "Authentication failed. Please enter valid credentials!" is displayed.
  • Do not forget to click Save Auto Scaling Details!
  • If you click Discard, all changes made since the last save get deleted.

Organization

The organization settings are read-only settings where you can add the organization's name, a linear logo, and a small icon.
The permissible size for

  • Linear logo: 97 px (width) by 40 px (height)
  • Small Icon: 40 px (width) by 40 px (height)

The following image formats are supported to upload the linear logo and small icon.

  • PNG
  • JPG
  • JPEG

Table of Contents