Skip to content

Commit

Permalink
mostly setup work & changes to last task of install
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed Apr 28, 2024
1 parent 8844064 commit 63c94d5
Show file tree
Hide file tree
Showing 8 changed files with 135 additions and 81 deletions.
4 changes: 3 additions & 1 deletion docs/advanced/deployment-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ When you install the AI Unlimited manager from your cloud service provider's con

You can get the values from your cloud service provider's console. Or, copy the parameter names shown here, and ask an admin for their values.

***Discuss***

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

Expand All @@ -46,7 +48,7 @@ Subnet:
Security Group:
```

***I also see "Public Key" (would go after Region) and "Role Definition Id" (would be last). There's a slack comment.***
***"Public Key" (would go after Region) and "Role Definition Id" (would be last) are also required. There's a slack comment. Will revisit after working through Azure account reqs.***

</TabItem>
</Tabs>
Expand Down
10 changes: 5 additions & 5 deletions docs/advanced/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: other-resources-ai-unlimited
title: Other resources
id: resources-ai-unlimited
title: Resources
description: Find additional installation information here.
sidebar_label: Other resources
sidebar_label: Resources
sidebar_position: 4
pagination_prev: null
pagination_next: null
---

# Other resources
# Resources

Here you'll find additional topics related to installation.
Here you'll find installation-related resources.
22 changes: 12 additions & 10 deletions docs/advanced/quickstart/docker-install-ai-unlimited-jupyter.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ import TabItem from '@theme/TabItem';

# Run the manager and JupyterLab using Docker

The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for monitoring projects. You'll also use it to set up AI Unlimited.
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.

***How can we make clear that their user and project info repo gets created as part of this process?***
Installing the manager also creates a Git repository for user and project information.

You'll use [Docker Compose](https://docs.docker.com/compose/) to run the AI Unlimited manager and JupyterLab, with the AI Unlimited Jupyter Kernel, locally in containers.

Expand All @@ -26,10 +26,6 @@ For installation support, ask the [community](https://support.teradata.com/commu

In addition to the standard [AI Unlimited prerequisites](/docs/install-ai-unlimited/#gs-prerequisties), make sure you have [Docker](https://www.docker.com/get-started/) installed on your machine.

## Subscribe

If you haven't already, subscribe to AI Unlimited on the [AWS Marketplace] ***need link*** or [Azure Marketplace] ***need link***.


## Set configuration file locations

Expand Down Expand Up @@ -114,14 +110,20 @@ When JupyterLab is ready, you can access it at `http://localhost:8888`, and ente

## Get engine deployment details

***Any changes to make for the old UI? Keep both files - old (PPP, initially) and new (longer-term)***
***Any changes to make for the old UI? Come back to this after finishing setup.***

***Come back to this after finishing setup.***

