Skip to content

Commit

Permalink
lots of clean up - GS and OR ready for reviewers
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed May 7, 2024
1 parent 08dd498 commit ac444b3
Show file tree
Hide file tree
Showing 22 changed files with 181 additions and 120 deletions.
44 changes: 18 additions & 26 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,54 @@
---
id: faq
title: FAQ
description: Frequently asked questions regarding the installation and use of AI Unlimited.
description: Find answers to your AI Unlimited questions here.
sidebar_label: FAQ
sidebar_position: 6
---

# FAQ

(Just brainstorming ideas for Q's, for now. Can categorize to make them more skimmable.)
(Just brainstorming ideas, for now. Will categorize to make them more skimmable.)

**What's the difference between AI Unlimited and Teradata Vantage?**
Answer.

**What's the difference between AI Unlimited and Teradata ClearScape Analytics?**
Answer.

**How do I pay for AI Unlimited use?**
**How do I pay for AI Unlimited?**
Answer.

**Is the QuickStart free?**
Answer.

**What CSPs does AI Unlimited support?**
Currently, AWS and Azure.
AWS and Azure

**What kind of data needs to be in my data lake?** Object (too obvious?)
**What are the AI Unlimited user types?**
Admin, project owner, collaborator--will expound.

**As a general AI Unlimited user, what can I do?**
Answer.

**As the administrator user, what can I do?**
Answer.
**What integrations and automation are possible?**
(Not specifically addressing devs for *initial* PPP. But surely folks will ask?)

**As a developer, what can I do?**
Answer.
**I'm an admin. After the initial setup, can I go back and change settings?**
Yes. (any of them?)

**What's my API key for?**
It enables your notebook to connect to the project's engine. (Accurate?) There is always only one API key per authenticated user. It doesn't change or expire. (not yet anyway)
**Can I add other administrator users?**
You can have only one AI Unlimited admin.

**What is a project owner?**
If you create a project, you are its owner. If you add collaborators, they are not the project's owners.
**As a project owner, can I add other users to my project?**
Of course. Explain.

**As a project owner, can I add other users to my project?** Answer.
**What's my API key for?**
Answer.

**How can I access another user's project?**
(Ask them to add you as a collaborator? Artur will write up this capability and the current real reason for it.)
Ask the owner to add you as a collaborator. Link to the steps.

**What happens when I suspend a project?**
Answer.

**And when I resume it?**
**And when I restore it?**
Answer.

**After the initial setup, can I change the settings?**
Yes. (any of them?)

**Can I add other administrator users?**
In this release, you can have only one administrator.

**What integrations and automation are possible?** Dunno.
2 changes: 1 addition & 1 deletion docs/explore-and-analyze-data/example-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ Here are just some of the types of workloads you can run using AI Unlimited:
- b
- c

***The example notebooks and data files will be in the "examples" folder in the AI Unlim repo. Here we just need to add links.***
(The notebooks and data files will be in the "examples" folder in the AI Unlim repo. Here we just need to add links.)


6 changes: 5 additions & 1 deletion docs/explore-and-analyze-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pagination_next: null
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 [Jupyter installation options](/docs/advanced/jupyterlab).
If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installation options](/docs/resources/jupyterlab).
:::


Expand All @@ -24,4 +24,8 @@ If you don't have JupyterLab or the AI Unlimited kernel, see [Jupyter installati

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

:::tip
For help with AI Unlimited projects, magic commands, and analytic functions, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
:::
4 changes: 1 addition & 3 deletions docs/install-ai-unlimited/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,10 @@ If AI Unlimited has already been installed and set up by someone at your organiz
When you install the manager, you'll provide values for some cloud deployment details. See the [AWS details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms) or [Azure details](/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md#azure-parms)—if you want to work with a cloud admin to get the values ahead of time.
:::

***maybe we no longer want the note that follows - too confusing with the new option to deploy from the marketplace - might depend on the name of the new deployment method***

:::note
With AI Unlimited you can collaborate on projects with other users.

If you prefer a simpler, single-user approach, try the [QuickStart](/docs/advanced/quickstart) which runs the manager and JupyterLab in Docker containers on your computer.
If you prefer a simpler, single-user approach, try the [QuickStart](/docs/resources/quickstart) which runs the manager and JupyterLab in Docker containers on your computer.
:::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimi

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.

