Skip to content
This repository has been archived by the owner on Feb 14, 2025. It is now read-only.

Commit

Permalink
lots of clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed Apr 21, 2024
1 parent 3884c3f commit 95eee18
Show file tree
Hide file tree
Showing 31 changed files with 89 additions and 227 deletions.
9 changes: 0 additions & 9 deletions docs/_partials/_choose-aws-jupyter-template.mdx

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_partials/_choose-aws-manager-template.mdx

This file was deleted.

14 changes: 10 additions & 4 deletions docs/advanced/jupyterlab/install-jupyterlab-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,17 @@ import MyPartial from '/docs/_partials/_clone-repo.mdx';

## Download the Jupyter template

import MyPartial from '/docs/_partials/_choose-aws-jupyter-template.mdx';
CloudFormation templates for JupyterLab are here in the AI Unlimited GitHub repository you cloned:

<MyPartial />
`/deployments/aws/templates/jupyter/`

1. Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#glo-load-balancer) and what type.

- `jupyter-alb.yaml`&mdash;Hosts JupyterLab behind an [application load balancer](/docs/glossary.md#glo-application-load-balancer)
- `jupyter-with-nlb.yaml`&mdash;Hosts JupyterLab behind a [network load balancer](/docs/glossary.md#glo-network-load-balancer)
- `jupyter-without-lb.yaml`&mdash;No load balancer

Download the template.
2. Download the template.


## Upload the template
Expand All @@ -40,7 +46,7 @@ Download the template.
3. Search for and go to **CloudFormation**.
4. Select **Create Stack**, then **With new resources (standard)**.
5. Select **Choose an existing template** and **Upload a template file**.
6. Choose the template file you decided to use, and click **Next**.
6. Choose the template file you downloaded, and click **Next**.


## Specify stack details and options
Expand Down
5 changes: 0 additions & 5 deletions docs/advanced/quickstart/docker-before-you-begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,3 @@ Default security group
Subscribe on your cloud service provider's marketplace:
- AWS ***(link)***
- Azure ***(link)***


## Next step

[Install the manager and JupyterLab](/docs/advanced/quickstart/docker-install-ai-unlimited-jupyter.md).
3 changes: 3 additions & 0 deletions docs/explore-and-analyze-data/create-first-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ title: Create your first project
description: Learn how to use AI Unlimited by running a simple workflow in a Jupyter notebook.
sidebar_label: Create your first project
sidebar_position: 2
pagination_prev: null
pagination_next: null

---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
2 changes: 2 additions & 0 deletions docs/explore-and-analyze-data/example-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Example projects
description: Try out example projects to see what you can do with AI Unlimited.
sidebar_label: Example projects
sidebar_position: 4
pagination_prev: null
pagination_next: null
---

# Example projects
Expand Down
2 changes: 2 additions & 0 deletions docs/explore-and-analyze-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Teradata - using AI Unlimited
description: As a data scientist or data engineer, learn how you can use AI Unlimited.
sidebar_label: Explore and analyze data
sidebar_position: 2
pagination_prev: null
pagination_next: null
---

# Explore and analyze data
Expand Down
4 changes: 3 additions & 1 deletion docs/explore-and-analyze-data/magic-commands.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
id: magic-commands
title: Magic commands
description: Learn about the AI Unlimited magic commands you can use in your project in your Jupyter notebook.
description: Learn about the AI Unlimited magic commands (**%magic_command**) asdf you can use in your project in your Jupyter notebook.
sidebar_label: Magic commands
sidebar_position: 5
pagination_prev: null
pagination_next: null
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
9 changes: 6 additions & 3 deletions docs/explore-and-analyze-data/project-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@ title: Project lifecycle
description: See the overall project lifecycle for project owners and collaborators.
sidebar_label: Project lifecycle
sidebar_position: 3
pagination_prev: null
pagination_next: null
---

# Project lifecycle

AI Unlimited provides [magic commands](/docs/explore-and-analyze-data/magic-commands.md) for creating and managing projects in Jupyter notebooks.
You might be the owner of one or more projects and a collaborator on others.

If you create a project, you are its owner. Once a project is created, your Git repository owner can [add collaborators](/docs/manage-ai-unlimited/add-collaborators.md) to the project in the repository. In the notebook, you'll need to update the engine for those new users.
If you create a project, you are its owner. After anyone creates a project, the owner of your Git repository can [add collaborators](/docs/manage-ai-unlimited/add-collaborators.md) to the project in the repository. Then in the project notebook, you need to update the engine for those new users.

AI Unlimited provides [magic commands](/docs/explore-and-analyze-data/magic-commands.md) (`%magic_command`) for creating and managing projects in your Jupyter notebooks. While project owners and collaborators can use the same magic commands, their project involvement is typically different.

You might be the owner of one or more projects and a collaborator on others. While owners and collaborators can use the same magic commands, their project involvement is typically different.

## Project owners

Expand Down
2 changes: 2 additions & 0 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Glossary
description: Terminology for the installation and use of AI Unlimited.
sidebar_label: Glossary
sidebar_position: 7
pagination_prev: null
pagination_next: null
---

# Glossary
Expand Down
3 changes: 2 additions & 1 deletion docs/install-ai-unlimited/install-manager-AWS/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ title: Install on AWS
description: Learn the prerequisites and how to deploy the CloudFormation template for the manager.
sidebar_label: Install on AWS
sidebar_position: 1
pagination_prev: null
---

# Install on AWS

You'll use a CloudFormation template to install the AI Unlimited manager on AWS. After you install the manager, you'll use it to set up AI Unlimited and configure the engine's deployment on AWS.
You'll use a CloudFormation template to install the AI Unlimited manager on AWS. After you install the manager, you'll use it to set up AI Unlimited and configure the engine's deployment.

:::tip
For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Deploy the manager using the AWS console
description: Learn how to deploy the AI Unlimited manager using the CloudFormation template.
sidebar_label: Deploy the CloudFormation template
sidebar_position: 2
pagination_next: null
---

# Deploy the CloudFormation template
Expand All @@ -16,11 +17,17 @@ References to the AWS Management Console are accurate as of April 11, 2024.

## Download the manager template

import MyPartial from '/docs/_partials/_choose-aws-manager-template.mdx';
CloudFormation templates for the manager are here in the AI Unlimited GitHub repository you cloned:

<MyPartial />
`/deployments/aws/templates/ai-unlimited/`

Download the template.
1. Choose a template based on whether your AWS infrastructure uses a [load balancer](/docs/glossary.md#glo-load-balancer) and what type.

- `ai-unlimited-with-alb.yaml`&mdash;Hosts the manager behind an [application load balancer](/docs/glossary.md#glo-application-load-balancer)
- `ai-unlimited-with-nlb.yaml`&mdash;Hosts the manager behind a [network load balancer](/docs/glossary.md#glo-network-load-balancer)
- `ai-unlimited-without-lb.yaml`&mdash;No load balancer

2. Download the template.

## Load the template

Expand All @@ -34,10 +41,10 @@ Download the template.
## Specify stack details and options

1. Provide a stack name.
2. Review the parameters. Provide values for the required ones. Your organization might require others.
2. Review the parameters. Provide values for the required parameters. Your organization might require others.

:::note
The parameters for each template vary. You might see some in the table that you don't see in the AWS console.
The parameters for each template vary. You might see some parameters here that you don't see in the console.
:::

***We are working on the table/scrollbar issues.***
Expand Down Expand Up @@ -80,19 +87,8 @@ The parameters for each template vary. You might see some in the table that you

</details>

***These are all the parms for the 3 templates this topic uses, correct? Just to make sure, do they exlude any that are for the all-in-one?***
**TA: Yes, I verified the fields***

***If/when we know there will be no more changes, we should verify all of them.***

***Possible to include the section names in the table? AI Unlimited, AI Unlimited connection, and Persistent volume. I tried and couldn't do it.*** **TA: Table design restriction for Markdown*** Can provide an row with the headers but columns can't be merged***

***Persistent volume parms are in the table. Do we need a section in this topic for more info about persistent volumes (from the readme - and like what's in the tech review content)? If we can slim that down and put it in the Notes column of the table, that would be best.***

***TA: I think, the important bits can be in the table, as it would help users make the right selection at that point in time, or provide a link to a topic in the advanced section***

4. Select **Next**.
5. [Configure stack options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html) per your requirements, then select **Next**.
3. Select **Next**.
4. [Configure stack options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html) per your requirements, then select **Next**.

## Review and create the stack

Expand All @@ -101,11 +97,13 @@ The parameters for each template vary. You might see some in the table that you
3. Select **Submit** to deploy the stack.
4. Monitor the stack's status. When you see `CREATE_COMPLETE`, the AI Unlimited manager is ready.

Use the URLs in **Outputs** to view the created resources. You'll need the host (the IP address or hostname) when you connect to the manager from a Jupyter notebook.
Use the URLs in **Outputs** to view the created resources.

You'll need the host (the IP address or hostname) when you connect to the manager from a Jupyter notebook.

***Haven't actually seen what happens after clicking Submit.***
***Haven't actually seen what happens after clicking Submit. Where does the status appear? Is Outputs just another section that appears?***

##Next step
## Next step

In the manager, [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@ Make sure you have the following:

- A pay-as-you-go [AWS account](https://aws.amazon.com) account.

- [GitHub](https://github.com) or [GitLab](https://gitlab.com) account for user authentication and storing project information.
- A [GitHub](https://github.com) or [GitLab](https://gitlab.com) account for user authentication and storing project information.

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

## Clone the repo

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

Open a terminal window, and clone the repository.

Expand Down Expand Up @@ -55,9 +58,9 @@ Use these JSON samples to create the policies you need, and attach them to the r

- [ai-unlimited-workspaces.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-workspaces.json): Includes permissions to create engine instances, and grants AI Unlimited permissions to create a cluster-specific role and policies.

- [ai-unlimited-without-iam-role-permissions.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-workspaces-without-iam-role-permissions.json): Includes permissions to create engine instances, but not those needed for AI Unlimited to create cluster-specific roles and policies. Use this, and **ai-unlimited-engine.json**, if your AWS account has restrictions that won't allow AI Unlimited to create roles and policies.
- [ai-unlimited-without-iam-role-permissions.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-workspaces-without-iam-role-permissions.json): Includes permissions to create engine instances, but not those needed for AI Unlimited to create cluster-specific roles and policies. Use this, and `ai-unlimited-engine.json`, if your AWS account has restrictions that won't allow AI Unlimited to create roles and policies.

- [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json): Allows AI Unlimited to pass the role to the cluster each time the engine is deployed. Use this with **ai-unlimited-without-iam-role-permissions.json**. Modify the policy with your your account details.
- [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json): Allows AI Unlimited to pass the role to the cluster each time the engine is deployed. Use this with `ai-unlimited-without-iam-role-permissions.json`. Modify the policy with your your account details.

If AI Unlimited creates cluster-specific policies, they are restricted as follows:

Expand Down Expand Up @@ -109,11 +112,8 @@ You can copy this template to get these details from an admin. Or, get them from

Subscribe on the AWS marketplace. ***link***

Then start [exploring and analyzing data](\docs\explore-and-analyze-data).


## Next step

[Install the manager](/docs/install-ai-unlimited/install-manager-AWS/prod-aws-console-deploy-ai-unlimited.md).


3 changes: 2 additions & 1 deletion docs/install-ai-unlimited/install-manager-Azure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ title: Install on Azure
description: Learn the prerequisites and how to deploy the ARM template for the manager.
sidebar_label: Install on Azure
sidebar_position: 1
pagination_prev: null
---

# Install on Azure

You'll use an ARM template to install the AI Unlimited manager on Azure. After you install the manager, you'll use it to set up AI Unlimited and configure the engine's deployment on Azure.
You'll use an ARM template to install the AI Unlimited manager on Azure. After you install the manager, you'll use it to set up AI Unlimited and configure the engine's deployment.


:::tip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Deploy the manager using the Azure Portal
description: Learn how to deploy the AI Unlimited manager using the ARM template.
sidebar_label: Deploy the ARM template
sidebar_position: 2
pagination_next: null
---

# Deploy the ARM template
Expand All @@ -18,18 +19,17 @@ References to the Azure Portal are accurate as of April 14, 2024.

Download the template (`/deployments/azure/ai-unlimited.json`) from the AI Unlimited GitHub repository you cloned.

***In the repo, what are the templates that end in ".cloudinit" and ".service"?***

## Load the template

1. Sign in to the [Azure portal](https://portal.azure.com).
1. Sign in to the [Azure Portal](https://portal.azure.com).
2. Search for **custom deployment**, then select **Deploy a custom template**.
3. Select **Build your own template in the editor** and then **Load file**.
4. Choose the template file you downloaded, and click **Save**.

## Specify instance details

Review the parameters. Provide values for the required ones. Your organization might require others.
Review the parameters. Provide values for the required parameters. Your organization might require others.

***We are working on the table/scrollbar issues.***

Expand Down Expand Up @@ -63,22 +63,20 @@ Review the parameters. Provide values for the required ones. Your organization m
|Use NLB| Specifies whether the instance is accessed using a Network Load Balancer.|Required with default |false||
| Tags | The key-value pairs that are assigned to the resources for quick identification.| Optional| |


</details>

***My comments in the AWS manager (console) topic about the tables apply to this topic too.***

***Persistent volume parms are in the table. Do we need a section in this topic for more info about persistent volumes (from the readme - and like what's in the tech review content)? If we can slim that down and put it in the Notes column of the table, that would be best.***

## Create the instance

1. Select **Review + create**, then **Create**.
2. Monitor the deployment status on the **Notifications** page.

You'll see connection parameters for the manager in **Outputs.** You'll use when you connect to the manager from a Jupyter notebook.
You'll see connection parameters for the manager in **Outputs.**

You'll need the host (the IP address or hostname) when you connect to the manager from a Jupyter notebook.

***Haven't actually seen what happens after clicking Create.***
***Haven't actually seen what happens after clicking Create. Is there really a "Notifications" page? Is Outputs just another section that appears?***

##Next step
## Next step

In the manager, [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md).
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ Make sure you have the following:

- A pay-as-you-go [Azure account](https://azure.microsoft.com).

- [GitHub](https://github.com) or [GitLab](https://gitlab.com) account for user authentication and storing project information.
- A [GitHub](https://github.com) or [GitLab](https://gitlab.com) account for user authentication and storing project information.

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

## Clone the repo



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

Open a terminal window, and clone the repository.

Expand Down Expand Up @@ -102,14 +107,10 @@ Security Group:

***These are the required parms, but the customer's org may require more. Can't put a table (of the full set) in a code block.***

***I also see "Public Key" (would go after Region) and "Role Definition Id" (would be last).
***I also see "Public Key" (would go after Region) and "Role Definition Id" (would be last). There's a slack comment.***


## Subscribe to AI Unlimited

Subscribe on the Azure marketplace. ***link***


## Next step

[Install the manager](/docs/install-ai-unlimited/install-manager-Azure/prod-azure-portal-deploy-manager.md).
8 changes: 5 additions & 3 deletions docs/install-ai-unlimited/setup-ai-unlimited.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
id: test-quickstart-setup
title: QuickStart - Setup
description: Get more information about certain fields in the setup.
id: setup-ai-unlimited
title: Setup
description: Get more information about certain fields in the AI Unlimited setup.
sidebar_label: Set up AI Unlimited
sidebar_position: 3
pagination_prev: null
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Change settings (for administrators)
description: Learn how to change settings configured during installation.
sidebar_label: Change settings
sidebar_position: 1
pagination_prev: null
pagination_next: null
---

# Change settings
Expand Down
Loading

0 comments on commit 95eee18

Please sign in to comment.