Skip to content

Commit

Permalink
more magic command work & prep for review part 2
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed May 14, 2024
1 parent 378b0ee commit 71fc76e
Show file tree
Hide file tree
Showing 20 changed files with 118 additions and 104 deletions.
4 changes: 3 additions & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ You can have only one AI Unlimited admin.
Of course. Explain.

**What's my API key for?**

You use your API key to connect from a Jupyter notebook to the engine.

**How can I access another user's project?**
Expand All @@ -55,3 +54,6 @@ Answer.
**And when I restore it?**
Answer.

**If I get errors or have any issues, what should I do?**
The [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa) is ready to help you. Go there to ask questions, get troubleshooting help, and share ideas.

15 changes: 6 additions & 9 deletions docs/explore-and-analyze-data/create-first-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ import TabItem from '@theme/TabItem';

# Create your first project

***this page is WIP***

You'll complete this simple workflow:
You'll complete this simple workflow from a Jupyter notebook:

- Deploy the engine
- Connect to your data
Expand All @@ -42,21 +40,20 @@ Your AI Unlimited admin is the person at your organization who set up AI Unlimit
</TabItem>
</Tabs>

- From your AI Unlimited user profile, get your API key:
- Access the manager using the URL your admin provided.
- Sign in, as you normally do, to GitHub or GitLab.
- On your user profile, copy your API key.
- From your AI Unlimited profile, [get your API key](/docs/explore-and-analyze-data/get-api-key.md).

- Connect to JupyterLab, open a notebook, and select the AI Unlimited kernel.

:::note
If you don't have JupyterLab or the AI Unlimited kernel, see [JupyterLab installation options](/docs/advanced/jupyterlab).
If you don't yet have JupyterLab or the AI Unlimited kernel, see [JupyterLab installation options](/docs/advanced/jupyterlab).
:::

## Connect, and run your first workload

:::tip
Run `%help` or `%help <command>` for details on all magic commands or any one of them. Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-commands.md) provided by the AI Unlimited kernel specifically.
Run `%help` for details on all magic commands. Run `%help <command>` for details on any one of them.

Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-commands.md) specific to AI Unlimited.
:::

