Skip to content

Commit

Permalink
feat(content): update for august release
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH authored and owilliams320 committed Aug 28, 2024
1 parent f85b4be commit f0c8e7e
Show file tree
Hide file tree
Showing 25 changed files with 378 additions and 312 deletions.
18 changes: 7 additions & 11 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand All @@ -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.
Expand All @@ -29,7 +29,7 @@ Email the <a href="mailto:[email protected]">support team</a>. 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.
Expand All @@ -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.

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/explore-and-analyze-data/create-first-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
6 changes: 3 additions & 3 deletions docs/explore-and-analyze-data/get-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 4 additions & 8 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand All @@ -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

Expand Down Expand Up @@ -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).
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/install-ai-unlimited/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`&mdash;Hosts the manager behind an [application load balancer](../glossary.md#application-load-balancer)
- `ai-unlimited-with-nlb.yaml`&mdash;Hosts the manager behind a [network load balancer](../glossary.md#network-load-balancer)
- `ai-unlimited-without-lb.yaml`&mdash;No load balancer. If you're unsure about which template to use, we recommend this one.

Expand Down Expand Up @@ -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<br/>Default: NA |
|AvailabilityZone | The availability zone to which you want to deploy the instance. |Required<br/>Default: NA<br/>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<br/>Default: Internet-facing<br/>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.<br/>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<br/>Default: NA<br/>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.<br/>Default: NA<br/>|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<br/>Default: NA<br/>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<br/>Default: NA<br/>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.<br/>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<br/>Default: NA<br/>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<br/>Default: false <br/>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.|
Expand Down Expand Up @@ -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.<br />
On the **Events** tab, you can monitor progress. When the status of all the resources is `CREATE_COMPLETE`, the manager is ready.

Expand All @@ -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.



5 changes: 2 additions & 3 deletions docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`&mdash;Hosts the manager behind an [application load balancer](../glossary.md#application-load-balancer)
- `ai-unlimited-with-nlb.json`&mdash;Hosts the manager behind a [network load balancer](../glossary.md#network-load-balancer)
- `ai-unlimited-without-lb.json`&mdash;No load balancer. If you're unsure about which template to use, we recommend this one.

Expand Down Expand Up @@ -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.
Loading

0 comments on commit f0c8e7e

Please sign in to comment.