You'll deploy a server instance, on which the manager runs in a container controlled by [systemd](/docs/glossary.md#glo-systemd).
You'll use a CloudFormation template provided by Teradata to install the manager from the AWS Management Console. You'll deploy a server instance, on which the manager runs in a container controlled by [systemd](/docs/glossary.md#glo-systemd).

:::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 @@ -14,7 +14,7 @@ Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimi

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.

You'll deploy a server instance, on which the manager runs in a container controlled by [systemd](/docs/glossary.md#glo-systemd)
You'll use an Azure Resource Manager (ARN) template provided by Teradata to install the manager from the Azure Portal. You'll deploy a server instance, on which the manager runs in a container controlled by [systemd](/docs/glossary.md#glo-systemd)

:::tip
For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
Expand Down
2 changes: 1 addition & 1 deletion docs/manage-ai-unlimited/add-collaborators.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ pagination_next: null

[placeholder]

***from Artur: User are added to the project by github/gitlab, if users are added before deploy then they are all created automatically as part of the deployment. If users are added there after deploy then %project_engine_update_users need to be used to update and create new users in the deployed engine.***
"Users are added to the project by github/gitlab, if users are added before deploy then they are all created automatically as part of the deployment. If users are added there after deploy then %project_engine_update_users need to be used to update and create new users in the deployed engine."
18 changes: 9 additions & 9 deletions docs/manage-ai-unlimited/change-settings.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
---
id: change-settings
title: Change settings (administrator only)
title: Change settings (admin)
description: Learn how to change AI Unlimited settings.
sidebar_label: Change settings (administrator only)
sidebar_label: Change settings (admin)
sidebar_position: 4
pagination_prev: null
pagination_next: null
---

# Change settings (administrator only)
# Change settings (admin)

***WIP***

***Needs 2 separate topics - old UI vs. new UI.***
(Needs 2 separate topics - old UI vs. new UI)

If you are the AI Unlimited admin, you can change AI Unlimited settings.

***(make clear what they can/would change and why)***
(make clear what they can/would change and why)

:::note
The user who [set up AI Unlimited](/docs/install-ai-unlimted/setup-ai-unlimited.md) is the admin.
The user who [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md) is the admin.
:::

1. Access the manager ***(more details)***, sign in to your GitHub or GitLab account... how to say that... ***(will watch recording)***
1. Access the manager ***(more details)***, sign in to your GitHub or GitLab account... how to say that... (will watch recording)
3. Select **Setup**.
3. In any section, change any values, then select **Save Changes**. ***(can they change anything at all?)***<br />
3. In any section, change any values, then select Save Changes. (can they change anything at all?)<br />
[Learn about the fields](/docs/install-ai-inlimited/setup-ai-unlimited).
4. If you've enabled TLS, select **Restart**.<br />
AI Unlimited restarts with TLS in place.

Go to the **Profile** page to copy your new API Key. ***(explain why they have a new one & to start using the new one)***
Go to the **Profile** page to copy your new API Key. (explain why they have a new one & to start using the new one)
6 changes: 5 additions & 1 deletion docs/manage-ai-unlimited/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here's what different users can do.

- Use [magic commands](/docs/explore-and-analyze-data/magic-commands.md) to manage projects in Jupyter notebooks

- [Suspend and restore projects](/docs/manage-ai-unlimited/suspend-and-resume-project.md) to *pay as you go*
- [Suspend and restore projects](/docs/manage-ai-unlimited/suspend-and-resume-project.md) (*pay as you go*)

- [Monitor the status](/docs/manage-ai-unlimited/monitor-projects.md) of projects

Expand All @@ -29,3 +29,7 @@ A user who creates a project is the project's owner.
The user who [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md) is the admin.

- [Change overall settings](/docs/manage-ai-unlimited/change-settings.md) ***(will explain this better - what does this really mean)***

:::tip
For help with managing projects, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa).
:::
6 changes: 4 additions & 2 deletions docs/manage-ai-unlimited/monitor-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ pagination_next: null

# Monitor projects

***old ui - no diff beween what admin and general user sees - they just see a table with all the projects and their statuses***
[placeholder]

***new ui - admin sees all projects, with statuses, and logs - general user sees that for just their own projects***
old ui - no diff beween what admin and general user sees - they just see a table with all the projects and their statuses

new ui - admin sees all projects, with statuses, and logs - general user sees that for just their own projects
5 changes: 2 additions & 3 deletions docs/manage-ai-unlimited/suspend-and-resume-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,17 @@ 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.
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.

In your project notebook, run this:

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

You can restore the project anytime by running this:
Restore the project anytime by running this:

```bash
%project_restore project=<Project_Name>, gitref=<Git_Reference>
```

You can now pick up where you left off, without having to re-create the project.
37 changes: 18 additions & 19 deletions docs/resources/aws-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ pagination_next: null

# AWS account requirements

***(This topic is still being discussed.)***
Prepare your AWS account:

- Work with your cloud admin to ensure you have the [Identity and Access Management (IAM)](https://aws.amazon.com/iam/) permissions to create cloud resources.
- 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).

- If you'll need to access the manager instance, after it is installed, to run commands or debug, you can connect to it one of these ways:
- Generate a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) to securely connect using Secure Shell (SSH). You will need the key pair when you [specify the manager's stack details](/docs/install-ai-unlimited/prod-aws-console-ai-unlimited.md#aws-parms).
- 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).
- Use AWS Session Manager to connect. To enable this, attach the [session-manager.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/session-manager.json) policy to a [role you provide](#provide-roles) to the manager.

- If you’re using an [Application Load Balancer (ALB)](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancer-getting-started.html) or [Network Load Balancer (NLB)](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-getting-started.html), make sure you have permission to manage these AWS services:
Expand All @@ -27,31 +27,28 @@ pagination_next: null

The manager requires a role that allows it to deploy the engine. The engine requires a role that allows the engine's nodes to communicate.

:::note
If your security does not allow AI Unlimited to create roles, [create the roles](#provide-roles) yourself or with the help of your cloud admin.
:::


**Role required by the manager**

To let Unlimited create this role for you, when you [install the manager](/docs/install-ai-unlimited/prod-aws-console-ai-unlimited.md), provide these values for these parameters:
To let Unlimited create this role for you, when you [specify the stack details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms), provide these values for these parameters:
- `IamRole`: **New**
- `IamRoleName`: leave blank


**Role required by the engine**

Let AI Unlimited create a new role for the cluster that deploys the engine each time the engine is deployed.
Let AI Unlimited create a new role for the engine each time the engine is deployed.

The cluster-specific policies AI Unlimited creates are restricted this way:
The engine-specific policies AI Unlimited creates are restricted this way:

***(we are aware of this type size issue)***

```bash
"Resource": ["arn:aws:secretsmanager:`REGION`:`ACCOUNT_ID`:secret:compute-engine/`CLUSTER_NAME`/`SECRET_NAME`"]
```

To allow this, when you [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited), leave the **Default IAM role** field blank.
To allow this, when you [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited), leave the **Default IAM role** field blank.

:::note
If your security does not allow AI Unlimited to create roles, create the roles yourself or with the help of your cloud admin.
:::


<a id="provide-roles"></a>
Expand All @@ -64,23 +61,25 @@ If your security does not allow AI Unlimited to create roles, provide them.

- If you have permissions to create IAM resources, create the role:
- Attach a policy that includes the JSON that meets your needs. See the JSON samples that follow.
- When you [specify the manager's stack details](/docs/install-ai-unlimited/prod-aws-console-ai-unlimited.md#aws-parms), use these parameter values:
- When you [specify the stack details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms), use these parameter values:
- `IamRole`: **New**
- `IamRoleName`: the new role's name
- If you don't have permissions to create IAM resources, work with your cloud admin to use an existing role:
- Attach a policy that includes the JSON that meets your needs. See the JSON samples that follow.
- When you [specify the manager's stack details](/docs/install-ai-unlimited/prod-aws-console-ai-unlimited.md#aws-parms), use these parameter values:
- When you [specify the stack details](/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md#aws-parms), use these parameter values:
- `IamRole`: **Existing**
- `IamRoleName`: the existing role's name

**JSON samples**

If you are providing the manager's role, use the samples you need in an attached policy.

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

- If your security does not allow AI Unlimited to create roles, include [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). It includes permissions to create engine instances, but not those needed for AI Unlimited to create cluster-specific roles and policies.

:::note
If you use **ai-unlimited-without-iam-role-permissions.json**, attach [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json) to the engine role's policy.
If you use [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) for the manager's role, use [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json) for the engine's role.
:::

- Optionally, include [session-manager.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/session-manager.json): It includes permissions for the engine to interact with the [AWS Session Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager.html). Use this if you plan to use Session Manager to connect to the engine to closely manage it.
Expand All @@ -102,10 +101,10 @@ If your security does not allow AI Unlimited to create roles, provide them.
```

:::note
In the policy for the manager's role, use [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).
If you use [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json) for the engine's role, use [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) for the manager's role.
:::

- Put the role's name in the **Default IAM role** field during setup.
- When you [set up AI Unlimited](/docs/install-ai-unlimited/setup-ai-unlimited.md), put the role name in the **Default IAM role** field.



Expand Down
Loading

0 comments on commit ac444b3

Please sign in to comment.