1. Connect to the [AI Unlimited manager](/docs/glossary.md#glo-manager).
Expand Down
13 changes: 6 additions & 7 deletions docs/explore-and-analyze-data/get-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ pagination_next: null

# Get your API key

You'll need your API key to connect your Jupyter notebook to the engine.
To work on any project, you'll first need to have your API key. It connects your Jupyter notebook to the engine.

After you open a notebook and select the AI Unlimited kernel, you'll provide your API key to a [magic command](/docs/explore-and-analyze-data/magic-commands.md) that configures the connection.

1. Use the URL provided by your AI Unlimited admin to access your user profile.
1. Use the URL provided by your AI Unlimited admin to access the manager.
:::note
Your AI Unlimited admin is the person at your organization who set up AI Unlimited.
:::
2. Sign in, as you normally do, to GitHub or GitLab.
3. On your user profile, copy your API key.

2. Sign in to GitHub or GitLab.
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.

Your API key stays the same for the lifetime of the AI Unlimited installation.


2 changes: 1 addition & 1 deletion docs/explore-and-analyze-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you don't have JupyterLab or the AI Unlimited kernel, see [JupyterLab install
- Discover [ClearScape Analytics™](https://docs.teradata.com/access/sources/dita/topic?dita:mapPath=phg1621910019905.ditamap&dita:ditavalPath=pny1626732985837.ditaval&dita:topicPath=gma1702668333653.dita) functions

:::tip
To avoid paying for unneeded engine resources, remember to [suspend](/docs/manage-ai-unlimited/suspend-and-resume-project.md) projects you're not working on.
To avoid paying for unneeded engine resources, remember to [suspend](/docs/manage-ai-unlimited/suspend-and-restore-project.md) projects you're not working on.
:::

:::tip
Expand Down
42 changes: 23 additions & 19 deletions docs/explore-and-analyze-data/magic-commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: magic-commands
title: Magic commands
description: Learn about the AI Unlimited magic commands (**%magic_command**) asdf you can use in your project in your Jupyter notebook.
description: Learn about the AI Unlimited magic commands you can use in a Jupyter notebook to manage projects.
sidebar_label: Magic commands
sidebar_position: 5
pagination_prev: null
Expand All @@ -12,9 +12,9 @@ import TabItem from '@theme/TabItem';

# Magic commands

In Jupyter notebooks, magic commands are special shortcuts that starts with %. They let you do more than just run programming language.
In Jupyter notebooks, magic commands are shortcuts for common tasks. The AI Unlimited magic commands enable you to connect to the engine and manage projects.

JupyterLab with the AI Unlimited kernel supports these magic commands in addition to the standard Teradata SQL kernel magic commands.
The AI Unlimited Jupyter Kernel supports these magic commands in addition to the standard Teradata SQL kernel magic commands.

## %workspaces_config

Expand All @@ -32,7 +32,7 @@ Where:

- **`[Optional]`** withTLS: If False (F), the default client-server communication does not use TLS.

Output:
**Output**:
```
Workspace configured for host=<ip_or_hostname>
```
Expand Down Expand Up @@ -94,11 +94,11 @@ Use the project parameter to get the details of a specific project. All the proj
```
Where:

- project: Name of the project to be listed.
- project: The project name and URL for its repository.

**Output**:
```
Insert Code
Name of the project and its Git repository URL
```

## %project_auth_create
Expand Down Expand Up @@ -208,7 +208,7 @@ Where:

## %project_engine_deploy

**TA:The syntax doesn't list Subnet, region, and restore. What are the possible values for the restore param? Also, could you help with the Azure-Param: keyvaultresourcegroup and networkresourcegroup? Couldn't find much info in the Azure doc set.**
**(For Azure, we're still working on the parameters keyvaultresourcegroup and networkresourcegroup.**

**Description**: Deploy an engine for the project. The deployment process takes a few minutes to complete. On successful deployment, a password is generated.

Expand All @@ -231,7 +231,7 @@ Where:

Where:

- project: Name of the project.
- project: Name of the project.

- size: Size of the engine. The value can be:

Expand All @@ -242,14 +242,16 @@ Where:

- **`[Optional]`** node: Number of engine nodes to be deployed. The default value is 1.

- **`[Optional]`** subnet: Subnet used for the engine if there are no default values from the service.
- **`[Optional]`** subnet: Subnet used for the engine if there are no default values from the AI Unlimited setup.

- **`[Optional]`** region: Region used for the engine if there are no default values from service.
- **`[Optional]`** region: Region used for the engine if there are no default values from the AI Unlimited setup.

- **`[Optional]`** restore: If False (F), the engine is deployed but the project's objects are not restored, which reduces deployment time. You can manually restore them using %project_restore. The default value is True (T).

<Tabs>
<TabItem value="aws1" label="AWS">

- **`[Optional]`** prefixlist: The collection of CIDR blocks that define a set of IP address ranges that require the same policy enforcement. It is used to specify which IP addresses can communicate with an engine.
- **`[Optional]`** prefixlist: The collection of CIDR blocks that define a set of IP address ranges that require the same policy enforcement. It is used to specify which IP addresses can communicate with the engine.

- **`[Optional]`** securitygroups: List of security groups 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.

Expand All @@ -270,9 +272,9 @@ Where:

- **`[Optional]`** keyvault: The key vault used by the engine where sensitive information such as passwords can be securely stored.

- **`[Optional]`** keyvaultresourcegroup:
- **`[Optional]`** keyvaultresourcegroup: The resource group that contains the key vault.

- **`[Optional]`** networkresourcegroup:
- **`[Optional]`** networkresourcegroup: The resource group that contains the network.

</TabItem>
</Tabs>
Expand All @@ -283,6 +285,7 @@ Started deploying.
Success: Compute Engine setup, look at the connection manager
```


## %project_engine_suspend

**Description**: Stop the engine after you're done with your work.
Expand All @@ -297,7 +300,7 @@ Where:

**Output**:
```
Started suspend. Success: connection removed
Started suspend
Success: Suspending Compute Engine
```

Expand Down Expand Up @@ -331,7 +334,7 @@ Where:

Where:

- `*[Optional]*` project: Name of the project.
- **`[Optional]`** project: Name of the project.

**Output**:
```bash
Expand Down Expand Up @@ -368,12 +371,13 @@ Backup of the object definitions created
Where:

- project: Name of the project.
- `*[Optional]*` gitref: Git reference. **TA: what is the value I should provide here**
- **`[Optional]`** gitref: The Git reference for the commit from which to restore the project, if you don't want to restore from the latest.

**Output**:
```
Restore of the object definitions done
```

## %project_engine_update_users

**Description**: Update users on the deployed engine. If users are added as collaborators to the Git repository after the engine is deployed, you can use this command to update and create new users for the deployed engine.
Expand All @@ -388,7 +392,7 @@ Where:

**Output**:
```
Need input
Username and password of each user on the engine
```
## %project_engine_update_auth

Expand All @@ -405,7 +409,7 @@ Where:

**Output**:
```
Require input
Authorizations updated
```
## %project_connection_add

Expand All @@ -422,7 +426,7 @@ Where:

**Output**:
```
Require input
The connection manager shows the refreshed connection
```

## %help
Expand Down
10 changes: 8 additions & 2 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@ pagination_next: null

The manager 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. There all users get their API key, for connecting to the engine from a Jupyter notebook. And there all users can monitor projects.

<a id="glo-application-load-balancer"></a>

### API key

Definition.


<a id="glo-alb"></a>
### 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 and its engine to the public IP network.
Expand Down Expand Up @@ -76,7 +82,7 @@ A concept in containerized platforms such as Docker. You can map a directory on

## N

<a id="glo-network-load-balancer"></a>
<a id="glo-nlb"></a>
### network load balancer

Load balancers distribute incoming traffic across servers. A network load balancer does not inspect traffic content. It bases routing decisions on factors such as ports and IP addresses. You can use a network load balancer as a way to expose AI Unlimited and its engine to the public IP network.
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](/docs/resources/aws-requirements.md) or [Azure](/docs/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. See related [Git requirements](/docs/resources/git-requirements.md).
- A [GitHub](https://github.com) or [GitLab](https://gitlab.com) account to host each project repository for authenticating users and storing project information. Also, clone the [AI Unlimited GitHub repository](/docs/resources/clone-repo) provided by Teradata, which contains installation files.
- Your object storage, where your Amazon or ADLS Gen2 data lake resides.
- JupyterLab with the AI Unlimited kernel. See [installation options](/docs/resources/jupyterlab).

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

## What's next

Now you're ready to [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md).
[Create an OAuth app](/docs/resources/create-oauth-app) to allow authorization between AI Unlimited and your Git provider account.



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

Now you're ready to [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md).
[Create an OAuth app](/docs/resources/create-oauth-app) to allow authorization between AI Unlimited and your Git provider account..
4 changes: 2 additions & 2 deletions docs/install-ai-unlimited/setup-ai-unlimited.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Select **Update**.

**GitHub base URL**&mdash;The URL for your GitHub account.

**GitHub client ID** and **GitHub client secret**&mdash;The credentials received from GitHub when your [OAuth app was created](/docs/install-ai-unlimited/git-requirements.md).
**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)**

Expand Down Expand Up @@ -183,7 +183,7 @@ Select **Login**. Then, if prompted, sign in.

**GitLab base URL**&mdash;The URL for your GitLab account.

**GitLab client ID** and **GitLab client secret**&mdash;The credentials received from GitLab when your [OAuth app was created](/docs/resources/git-requirements.md).
**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)**

Expand Down
8 changes: 4 additions & 4 deletions docs/manage-ai-unlimited/change-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ 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, then in the manager select **Setup**.<br/>
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**.<br/>
[Learn about the fields](/docs/install-ai-unlimited/setup-ai-unlimited.md).
3. Change anything in **Basic setup** and select **Update**.
4. Change anything in **Cloud integration** and select **Update**.
5. Change anything in **Git integration**, and log in to authenticate yourself.
4. Sign in to authenticate yourself.
6. If you enabled TLS, on your **Profile**, select **Restart**.<br/>
AI Unlimited restarts with TLS in place.

11 changes: 8 additions & 3 deletions docs/manage-ai-unlimited/suspend-and-restore-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,26 @@ pagination_next: null

To avoid incurring charges for unneeded engine resources, suspend projects you're not working on.

All project information, including user and object store authorizations and data objects, are saved. When you restore the project, you can pick up where you left off.
All project information, including user authorizations, object store authorizations, and data objects, are saved. When you restore the project, you can pick up where you left off.

## Suspend

In your notebook, run this:
In your notebook, run this magic command:

```bash
%project_engine_suspend <Project_Name>
```


## Restore

In your notebook, run this:
In your notebook, run this magic command:

```bash
%project_restore project=<Project_Name>, gitref=<Git_Reference>
```
<br/>
:::note
Learn more about [magic commands](/docs/explore-and-analyze-data/magic-commands.md).
:::

2 changes: 1 addition & 1 deletion docs/resources/aws-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pagination_next: null

# AWS account requirements

- Work with your cloud admin to ensure you have the [IAM](https://aws.amazon.com/iam/) permissions you need to create the cloud resources defined in your choice of [AI Unlimited template](https://github.com/Teradata/ai-unlimited/tree/develop/deployments/aws/templates/ai-unlimited).
- Work with your cloud admin to ensure you have the [IAM](https://aws.amazon.com/iam/) permissions you need to create the cloud resources defined in the [AI Unlimited template](https://github.com/Teradata/ai-unlimited/tree/develop/deployments/aws/templates/ai-unlimited).

- If you'll need to access the manager instance to run commands or debug, you can connect to it one of these ways:
- Use a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) that you generate to securely connect using Secure Shell (SSH). You will need the key pair when you [specify the stack details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms).
Expand Down
20 changes: 20 additions & 0 deletions docs/resources/clone-repo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: clone-repo
title: Clone the AI Unlimited GitHub repository
description: The repository, provided by Teradata, contains files for AI Unlimited installation.
sidebar_label: Clone the AI Unlimited repository
sidebar_position: 3
pagination_prev: null
pagination_next: null
---

# Clone the AI Unlimited GitHub repository

The `deployments` folder in the [AI Unlimited GitHub repository](https://github.com/Teradata/ai-unlimited) that Teradata provides contains template, parameter, and policy files for installing AI Unlimited.

Open a terminal window, and clone the repository.

``` bash
git clone https://github.com/Teradata/ai-unlimited
```

Loading

0 comments on commit 71fc76e

Please sign in to comment.