Skip to content

Commit

Permalink
misc based on feedback in the review PDFs
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed May 16, 2024
1 parent 27fa6f6 commit ea6e21f
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 16 deletions.
3 changes: 2 additions & 1 deletion docs/explore-and-analyze-data/create-first-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,12 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command
1. Configure the connection to the engine.
```bash
%workspaces_config host=<ip_or_hostname>, apikey=<API_Key>, withtls=T

```

2. Create a new project.
```bash
%project_create project=<Project_Name>, env=<Cloud_Service_Provider>, team=<Project_Team>
%project_create project=<Project_Name>, env=<Cloud_Service_Provider>
```

3. Create an object store authorization to store the cloud service provider credentials.
Expand Down
8 changes: 8 additions & 0 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ An OAuth app allows a user to grant access to their account on one website or se
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](#glo-data-lake).


## P

<a id="glo-project"></a>
### project

Definition.


## S

<a id="glo-systemd"></a>
Expand Down
3 changes: 2 additions & 1 deletion docs/install-ai-unlimited/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ With AI Unlimited, data scientists and data engineers can explore and analyze la

## How it works

You connect your notebook to the AI/ML engine on [AWS](https://aws.amazon.com/) or [Azure](https://azure.microsoft.com/en-us), and connect the engine to your [Amazon S3](https://aws.amazon.com/pm/serv-s3/?gclid=Cj0KCQjwlZixBhCoARIsAIC745AmyEzPaBnrARQxyUW_un0BjgTxlHygMScf4ZbX-7dTeznc-psOFlwaAkjmEALw_wcB&trk=fecf68c9-3874-4ae2-a7ed-72b6d19c8034&sc_channel=ps&ef_id=Cj0KCQjwlZixBhCoARIsAIC745AmyEzPaBnrARQxyUW_un0BjgTxlHygMScf4ZbX-7dTeznc-psOFlwaAkjmEALw_wcB:G:s&s_kwcid=AL!4422!3!536452728638!e!!g!!amazon%20s3!11204620052!112938567994) or [ADLS Gen2](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction) data lake. You can suspend and restore your analytics project anytime, and pay only for the hours you use.
You connect your notebook to the AI/ML engine on [AWS](https://aws.amazon.com/) or [Azure](https://azure.microsoft.com/en-us), and connect the engine to your [Amazon S3](https://aws.amazon.com/pm/serv-s3/?gclid=Cj0KCQjwlZixBhCoARIsAIC745AmyEzPaBnrARQxyUW_un0BjgTxlHygMScf4ZbX-7dTeznc-psOFlwaAkjmEALw_wcB&trk=fecf68c9-3874-4ae2-a7ed-72b6d19c8034&sc_channel=ps&ef_id=Cj0KCQjwlZixBhCoARIsAIC745AmyEzPaBnrARQxyUW_un0BjgTxlHygMScf4ZbX-7dTeznc-psOFlwaAkjmEALw_wcB:G:s&s_kwcid=AL!4422!3!536452728638!e!!g!!amazon%20s3!11204620052!112938567994) or [ADLS Gen2](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction) data lake. You can suspend and restore your analytics [project](/docs/glossary.md#glo-project) anytime, and pay only for the hours you use.

:::note
If AI Unlimited has already been installed and set up by someone at your organization, you can go straight to [Explore and Analyze Data](/docs/explore-and-analyze-data) to get started.
Expand All @@ -31,6 +31,7 @@ If AI Unlimited has already been installed and set up by someone at your organiz
- The [AI Unlimited Jupyter Kernel](https://downloads.teradata.com/download/tools/teradata-ai-unlimited-jupyter-kernel) for managing projects in notebooks


<a id="gs-prerequisites"></a>
## Prerequisites

- A pay-as-you-go AWS or Azure account on which to provision compute resources. See the requirements for your [AWS](/docs/resources/aws-requirements.md) or [Azure](/docs/resources/azure-requirements.md) account.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pagination_next: null

# Install the manager on AWS

Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/#gs-prerequisties).
Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/index.md#gs-prerequisites).

The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for monitoring projects. And the manager is where you'll set up AI Unlimited.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,4 @@ You'll need the URL to access the manager and set up AI Unlimited.

## What's next

[Create an OAuth app](/docs/resources/create-oauth-app) to allow authorization between AI Unlimited and your Git provider account..
[Create an OAuth app](/docs/resources/create-oauth-app) to allow authorization between AI Unlimited and your Git provider account.
20 changes: 8 additions & 12 deletions docs/install-ai-unlimited/setup-ai-unlimited.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Some of these fields are for default values. Later, when you deploy the engine f

**Default IAM role**

- The [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) for the AWS resources that deploy the engine. Leave blank to let AI Unlimited create the role&mdash;if your security allows this. Otherwise, create an IAM role using this policy: [ai-unlimited-workspaces.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-workspaces.json).
- 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&mdash;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](/docs/glossary.md#glo-cluster) that deploys the engine&mdash;each time you deploy the engine. If your organization creates the role, it must accommodate any cluster that might deploy the engine.

**Resource tags**&mdash;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.
Expand All @@ -91,7 +91,7 @@ Some of these fields are for default values. Later, when you deploy the engine f

Use these fields to allow source traffic to reach the engine:
- **Default [CIDRs](/docs/glossary.md#glo-cidr)**
- **Default [security group](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-security-groups.html) names**&mdash;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 [security group](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-security-groups.html) IDs**&mdash;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**

**Role prefix**&mdash;If AI Unlimited creates the role, this prefix is added to the role name.
Expand Down Expand Up @@ -148,15 +148,13 @@ Select **Update**.

<br />

**GitHub application URL**&mdash;The manager uses this URL to connect to your GitHub account to authenticate a user.
**GitHub callback URL**&mdash;After authenticating a user, GitHub uses this URL to redirect back to the manager. This was provided to the OAuth app [when it was created](docs/resources/create-oauth-app.md).

**GitHub callback URL**&mdash;After authenticating a user, GitHub uses this URL to redirect back to the manager. This is the same callback URL that was provided for the [creation of the OAuth app](docs/resources/create-oauth-app.md).

**GitHub base URL**&mdash;The URL for your GitHub account.
**GitHub base URL**&mdash;The URL for your GitHub instance. **(this field might be removed)**

**GitHub client ID** and **GitHub client secret**&mdash;The credentials received from GitHub when your [OAuth app was created](/docs/resources/create-oauth-app.md).

**GitHub login**&mdash;**(this field might be removed)**
**GitHub login**&mdash;**(this field will probably be removed)**

**Organization access**

Expand All @@ -177,15 +175,13 @@ Select **Login**. Then, if prompted, sign in.

<br />

**GitLab application URL**&mdash;The manager uses this URL to connect to your GitLab account to authenticate a user.

**GitLab callback URL**&mdash;After authenticating a user, GitLab uses this URL to redirect back to the manager. This is the same callback URL that was provided for the [creation of the OAuth app](docs/resources/create-oauth-app.md).
**GitLab callback URL**&mdash;After authenticating a user, GitLab uses this URL to redirect back to the manager. This was provided to the OAuth app [when it was created](docs/resources/create-oauth-app.md).

**GitLab base URL**&mdash;The URL for your GitLab account.
**GitLab base URL**&mdash;The URL for your GitLab instance. **(this field might be removed)**

**GitLab client ID** and **GitLab client secret**&mdash;The credentials received from GitLab when your [OAuth app was created](/docs/resources/create-oauth-app.md).

**GitLab login** **(verifying)**
**GitLab login** **(this field will probably be removed)**

**Group access**

Expand Down

0 comments on commit ea6e21f

Please sign in to comment.