From 73a1285adcea11116dd8ce353efeea80d358f2b3 Mon Sep 17 00:00:00 2001 From: MEM4GH <118773316+MEM4GH@users.noreply.github.com> Date: Mon, 22 Jul 2024 16:50:35 -0400 Subject: [PATCH] feat(content): update for august release --- docs/FAQ.md | 18 +- .../create-first-project.md | 2 +- docs/explore-and-analyze-data/get-api-key.md | 6 +- docs/glossary.md | 12 +- .../create-oauth-app.md | 12 +- docs/install-ai-unlimited/index.md | 2 +- .../prod-aws-console-deploy-ai-unlimited.md | 10 +- .../prod-azure-portal-deploy-manager.md | 5 +- .../setup-ai-unlimited.md | 173 +++++++----------- docs/manage-ai-unlimited/add-collaborators.md | 11 +- docs/manage-ai-unlimited/change-settings.md | 23 ++- .../get-project-information.md | 25 +++ docs/manage-ai-unlimited/index.md | 4 +- .../suspend-and-restore-project.md | 2 +- .../view-ai-unlimited-logs.md | 26 +++ docs/resources/aws-requirements.md | 2 +- docs/resources/index.md | 1 - .../jupyterlab/install-jupyterlab-aws.md | 3 +- .../jupyterlab/install-jupyterlab-azure.md | 1 - .../docker-install-ai-unlimited-jupyter.md | 4 +- docs/whats-new/august-2024-fe.md | 29 +++ docs/whats-new/august-2024-rn.md | 23 +++ docs/whats-new/index.md | 137 +------------- docs/whats-new/may-2024-fe.md | 140 ++++++++++++++ .../{release-notes.md => may-2024-rn.md} | 19 +- 25 files changed, 378 insertions(+), 312 deletions(-) rename docs/{resources => install-ai-unlimited}/create-oauth-app.md (76%) create mode 100644 docs/manage-ai-unlimited/get-project-information.md create mode 100644 docs/manage-ai-unlimited/view-ai-unlimited-logs.md create mode 100644 docs/whats-new/august-2024-fe.md create mode 100644 docs/whats-new/august-2024-rn.md create mode 100644 docs/whats-new/may-2024-fe.md rename docs/whats-new/{release-notes.md => may-2024-rn.md} (77%) diff --git a/docs/FAQ.md b/docs/FAQ.md index 2d7970c2b1..2f82530500 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -3,7 +3,7 @@ id: faq title: FAQ description: Find answers to your AI Unlimited questions here. sidebar_label: FAQ -sidebar_position: 6 +sidebar_position: 7 pagination_prev: null pagination_next: null --- @@ -17,7 +17,7 @@ pagination_next: null Currently, AWS and Azure. ### What analytics functions can I use? -[ClearScape Analytics™](https://docs.teradata.com/access/sources/dita/topic?dita:mapPath=phg1621910019905.ditamap&dita:ditavalPath=pny1626732985837.ditaval&dita:topicPath=gma1702668333653.dita) functions. See the [release notes](./whats-new/release-notes.md) for any functions not currently supported. +[ClearScape Analytics™](https://docs.teradata.com/access/sources/dita/topic?dita:mapPath=phg1621910019905.ditamap&dita:ditavalPath=pny1626732985837.ditaval&dita:topicPath=gma1702668333653.dita) functions. See the [release notes](./whats-new/august-2024-rn.md) for any functions not currently supported. ### How do I pay for AI Unlimited? You pay your cloud service provider for the hours that AI/ML engine resources are running. The charges depend on instance size and number of instances. @@ -29,7 +29,7 @@ Email the support team. Al ## Projects ### What is a project? -A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitHub or GitLab account. +A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitLab or GitHub account. ### How do I use a project? In a Jupyter notebook, you create a project, which automatically creates its Git repository. Then you authorize access to your data store, deploy the project's AI/ML engine, and run analytic workloads. You can suspend the project (and engine) anytime, then restore it, to pay only for the hours you need. @@ -52,18 +52,14 @@ Each time you, or another user, suspends a project, its schema is backed up in t ## Users ### What are the AI Unlimited user types? -Admins, project owners, and collaborators: -- The admin is the user who sets up AI Unlimited for your organization. +AI Unlimited owner, project owners, and collaborators: +- The AI Unlimited owner is the user who sets up AI Unlimited for your organization. - The user who creates a project is the project's owner. - Additional users of a project are collaborators. -### I'm an admin. After the initial setup, can I go back and change settings? +### I'm the AI Unlimited owner. After the initial setup, can I go back and change settings? Yes, sign back in to the setup, and make any changes. - -### Can an admin add other admins? -No, AI Unlimited supports one admin. - ### I'm a project owner. How do I add collaborators to a project? First, add them to the project's Git repository. @@ -86,7 +82,7 @@ The saved project information is there. You can pick up right where you left off ### What is the manager? The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML engine on your cloud service provider. -It also provides a web-based user interface from which the AI Unlimited admin sets up AI Unlimited after installing it, and changes settings later as needed. +It also provides a web-based user interface from which the AI Unlimited owner sets up AI Unlimited after installing it, and changes settings later as needed. From their user profile in the manager, all users get their API key for connecting a Jupyter notebook to the manager. diff --git a/docs/explore-and-analyze-data/create-first-project.md b/docs/explore-and-analyze-data/create-first-project.md index 30bfec8d72..4fa574132c 100644 --- a/docs/explore-and-analyze-data/create-first-project.md +++ b/docs/explore-and-analyze-data/create-first-project.md @@ -29,7 +29,7 @@ For your first project, using data we provide, you'll complete this simple workf ## Before you begin -- Your AI Unlimited admin is the person at your organization who set up AI Unlimited. From your admin, get these items: +- Your AI Unlimited owner is the person at your organization who set up AI Unlimited. From your admin, get these items: - The IP address or hostname of the [AI Unlimited manager](../glossary.md#ai-unlimited-manager). diff --git a/docs/explore-and-analyze-data/get-api-key.md b/docs/explore-and-analyze-data/get-api-key.md index 9622c11d24..486e19f07a 100644 --- a/docs/explore-and-analyze-data/get-api-key.md +++ b/docs/explore-and-analyze-data/get-api-key.md @@ -14,11 +14,11 @@ Each time you open a new notebook to create or access a project, you'll need you Your API key, available from your user profile in the manager, stays the same for the lifetime of the AI Unlimited installation. -1. Use the URL provided by your AI Unlimited admin to access the manager. +1. Use the URL provided by your AI Unlimited owner to access the manager. :::note -Your AI Unlimited admin is the person at your organization who set up AI Unlimited. +Your AI Unlimited owner is the person at your organization who set up AI Unlimited. ::: -2. Sign in to GitHub or GitLab, and authenticate yourself. +2. Sign in to GitLab or GitHub, and authenticate yourself. 3. After being routed back to the manager, on your **Profile**, copy your API key. Keep your API key. Or go back to your **Profile** anytime to get it. diff --git a/docs/glossary.md b/docs/glossary.md index 7f98080793..833a225dd6 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -3,7 +3,7 @@ id: glossary title: Glossary description: Terminology for the installation and use of AI Unlimited. sidebar_label: Glossary -sidebar_position: 7 +sidebar_position: 8 pagination_prev: null pagination_next: null --- @@ -15,16 +15,12 @@ pagination_next: null ### AI Unlimited manager -The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML [engine](#engine) on your [cloud service provider](#cloud-service-provider). It also provides a web-based user interface from which the AI Unlimited admin sets up AI Unlimited after installing it, and changes settings later as needed. From the manager, all users get their API key. +The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML [engine](#engine) on your [cloud service provider](#cloud-service-provider). It also provides a web-based user interface from which the AI Unlimited owner sets up AI Unlimited after installing it, and changes settings later as needed. From the manager, all users get their API key. ### API key Your Application Programming Interface (API) key enables you to connect your Jupyter notebook to the manager. This is the first thing you do in a new Jupyter notebook before you create or access a project. -### application load balancer - -Load balancers distribute incoming traffic across servers. An application load balancer inspects incoming traffic content, such as HTTP headers and paths, to make routing decisions. You can use an application load balancer as a way to expose AI Unlimited manager and the engine to the public IP network. - ## C @@ -96,7 +92,7 @@ Load balancers distribute incoming traffic across servers. A network load balanc An OAuth app allows a user to grant access to their account on one website or service to another, without sharing their password. -An OAuth app, that you or someone at your organization creates, allows AI Unlimited to use GitHub or GitLab authentication to manage each [project repository](#project-repository) and, each time the engine is deployed, derive the engine users from the collaborators that have been added to the repository. +An OAuth app, that you or someone at your organization creates, allows AI Unlimited to use GitLab or GitHub authentication to manage each [project repository](#project-repository) and, each time the engine is deployed, derive the engine users from the collaborators that have been added to the repository. ### object storage A scalable, highly effective way to store large amounts of structured, semi-structured, or unstructured data in the cloud. Amazon S3 is object storage on AWS. Azure Blob Storage is object storage on Azure. Object storage is the basis for a [data lake](#data-lake). @@ -106,7 +102,7 @@ A scalable, highly effective way to store large amounts of structured, semi-stru ### project -A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitHub or GitLab account. +A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitLab or GitHub account. ### project repository diff --git a/docs/resources/create-oauth-app.md b/docs/install-ai-unlimited/create-oauth-app.md similarity index 76% rename from docs/resources/create-oauth-app.md rename to docs/install-ai-unlimited/create-oauth-app.md index a7ca781901..64e84fd9e0 100644 --- a/docs/resources/create-oauth-app.md +++ b/docs/install-ai-unlimited/create-oauth-app.md @@ -3,20 +3,22 @@ id: create-oauth-app title: Create an OAuth app description: It will allow AI Unlimited to use your Git provider's authentication to manage project repositories. sidebar_label: Create an OAuth app -sidebar_position: 4 +sidebar_position: 3 pagination_prev: null pagination_next: null --- -# Create a GitHub or GitLab OAuth app +# Create a GitLab or GitHub OAuth app An OAuth app allows a user to grant access to their account on one website or service to their account on another, without sharing their password. -Create an [OAuth](https://oauth.net/2/) app so that AI Unlimited can use GitHub or GitLab authentication to manage each [project repository](../glossary.md#project-repository) and, each time the engine is deployed, derive the engine users from the collaborators you have added to the repository. +Create an [OAuth](https://oauth.net/2/) app so that AI Unlimited can use GitLab or GitHub authentication to manage each [project repository](../glossary.md#project-repository) and, each time the engine is deployed, derive the engine users from the collaborators you have added to the repository. + +1. Sign in to your GitLab or GitHub account. + +2. Create an OAuth app. See [GitLab: Create an OAuth app](https://docs.gitlab.com/ee/integration/oauth_provider.html) or [GitHub: Create an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app). -1. Sign in to your GitHub or GitLab account. -2. Create an OAuth app. See [GitHub: Create an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) or [GitLab: Create an OAuth app](https://docs.gitlab.com/ee/integration/oauth_provider.html). While registering the OAuth app, use these URLs. diff --git a/docs/install-ai-unlimited/index.md b/docs/install-ai-unlimited/index.md index 648aa02081..d437197c1f 100644 --- a/docs/install-ai-unlimited/index.md +++ b/docs/install-ai-unlimited/index.md @@ -34,7 +34,7 @@ If AI Unlimited has already been installed and set up by someone at your organiz ## Prerequisites - A pay-as-you-go AWS or Azure account on which to provision compute resources. See the requirements for your [AWS](../resources/aws-requirements.md) or [Azure](../resources/azure-requirements.md) account. -- A [GitHub](https://github.com) or [GitLab](https://gitlab.com) account to host each project repository for authenticating users and storing project information. +- A [GitLab](https://gitlab.com) or [GitHub](https://github.com) account to host each project repository for authenticating users and storing project information. - Your object storage, where your Amazon or ADLS Gen2 data lake resides. - JupyterLab. See [installation options](../resources/jupyterlab). diff --git a/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md b/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md index 6f4b83ba27..835ef21ccc 100644 --- a/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md +++ b/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md @@ -34,11 +34,10 @@ CloudFormation templates for the manager are here in the AI Unlimited GitHub rep `deployments/aws/templates/ai-unlimited/` -Choose a template based on whether you intend to use a [load balancer](../glossary.md#load-balancer) and what type. +Choose a template based on whether you intend to use a [load balancer](../glossary.md#load-balancer). :::note You might want to ask a cloud admin at your organization for guidance. ::: - - `ai-unlimited-with-alb.yaml`—Hosts the manager behind an [application load balancer](../glossary.md#application-load-balancer) - `ai-unlimited-with-nlb.yaml`—Hosts the manager behind a [network load balancer](../glossary.md#network-load-balancer) - `ai-unlimited-without-lb.yaml`—No load balancer. If you're unsure about which template to use, we recommend this one. @@ -82,8 +81,7 @@ We recommend selecting the region closest to your primary work location. |IamPermissionsBoundary | The ARN of the IAM permissions boundary to associate with the IAM role assigned to the instance. |Optional
Default: NA | |AvailabilityZone | The availability zone to which you want to deploy the instance. |Required
Default: NA
The value must match the subnet, the zone of any pre-existing volumes, and the instance type must be available in the selected zone. | |LoadBalancerScheme |If a load balancer is used, this field specifies whether the instance is accessible from the Internet or only from within the VPC. |Optional with default
Default: Internet-facing
The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.
The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the personal IP addresses of the nodes. Therefore, internal load balancers can route requests from clients with access to the VPC for the load balancer.| -|LoadBalancerSubnetOne | The subnet where the load balancer is hosted. The subnet determines load balancer availability zones, IP addresses, and endpoints. |Optional with default
Default: NA
You must define a minimum of one available subnet to create a Network Load Balancer (NLB) and two subnets for an Application Load Balancer (ALB).| -| LoadBalancerSubnetTwo| The subnet where the load balancer is hosted. |Optional. This option is only available in the template with ALB.
Default: NA
|This subnet must be in a different availability zone than the first subnet you chose.| +|LoadBalancerSubnet | The subnet where the load balancer is hosted. The subnet determines load balancer availability zones, IP addresses, and endpoints. |Optional with default
Default: NA
You must define one available subnet to create a Network Load Balancer (NLB).| |HostedZoneID | The ID that Amazon Route 53 assigned to the hosted zone when you created it.|Optional
Default: NA
Each hosted zone corresponds to a domain name, or possibly a subdomain. The hosted zone is the container for DNS records, where you configure how the world interacts with your domain, such as pointing it to an IP address with a record.
On the AWS console, go to **Route 53** > **Hosted zones**. Find your registered domain name and the corresponding Hosted zone ID.| |DnsName| The name of the domain. For public hosted zones, this is the name you registered with your DNS registrar. |Optional
Default: NA
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see [Create Hosted Zone](https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html).| |Private |Specifies whether the service is deployed in a private network without public IPs.|Required
Default: false
Make sure you select the `Enable auto-assign public IPv4 address` option in the subnet where the manager resides. If this option is not selected, the installation may fail.| @@ -166,7 +164,7 @@ If the container, pod, or node crashes or terminates, and the manager's configur ## Review and create the stack 1. Review the template settings. -2. Select the check box to acknowledge that the template will create IAM resources. +2. Select the checkbox to acknowledge that the template will create IAM resources. 3. Select **Submit** to deploy the stack.
On the **Events** tab, you can monitor progress. When the status of all the resources is `CREATE_COMPLETE`, the manager is ready. @@ -177,7 +175,7 @@ You'll need the URL to access the manager and set up AI Unlimited. ## What's next -[Create an OAuth app](../resources/create-oauth-app.md) to allow authentication between AI Unlimited and your Git provider account. +[Create an OAuth app](./create-oauth-app.md) to allow authentication between AI Unlimited and your Git provider account. diff --git a/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md b/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md index bda24b9bab..080f01eefb 100644 --- a/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md +++ b/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md @@ -34,11 +34,10 @@ ARM templates for the manager are here in the AI Unlimited GitHub repository: `deployments/azure/templates/arm/ai-unlimited` -Choose a template based on whether you intend to use a [load balancer](../glossary.md#load-balancer) and what type. +Choose a template based on whether you intend to use a [load balancer](../glossary.md#load-balancer). :::note You might want to ask a cloud admin at your organization for guidance. ::: - - `ai-unlimited-with-alb.json`—Hosts the manager behind an [application load balancer](../glossary.md#application-load-balancer) - `ai-unlimited-with-nlb.json`—Hosts the manager behind a [network load balancer](../glossary.md#network-load-balancer) - `ai-unlimited-without-lb.json`—No load balancer. If you're unsure about which template to use, we recommend this one. @@ -135,4 +134,4 @@ You'll need the URL to access the manager and set up AI Unlimited. ## What's next -[Create an OAuth app](../resources/create-oauth-app.md) to allow authentication between AI Unlimited and your Git provider account. +[Create an OAuth app](./create-oauth-app.md) to allow authentication between AI Unlimited and your Git provider account. diff --git a/docs/install-ai-unlimited/setup-ai-unlimited.md b/docs/install-ai-unlimited/setup-ai-unlimited.md index 16e99f347a..4833bf5fb6 100644 --- a/docs/install-ai-unlimited/setup-ai-unlimited.md +++ b/docs/install-ai-unlimited/setup-ai-unlimited.md @@ -3,7 +3,7 @@ id: setup-ai-unlimited title: Set up AI Unlimited description: Learn about the setup details. sidebar_label: Set up AI Unlimited -sidebar_position: 3 +sidebar_position: 4 pagination_prev: null pagination_next: null --- @@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem'; After you install the [manager](../glossary.md#ai-unlimited-manager), access the AI Unlimited setup using the URL you received at the end of the installation process: `http://[ip_or_hostname]:[port]`. :::note -By setting up AI Unlimited, you become the AI Unlimited admin at your organization. +By setting up AI Unlimited, you become the AI Unlimited owner at your organization. ::: :::tip @@ -24,192 +24,149 @@ For setup help, email the supp ::: -## Complete the fields +## Complete steps 1-3 in the manager -Find information about each group of fields here. +Find additional information here.
-Basic setup +Step 1: Git integration -
+**OAuth app** -**AI Unlimited base URL**—The URL you used to access the setup. You received it when you installed the manager. +An OAuth app allows a user to grant access to their account on one website or service to their account on another, without sharing their password. +AI Unlimited uses your [OAuth app](./create-oauth-app.md) to authorize access to your GitLab or GitHub account. This allows AI Unlimited to store user and project information there. -**Git provider**—GitHub or GitLab. +GitLab or GitHub uses the authorization callback URL, after authenticating a user, to redirect back to the manager. -**AI Unlimited log level**—The level of detail to see in AI Unlimited logs. - -**Engine IP network type** - -Select **Private** if you deploy the engine in the same Virtual Private Cloud as AI Unlimited. - -**Public** or **Private** refers to how AI Unlimited should communicate with the engine. The engine might have a public IP address, a private IP address, or both. Indicate the type of IP address to which AI Unlimited should connect. - -**Use TLS** - -We recommend that you use [Transport Layer Security (TLS)](../glossary.md#transport-layer-security) to secure connections to AI Unlimited and safeguard your data in transit. - -- If you are using an [application load balancer (ALB)](../glossary.md#application-load-balancer), with certification termination enabled, select **False**. - -- If you are using a [network load balancer (NLB)](../glossary.md#network-load-balancer) or no load balancer, select **True.** -.. - - **AI Unlimited TLS certificate** and **AI Unlimited TLS certificate key**—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. - - - Or select **Generate Certs** to use a Teradata system-generated certificate. It automatically renews before it expires. - -Select **Update**. - -
+Selecting **Authenticate**, and signing in, establishes this access and returns you to the setup. +:::warning +To allow the authentication window to appear, make sure that in your browser settings popups are enabled for the manager site. +::: -
+ + -Cloud integration -
-Some of these fields are for default values. Later, when you deploy the engine from a Jupyter notebook, you can specify values, different from the defaults, for that deployment. +**Group access** - - -
-**Default region**—The AWS region in which to deploy the engine. We recommend choosing the region closest to your data lake. +Two groups in your GitLab account can help with access control and project repository management. -**Default subnet**—The [AWS subnet](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) to which to deploy the engine. The AWS console shows the subnets in the region. +Members of the **Authorizing group** can sign in to the AI Unlimited manager with their GitLab credentials and authenticate themselves. If you leave this field blank, only you, the admin user, can sign in and authenticate yourself. No other user will be able to sign in to the manager. -**Default IAM role** +The **Repository group** is the group in which all AI Unlimited project repositories are stored. If you leave this field blank, projects are stored in your personal GitLab space. -- The [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) for the engine. Leave blank to let AI Unlimited create the role—if your security allows this. Otherwise, create a role using this policy: [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json). -- If AI Unlimited creates the role, it creates it for the AWS [cluster](../glossary.md#cluster) that deploys the engine—each time you deploy the engine. If your organization creates the role, it must accommodate any cluster that might deploy the engine. - -**Resource tags**—You can [tag](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html) the AWS resources that deploy the engine to make them easier to manage. + -**Inbound security** + -Use these fields to allow source traffic to reach the engine: -- **Default [CIDRs](../glossary.md#classless-inter-domain-routing)** -- **Default [security group](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-security-groups.html) IDs**—If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited security group in this field to ensure that AI Unlimited can communicate with the engine. -- **Default [prefix list](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) names** +**Organization access** -**Role prefix**—If AI Unlimited creates the role, this prefix is added to the role name. +Two organizations in your GitHub account can help with access control and project repository management. -**[Permissions boundary](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) ARN**—If your IAM entities require a boundary, you can provide one here. +Members of the **Authorizing organization** can sign in to the AI Unlimited manager with their GitHub credentials and authenticate themselves. If you leave this field blank, only you, the admin user, can sign in and authenticate yourself. No other user will be able to sign in to the manager. -Select **Update**. +The **Repository organization** is the organization in which all AI Unlimited project repositories are stored. If you leave this field blank, projects are stored in your personal GitHub space. + - - -
+
-**Default region**—The Azure region in which to deploy the engine. We recommend choosing the region closest to your data lake. -Learn more about [Azure virtual networks](https://learn.microsoft.com/en-us/azure/virtual-network/concepts-and-best-practices). +
+Step 2: Cloud setup -**Default network resource group**—The resource group that contains the network. +Some of these fields are for default values. Later, when you deploy the engine from a Jupyter notebook, you can specify values, different from the defaults, for that deployment. -**Default network**—The network to which to deploy the engine. + + -**Default subnet**—The subnet to which to deploy the engine. +**IAM role** -**Default key vault**—The key vault, used by the engine, in which sensitive information such as passwords can be securely stored. +If AI Unlimited creates the IAM role for the engine, it creates it for the AWS [cluster](../glossary.md#cluster) that deploys the engine—each time you deploy the engine. If [your organization creates the role](../resources/aws-requirements.md#provide-roles-created-by-your-organization) for the engine, it must be broad enough to include all the clusters that might deploy the engine. -**Default key vault resource group**—The resource group that contains the key vault. +**Inbound security: Security group names** -**Inbound security** +If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited security group to ensure that AI Unlimited can communicate with the engine. -Use these fields to allow source traffic to reach the engine: + -- **Default [CIDRs](../glossary.md#classless-inter-domain-routing)** - -- **Default [security group](https://learn.microsoft.com/en-us/azure/virtual-network/application-security-groups) names**— If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited application security group in this field to ensure that AI Unlimited can communicate with the engine. + -**Resource tags**—You can [tag](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources) the Azure resources that deploy the engine to make them easier to manage. +**Inbound security: Application security group names** -Select **Update**. +If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited application security group to ensure that AI Unlimited can communicate with the engine. +**Network type: Public** or **Private** + +This refers to how AI Unlimited should communicate with the engine. The engine might have a public IP address, a private IP address, or both. Indicate the type of IP address to which AI Unlimited should connect. +
-Git integration +Step 3: Application settings - +**TLS** - +Use [Transport Layer Security (TLS)](../glossary.md#transport-layer-security) to secure connections to the AI Unlimited service and safeguard your data in transit. -
+**Certificates** -**GitHub callback URL**—After authenticating a user, GitHub uses this URL to redirect to the manager. This was provided to the OAuth app [when it was created](../resources/create-oauth-app.md). +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. -**GitHub base URL**—The URL for your GitHub instance. +Or use a Teradata system-generated certificate. It automatically renews before it expires. -**GitHub client ID** and **GitHub client secret**—The credentials received from GitHub when your [OAuth app was created](../resources/create-oauth-app.md). +
-**Organization access** -Two organizations in your GitHub account can help with access control and repository management: +## Before you leave -- Members of the **Authorizing organization** are able to sign in and authenticate themselves in AI Unlimited. If you don't specify an organization, any GitHub account user can sign in and authenticate. +1. On your **Profile**, copy your API key. + You'll use it when you connect to the engine from a Jupyter notebook. -- Project repositories are created in the **Repository organization**. If you don't specify an organization, projects will be in your personal GitHub space. +2. If you enabled TLS, you'll see a restart message. Select **Restart now**. This restarts the AI Unlimited service with TLS in place. -Select **Update**. +:::note +If you return to the setup and change any TLS setting (enable TLS, disable TLS, or change the certificate), you'll need to restart AI Unlimited again. +::: -Select **Sign In**. Then, sign in (if prompted), and authenticate yourself. +Congratulations! AI Unlimited setup is now complete. - - +:::note +Because you are the AI Unlimited owner you can return to the setup anytime to [change any settings](../manage-ai-unlimited/change-settings.md). +::: -
-**GitLab callback URL**—After authenticating a user, GitLab uses this URL to redirect to the manager. This was provided to the OAuth app [when it was created](../resources/create-oauth-app.md). +## What's next -**GitLab base URL**—The URL for your GitLab instance. +In a Jupyter notebook, start [exploring and analyzing data](../explore-and-analyze-data/index.md). -**GitLab client ID** and **GitLab client secret**—The credentials received from GitLab when your [OAuth app was created](../resources/create-oauth-app.md). -**Group access** -Two groups in your GitLab account can help with access control and repository management: -- Members of the **Authorizing group** are able to sign in and authenticate themselves in AI Unlimited. If you don't specify a group, any GitLab account user can sign in and authenticate. -- All project repositories are created in the **Repository group**. If you don't specify a group, projects will be in your personal GitLab space. -Select **Update**. -Select **Sign In**. Then, sign in (if prompted), and authenticate yourself. - - - -## Before you leave -1. On your **Profile**, copy your API key. - You'll use it when you connect to the engine from a Jupyter notebook. -2. If you enabled TLS, select **Restart**. This restarts the AI Unlimited service with TLS in place. + -Congratulations! AI Unlimited setup is now complete. -:::note -Because you are the AI Unlimited admin, you can return to the setup anytime to [change any settings](../manage-ai-unlimited/change-settings.md). -::: -## What's next -In a Jupyter notebook, start [exploring and analyzing data](../explore-and-analyze-data/index.md). diff --git a/docs/manage-ai-unlimited/add-collaborators.md b/docs/manage-ai-unlimited/add-collaborators.md index bba9f2b42b..2d0eb753f3 100644 --- a/docs/manage-ai-unlimited/add-collaborators.md +++ b/docs/manage-ai-unlimited/add-collaborators.md @@ -3,7 +3,7 @@ id: add-collaborators title: Add collaborators description: Learn how to add collaborators to a project. sidebar_label: Add project collaborators -sidebar_position: 1 +sidebar_position: 2 pagination_prev: null pagination_next: null --- @@ -17,15 +17,16 @@ The steps depend on whether you do this before or after the engine is deployed. ## Before the engine is deployed -1. In GitHub or GitLab, add users to the project repository.
-See details about adding repo users for [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository) or [GitLab](https://docs.gitlab.com/ee/user/project/members/#add-users-to-a-project). +1. In GitLab or GitHub, add users to the project repository.
+See details about adding repo users for [GitLab](https://docs.gitlab.com/ee/user/project/members/#add-users-to-a-project) or [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository). 2. When you deploy the engine from your Jupyter notebook, the users are added to the engine automatically. ## After the engine is deployed -1. In GitHub or GitLab, add users to the project repository.
-See details about adding repo users for [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository) or [GitLab](https://docs.gitlab.com/ee/user/project/members/#add-users-to-a-project). +1. In GitLab or GitHub, add users to the project repository.
+See details about adding repo users for [GitLab](https://docs.gitlab.com/ee/user/project/members/#add-users-to-a-project) or [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository). + 2. In your Jupyter notebook, run the magic command `%project_engine_update_users` to add the users to the engine. diff --git a/docs/manage-ai-unlimited/change-settings.md b/docs/manage-ai-unlimited/change-settings.md index 8760bb19fa..61bb5e8942 100644 --- a/docs/manage-ai-unlimited/change-settings.md +++ b/docs/manage-ai-unlimited/change-settings.md @@ -1,16 +1,16 @@ --- id: change-settings -title: Change settings (admin) -description: Learn how to change AI Unlimited settings. -sidebar_label: Change settings (admin) +title: Change AI Unlimited settings (owner) +description: Learn how to change AI Unlimited settings in the manager. +sidebar_label: Change AI Unlimited settings (owner) sidebar_position: 4 pagination_prev: null pagination_next: null --- -# Change settings (admin) +# Change AI Unlimited settings (owner) -If you are the AI Unlimited admin, you can return to the AI Unlimited setup in the manager and change any basic, cloud integration, or Git integration setting. +If you are the AI Unlimited owner, you can return to the setup in the manager and change any Git, cloud, or application setting. 1. Access the setup using the same URL you used to access it originally. @@ -18,11 +18,10 @@ If you are the AI Unlimited admin, you can return to the AI Unlimited setup in t You received the URL when you installed the manager. ::: -2. Sign in to GitHub or GitLab. -3. After being routed back to the manager, select **Setup**. -3. In any section, make changes, then select **Update**.
-[Learn about the fields](../install-ai-unlimited/setup-ai-unlimited.md). -4. Sign in to authenticate yourself. -6. If you enabled TLS, on your **Profile**, select **Restart**.
- AI Unlimited restarts with TLS in place. +2. Sign in to GitLab or GitHub. +3. After being routed back to the manager, select **Settings**. +4. In any of the 3 steps, make changes, then select **Next**.
+[Learn more about the fields](../install-ai-unlimited/setup-ai-unlimited.md). +5. If you changed TLS settings (enabled TLS, disabled TLS, changed the certificate, etc.), a restart message appears. Restart AI Unlimited.
+ AI Unlimited restarts with your TLS changes in place. diff --git a/docs/manage-ai-unlimited/get-project-information.md b/docs/manage-ai-unlimited/get-project-information.md new file mode 100644 index 0000000000..f48cffd61e --- /dev/null +++ b/docs/manage-ai-unlimited/get-project-information.md @@ -0,0 +1,25 @@ +--- +id: get-project-information +title: Get project information +description: Find out how to see a project's status, access its repository, and get its IP address. +sidebar_label: Get project information +sidebar_position: 1 +pagination_prev: null +pagination_next: null +--- + +# Get project information + +In the manager, you can see the status of projects, access their Git repositories, and copy a project's IP address (if you ever need it for troubleshooting). + +If you are the AI Unlimited owner (meaning, you [set up AI Unlimited](../install-ai-unlimited/setup-ai-unlimited.md)), you see all projects and you can delete any of them. Otherwise, you see and can delete only the projects that you yourself create. + +1. Access the manager. + +:::note +Get the URL from the AI Unlimited owner at your organization. The owner received the URL after installing the manager. +::: + +2. Sign in to GitLab or GitHub. +3. After being routed back to the manager, select **Projects**. + diff --git a/docs/manage-ai-unlimited/index.md b/docs/manage-ai-unlimited/index.md index ca6e102885..d81ab247d1 100644 --- a/docs/manage-ai-unlimited/index.md +++ b/docs/manage-ai-unlimited/index.md @@ -28,9 +28,9 @@ A user who creates a project is the project's owner. - [Add collaborators](./add-collaborators.md) -## Admin +## AI Unlimited owner -The user who [set up AI Unlimited](../install-ai-unlimited/setup-ai-unlimited.md) is the admin. +The user who [set up AI Unlimited](../install-ai-unlimited/setup-ai-unlimited.md) is the AI Unlimited owner - [Change settings](./change-settings.md) diff --git a/docs/manage-ai-unlimited/suspend-and-restore-project.md b/docs/manage-ai-unlimited/suspend-and-restore-project.md index bc98f72070..fbea602056 100644 --- a/docs/manage-ai-unlimited/suspend-and-restore-project.md +++ b/docs/manage-ai-unlimited/suspend-and-restore-project.md @@ -2,7 +2,7 @@ id: suspend-and-restore-project title: Suspend and restore a project description: How to suspend and restore projects to manage costs. -sidebar_position: 2 +sidebar_position: 3 sidebar_label: Suspend and restore a project pagination_prev: null pagination_next: null diff --git a/docs/manage-ai-unlimited/view-ai-unlimited-logs.md b/docs/manage-ai-unlimited/view-ai-unlimited-logs.md new file mode 100644 index 0000000000..3e6fc6b796 --- /dev/null +++ b/docs/manage-ai-unlimited/view-ai-unlimited-logs.md @@ -0,0 +1,26 @@ +--- +id: view-logs +title: View AI Unlimited logs +description: Learn how to access log entries for the AI Unlimited service. +sidebar_label: View AI Unlimited logs +sidebar_position: 5 +pagination_prev: null +pagination_next: null +--- + +# View AI Unlimited logs + +In the manager, you can view log entries to see how AI Unlimited is working. Use the logged events, actions, and problems to help with troubleshooting. + +1. Access the manager. + +:::note +Get the URL from the AI Unlimited owner at your organization. The admin received the URL after installing the manager. +::: + +2. Sign in to GitLab or GitHub. +3. After being routed back to the manager, select **Logs**. +4. Optionally, select **Download logs**. + + + diff --git a/docs/resources/aws-requirements.md b/docs/resources/aws-requirements.md index 3714772849..beabfa86e7 100644 --- a/docs/resources/aws-requirements.md +++ b/docs/resources/aws-requirements.md @@ -23,7 +23,7 @@ Then before you install AI Unlimited, address these AWS items. - Use a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) to securely connect using Secure Shell (SSH). You will need the key pair when you [specify the stack details](../install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#specify-stack-details-and-options). - Use AWS Session Manager to connect. To enable this, attach the [session-manager.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/session-manager.json) policy to a [role you provide](#provide-roles-created-by-your-organization) to the manager. -- If you plan to use an [Application Load Balancer (ALB)](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancer-getting-started.html) or [Network Load Balancer (NLB)](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-getting-started.html), make sure you have permission to manage these AWS services: +- If you plan to use a [Network Load Balancer (NLB)](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-getting-started.html), make sure you have permission to manage these AWS services: - [AWS Certificate Manager](https://docs.aws.amazon.com/acm/)—to issue a new certificate for the hosted zone ID in Route 53. - [AWS Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html)—to configure a custom domain name and route DNS queries to your load balancer. diff --git a/docs/resources/index.md b/docs/resources/index.md index 0b1a4b7c6d..9a5622f9e9 100644 --- a/docs/resources/index.md +++ b/docs/resources/index.md @@ -16,7 +16,6 @@ Find resources here for installation-related topics: - [AWS account requirements](./aws-requirements.md) - [Azure account requirements](./azure-requirements.md) - - [Create an OAuth app](./create-oauth-app.md) - The ways to [install JupyterLab](./jupyterlab/) diff --git a/docs/resources/jupyterlab/install-jupyterlab-aws.md b/docs/resources/jupyterlab/install-jupyterlab-aws.md index 0ee4b0db26..a726db210f 100644 --- a/docs/resources/jupyterlab/install-jupyterlab-aws.md +++ b/docs/resources/jupyterlab/install-jupyterlab-aws.md @@ -24,7 +24,7 @@ For installation support, email the -Supported Teradata Vantage™ features -- Native Object Store (NOS) 20.00.17.08 -- Open Table Format (OTF) 20.00.17.07 - - Iceberg with AWS Glue, Hive, and Databricks Unity Catalog - - Delta Lake with Databricks Unity Catalog -- Bring Your Own Model 05.00.00.01 - - PMMLPredict - - H20Predict - +As we continue to enhance AI Unlimited, please be aware of features not currently supported and known issues. -
-Supported teradataml functions -- Antiselect -- Attribution -- BincodeFit -- BincodeTransform -- CategoricalSummary -- ChiSq -- ClassificationEvaluator -- ColumnSummary -- ColumnTransformer -- DecisionForest -- DecisionForestPredict -- FillRowId -- Fit -- FTest -- GetFutileColumns -- GetRowsWithMissingValues -- GetRowsWithoutMissingValues -- GLM -- GLMPredict -- Histogram -- KMeans -- KMeansPredict -- KNN -- MovingAverage -- NaiveBayesPredict -- NaiveBayesTextClassifierPredict -- NaiveBayesTextClassifierTrainer -- NGramSplitter -- NonLinearCombineFit -- NonLinearCombineTransform -- NPath -- NumApply -- OneHotEncodingFit -- OneHotEncodingTransform -- OrdinalEncodingFit -- OrdinalEncodingTransform -- OutlierFilterFit -- OutlierFilterTransform -- Pack -- PolynomialFeaturesFit -- PolynomialFeaturesTransform -- QQNorm -- RandomProjectionFit -- RandomProjectionMinComponents -- RandomProjectionTransform -- RegressionEvaluator -- ROC -- RoundColumns -- RowNormalizeFit -- RowNormalizeTransform -- ScaleFit -- ScaleTransform -- SentimentExtractor -- Sessionize -- Silhouette -- SimpleImputeFit -- SimpleImputeTransform -- StrApply -- StringSimilarity -- SVMSparsePredict -- TextParser -- Transform -- UnivariateStatistics -- Unpack -- VectorDistance -- WhichMax -- WhichMin -- ZTest -- delete_byom -- retrieve_byom -- list_byom -- save_byom -- get_license -- set_license -
- -:::note -See the [release notes](./release-notes.md) for known issues and features not currently supported. -::: - - -## What's coming - -- Support for Update and Delete with predicates for Open Table Format (OTF) queries - June - -- User Defined Functions (UDF) - - Fix for the first invocation of Java UDFs failing - future - - Support for API_Request UDF - future - -- Unbounded Array Framework (UAF) - - SQL supporting UAF - June - - teradataml supporting UAF - future - -- teradataml - - Fix for UAF functions failing if database name has special characters - June - - Fix for SQLE and UAF functions failing to run due to issues with volatile table creation - June - - automl and openml functions - June - - map_row and map_partition functions - future - -- Vantage Analytics Library (VAL) - future +- [August 2024](./august-2024-rn.md) +- [May 2024](./may-2024-rn.md) diff --git a/docs/whats-new/may-2024-fe.md b/docs/whats-new/may-2024-fe.md new file mode 100644 index 0000000000..0f202763e1 --- /dev/null +++ b/docs/whats-new/may-2024-fe.md @@ -0,0 +1,140 @@ +--- +id: may-2024-fe +title: May 2024 features +description: Find out what's in the initial release of AI Unlimited paid public preview. +sidebar_label: May 2024 features +sidebar_position: 3 +pagination_prev: null +pagination_next: null +--- + +# May 2024 | Features + +See what's in the initial release of the AI Unlimited paid public preview, and find out what's coming. + + +## What's new + +Everything you need to start exploring, analyzing, and experimenting: + +- AI/ML engine v0.14.3 with [ClearScape Analytics™](https://docs.teradata.com/access/sources/dita/topic?dita:mapPath=phg1621910019905.ditamap&dita:ditavalPath=pny1626732985837.ditaval&dita:topicPath=gma1702668333653.dita) functions +- Support for AWS and Azure +- [AI Unlimited Jupyter Kernel](https://downloads.teradata.com/download/tools/teradata-ai-unlimited-jupyter-kernel) + - Python Client Libraries + - teradataml 20.0.0.0 + - teradatamlwidgets 20.0.0.2 + - teradatasql 20.0.0.12 + - teradatasqlalchemy 20.0.0.2 + - tdapiclient 1.4.0.1 +- Support for GitHub and GitLab for project creation and database schema backup +- AI Unlimited manager v0.2.15 + +
+Supported Teradata Vantage™ features +- Native Object Store (NOS) 20.00.17.08 +- Open Table Format (OTF) 20.00.17.07 + - Iceberg with AWS Glue, Hive, and Databricks Unity Catalog + - Delta Lake with Databricks Unity Catalog +- Bring Your Own Model 05.00.00.01 + - PMMLPredict + - H20Predict +
+ +
+Supported teradataml functions +- Antiselect +- Attribution +- BincodeFit +- BincodeTransform +- CategoricalSummary +- ChiSq +- ClassificationEvaluator +- ColumnSummary +- ColumnTransformer +- DecisionForest +- DecisionForestPredict +- FillRowId +- Fit +- FTest +- GetFutileColumns +- GetRowsWithMissingValues +- GetRowsWithoutMissingValues +- GLM +- GLMPredict +- Histogram +- KMeans +- KMeansPredict +- KNN +- MovingAverage +- NaiveBayesPredict +- NaiveBayesTextClassifierPredict +- NaiveBayesTextClassifierTrainer +- NGramSplitter +- NonLinearCombineFit +- NonLinearCombineTransform +- NPath +- NumApply +- OneHotEncodingFit +- OneHotEncodingTransform +- OrdinalEncodingFit +- OrdinalEncodingTransform +- OutlierFilterFit +- OutlierFilterTransform +- Pack +- PolynomialFeaturesFit +- PolynomialFeaturesTransform +- QQNorm +- RandomProjectionFit +- RandomProjectionMinComponents +- RandomProjectionTransform +- RegressionEvaluator +- ROC +- RoundColumns +- RowNormalizeFit +- RowNormalizeTransform +- ScaleFit +- ScaleTransform +- SentimentExtractor +- Sessionize +- Silhouette +- SimpleImputeFit +- SimpleImputeTransform +- StrApply +- StringSimilarity +- SVMSparsePredict +- TextParser +- Transform +- UnivariateStatistics +- Unpack +- VectorDistance +- WhichMax +- WhichMin +- ZTest +- delete_byom +- retrieve_byom +- list_byom +- save_byom +- get_license +- set_license +
+ +## What's coming + +- Support for Update and Delete with predicates for Open Table Format (OTF) queries - August + +- User Defined Functions (UDF) + - Fix for the first invocation of Java UDFs failing - future + - Support for API_Request UDF - future + +- Unbounded Array Framework (UAF) + - SQL supporting UAF - August + - teradataml supporting UAF - future + +- teradataml + - Fix for UAF functions failing if database name has special characters - August + - Fix for SQLE and UAF functions failing to run due to issues with volatile table creation - August + - automl and openml functions - August + - map_row and map_partition functions - future + +- Vantage Analytics Library (VAL) - future + diff --git a/docs/whats-new/release-notes.md b/docs/whats-new/may-2024-rn.md similarity index 77% rename from docs/whats-new/release-notes.md rename to docs/whats-new/may-2024-rn.md index bd810d9466..3c6e89f89a 100644 --- a/docs/whats-new/release-notes.md +++ b/docs/whats-new/may-2024-rn.md @@ -1,21 +1,16 @@ --- -id: release-notes -title: Release notes -description: See details about the paid public preview's initial launch. -sidebar_label: Release notes -sidebar_position: 8 +id: may-2024-rn +title: May 2024 release notes +description: See details about the initial release of the paid public preview. +sidebar_label: May 2024 release notes +sidebar_position: 4 pagination_prev: null pagination_next: null --- -# Release notes +# May 2024 | Release notes -As we continue to enhance AI Unlimited, please be aware of features not currently supported and known issues. - -For the latest features and updates, keep an eye on [What's new](./index.md). - - -## Paid public preview (launch) - May 2024 +See what's not currently supported and learn about known issues. ### Not supported