Skip to main content

Set up AI Unlimited

note

Before you start, make sure you have all the necessary details to update the cloud integration section. You must have the minimum configuration values, including Default region, Default subnet, and Default security groups. If you are unsure, Teradata recommends reaching out to your cloud administrator for guidance.

Access AI Unlimited setup:

Are you an AI Unlimited user or administrator? Choose your path: This topic (which will be for both the QS and the full install) is meant only for the user doing the installation. For the QuickStart, that user is also a general user. For the full installation, that is less likely to be the case. But either way, it's in the installation flow--so should not descibe the other uses. There will be other topics for an admin to change settings under "manage" in the TOC, and for a general user to get their API key (under "explore and analyze data" in the TOC.

  • If you're an AI Unlimited user, AI Unlimited is set up and ready to use. Authorize using your Git provider credentials. This authorizes the AI Unlimited to authenticate the user and access your Git repo. Copy the API Key [Glossary] from your Profile page and then proceed to running your first workload on AI Unlimited.

  • If you're an AI Unlimited administrator, complete the setup. To learn more about specific fields, click a section below.

  • If you're a returning AI Unlimited administrator looking to modify the setup information, authorize using your GitHub credentials and select SETUP.

Step 1: The basics

  • Service base URL: The root URL of the service. This value determines the URL you’ll be redirected to after successful Git authorization and varies depending on the type of installation.

    • QuickStart:
    • Demo or Full install:

  • Git provider: The Git provider used to store project details.

  • Service log levels: Defines the level of detail recorded in the log files. The default is Info; however, Teradata recommends selecting Debug. This option captures fine-grained informational events that could help you debug errors.

  • Engine IP network type: The type of network assigned to an engine instance that would allow AI Unlimited to communicate with the engine. Select Private if you're deploying the engine in the same VPC as AI Unlimited. Select Public if AI Unlimited is running on a local container.

  • Use TLS: Indicates if Transport Layer Security (TLS) support is enabled to secure communication to AI Unlimited. If you use a self-hosted AI Unlimited instance without a load balancer, Teradata recommends setting this option to True and uploading or generating TLS certificates. For enterprise users employing a load balancer, set this option to False, as the load balancer manages TLS certificates.

    If you have a certificate issued by a trusted Certificate Authority (CA), you can provide it and its key. You'll be responsible for managing the certificate lifecycle, including renewal and validation. If you have specific requirements or need more control over your certificates, bringing your own is a good option. You can also select GENERATE TLS to use a Teradata system-generated certificate. It automatically renews before it expires.

After you've filled in all the details, select Update.

Step 2: Cloud integration
note

You can modify these parameters directly from the Jupyter notebook while connecting to the AI Unlimited engine.

  • Default region: The region where you want to deploy the engine. Teradata recommends choosing the region closest to your primary work location.
  • Default subnet: The subnet that provides the engine instance with a route to an internet gateway. If you don't specify a subnet, the engine is automatically associated with the default subnet.
  • Default IAM role: The default IAM identity that provides the required permissions to deploy the engine instance. When a default IAM role is assigned to a user or resource, the user or resource automatically assumes the role and gains the permissions granted to the role. If AI Unlimited creates the IAM role, it creates it for the AWS cluster that deploys the engine—each time you deploy the engine. If your organization creates the role, it must be broad enough to include all the clusters that might deploy the engine.
  • Resource tags: The key-value pair applied to a resource to hold metadata about that resource. With a resource tag, you can quickly identify, organize, and manage the AI Unlimited resources you use in your environment.
  • Default CIDRs: The list of Classless Inter-Domain Routing (CIDR) network addresses that can be allocated to the engine. Use CIDR to allocate IP addresses flexibly and efficiently in your network. If you don't specify a CIDR, the engine is automatically associated with the default CIDR.
  • Default security groups: The list of security groups for the VPC in each region. Security group is a virtual firewall that contains rules to monitor and filter the incoming and outgoing traffic for the VPC in each region. If you don't specify a security group, the engine is automatically associated with the default security group for the VPC. If you're deploying AI Unlimited using the CloudFormation template or ARM template, make sure the default security group is the same as the one in the template to ensure AI Unlimited can communicate with the AI Unlimited engine.
  • Role Prefix: The string of characters prepended to the name of a role. You can use a role prefix to organize and manage roles and to enforce naming conventions.
  • Permission Boundary: The maximum permissions an IAM entity can have regardless of the permissions defined in the identity-based policy. You can define and manage the user permissions and roles and enforce compliance requirements.

After you've filled-in all the details, select Update.

Step 3: Git integration

  • Application URL: The default URL of your Git provider account. If you're using an Enterprise account, Teradata recommends updating this value to match your hosted private URL by modifying the Base URL.

  • Callback URL: The URL to redirect to after you authorize using the Git provider.

  • Base URL: The base URL of your Git provider account. The URL may vary based on your account type. For example, https://github.company.com/ for a GitHub Enterprise account. To change the Application URL, update this value.

  • Client ID: The Client ID you received from the Git provider on creating your OAuth App.

  • Client Secret: The Client secret ID you received from the Git provider on creating your OAuth App.

** Configure GitHub Organization Access**

  • Authorizing Organization: Restricts AI Unlimited access to users belonging to a specific organization on GitHub. If left blank, any user with a GitHub account can authorize and access AI Unlimited.

  • Repository Organization: Create projects within the repository. If left blank, your projects are located in your personal GitHub space. Teradata recommends specifying this value to collaborate and centralize projects within a specific group.

Select Update and then Login.

If you're an AI Unlimited administrator, go to the Profile page to copy your API Key. If you've enabled TLS, select Restart to restart the service and apply the changes.