When you set up AI Unlimited in the manager (that's next), you'll provide details about deploying the engine.
When you set up AI Unlimited (that's next), you'll provide details about deploying the engine.

You can get the values for those fields from your cloud service provider's console. Or, copy the fields shown here, and ask an admin for their values ahead of time.

***Setup includes many more details than these. Are these the only ones in the the CSP console (I didn't check)? The idea being, that the QS user might not have access to the console?***

***Wouldn't they also need help with the TLS certificate & key (we want them to use TLS), GitLab group access ID or GutHub organization ID, IAM role, inbound security items other than security group names.***

***Will they know to select Private or Public for accessing the engine? The setup shows they can enter multiple security groups, but the cloud parm is the default group--would the user know the other security group names?***

***I'd like to better understand the rationale for this content. Might it lead them to think the setup is this simple?***

<Tabs>
<TabItem value="aws" label="AWS">
```bash
Expand Down
2 changes: 2 additions & 0 deletions docs/install-ai-unlimited/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Subscribe to AI Unlimited on the [AWS Marketplace] ***(link to listing)*** or [A
<a id="gs-prerequisites"></a>
## Prerequisites

***consider making this its own page - first one after the Get Started parent***

- A pay-as-you-go AWS or Azure account on which to provision compute resources
- Account requirements&mdash;[AWS](/docs/advanced/aws-requirements.md) or [Azure](/docs/advanced/azure-requirements.md)
- A [GitHub](https://github.com) or [GitLab](https://gitlab.com) account to host your repository for authenticating users and storing project information
Expand Down
88 changes: 66 additions & 22 deletions docs/install-ai-unlimited/new-setup-ui_for-post-ppp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: setup
title: Help with post-installation setup
description: Find additional information about some of the setup fields.
sidebar_label: Set up AI Unlimited (test - new ui)
sidebar_label: Set up AI Unlimited (new ui - post ppp)
sidebar_position: 4
pagination_prev: null
pagination_next: null
Expand All @@ -13,49 +13,75 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


# Set up AI Unlimited (test - new UI)
# Set up AI Unlimited (new UI - post ppp)

After you install the manager, access it using the url provided at the end of the installation process.
After you install the manager, access it using the URL you received by deploying its cloud resources: `http://[ip_or_hostname]:[port]`.

Sign in with your GitHub or GitLab credentials, then complete the setup. ***re-watch recording***
Then, in the manager, complete the three setup steps to set up AI Unlimited.

To learn more about certain fields, click a section below.
You'll find additional information about some of the fields here.

***Need to figure out how to marry "manager" with just "AI Unlimited". Possible for "manager" to be used only in installation content and after that, from setup onward, it's just "AI Unlimited"? Make it so.***
:::note
If you installed the manager yourself, some setup details will be familiar from the cloud template. If you did not install the manager yourself, or you need guideance, you might reach out to an admin.
:::

<details>

<summary>Step 1: The basics</summary>
<summary>Step 1: Git integration</summary>

**TLS**
<Tabs>
<TabItem value="gitlab" label="GitLab">

Use [Transport Layer Security (TLS)](/docs/glossary.md#glo-tls) to secure connections to the AI Unlimited service and safeguard your data in transit.
**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.

**Certificates**
AI Unlimited uses your [OAuth app](/docs/advanced/git-requirements#oauth.md) to authorize access to your GitHub or GitLab account. This allows AI Unlimited to store user and project information there.

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.
Selecting **Authenticate** establishes this access and returns you to the setup.

Or use a Teradata system-generated certificate. It automatically renews before it expires.
**Group access**

</details>
xxxxx

Something about Groups in general--tie group concept to repository concept and authorization (not authentication?) concept.

<details>
</TabItem>

<summary>Step 2: Git integration</summary>
<TabItem value="github" label="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.

AI Unlimited uses your [OAuth app](/docs/advanced/git-requirements#oauth.md) to authorize access to your GitHub or GitLab account. This allows AI Unlimited to store user and project information there.

Selecting **Authenticate** establishes the access and returns you to the setup. ***add something about how all users will be authenticated***
Selecting **Authenticate** establishes this access and returns you to the setup.

**Group access**
**Organization access**

Something about Groups in general--tie group concept to repository concept and authorization (not authentication?) concept.
xxxx

</TabItem>
</Tabs>

</details>


<details>

<summary>Step 2: The basics</summary>

**TLS**

Use [Transport Layer Security (TLS)](/docs/glossary.md#glo-tls) to secure connections to the AI Unlimited service and safeguard your data in transit.


**Certificates**

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 use a Teradata system-generated certificate. It automatically renews before it expires.

</details>

Expand All @@ -69,26 +95,44 @@ Something about Groups in general--tie group concept to repository concept and a

**IAM role**

If AI Unlimited creates the [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html), 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 be broad enough to include all the clusters that might deploy the engine. ***come back to this - in the doc, find the policy to which the UI refers ("create an IAM role using this policy")***
If AI Unlimited creates the [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html), 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 be broad enough to include all the clusters that might deploy the engine.

***This content should probably link to the Create Role topic, which refers to the policy. But on the figma, looks like there's a plan to add a copy icon for the policy. right on the UI. Revisit after working on the AWS role topic.***

***Inbound security - Permission boundaries is new***

**Network type**

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. ***Is it determined by a cloud parm? Tell them where/when they chose it and where to see it?***
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.

</TabItem>

<TabItem value="azure" label="Azure">

**Network type**

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. ***Is it determined by a cloud parm? Tell them where/when they chose it and where to see it?***
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.

</TabItem>
</Tabs>

</details>


## What's next

In a Jupyter notebook, start [exploring and analyzing data](/docs/explore-and-analyze-data/).



github

**Authorizing Organization**: Restricts AI Unlimited access to users belonging to a specific organization on GitHub. If left blank, any user with a GitHub account can authorize and access AI Unlimited.

**Repository Organization**: Create projects within the repository. If left blank, your projects are located in your personal GitHub space. Teradata recommends specifying this value to collaborate and centralize projects within a specific group.


gitlab

**Authorizing Group ID**: The unique identifier assigned to a group within GitLab that has the authorization to access AI Unlimited.

**Repository Group ID**: The unique identifier assigned to the repository where the AI Unlimited projects are to be stored. Use this field to organize repositories into logical groups, allowing for easier management and access control.
22 changes: 16 additions & 6 deletions docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ pagination_next: null

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

The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for monitoring projects. You'll also use it to set up AI Unlimited.
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.

Installing the manager also creates a Git repository for user and project information.

You'll deploy a server instance, on which the manager runs in a container controlled by [systemd](/docs/glossary.md#glo-systemd).

:::note
By installing the manager, you become the AI Unlimited administrator.
:::

:::tip
For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
:::
Expand Down Expand Up @@ -102,20 +106,26 @@ We recommend selecting the region closest to your primary work location.
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

***Can a tester please provide a screen recording so we can verify these steps?***

1. Review the template settings.
2. Select the check box to acknowledge that the template will create IAM resources.
3. Select **Submit** to deploy the stack.
4. Monitor the stack's status. When you see `CREATE_COMPLETE`, the AI Unlimited manager is ready.
3. Select **Submit** to deploy the stack.<br />
On the **Events** tab, you can monitor progress. When the **Status** is `CREATE_COMPLETE`, the manager is ready.

The **Outputs** tab shows the values generated for the created resources.

***Does it show the actual url or just the public and private IP addresses?***

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.
You'll need the URL and other values to access the manager and set up AI Unlimited.

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

## What's next

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



Expand Down
Loading

0 comments on commit 63c94d5

Please sign in to comment.