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

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
MEM4GH committed Apr 3, 2024
1 parent 909aef6 commit 5561421
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 8 deletions.
9 changes: 3 additions & 6 deletions docs/_partials/_setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Access AI Unlimited setup:

- `http://localhost:3000` (if you are using the [QuickStart](/docs/install-ai-unlimited/quickstart/index.md))

- `http://[ip_or_hostname]:[port]` (for a [demo](/docs/install-ai-unlimited/demo/index.md) or [full](/docs/install-ai-unlimited/production/index.md) installation)
- `http://[ip_or_hostname]:[port]` (if you are using the [full](/docs/install-ai-unlimited/production/index.md) installation)

Complete the setup in AI Unlimited. To learn more about certain fields, click a section below.

Expand Down Expand Up @@ -39,9 +39,8 @@ AI Unlimited uses the OAuth app you, or someone at your organization, created to

Selecting **Authenticate** establishes the access and returns you to AI Unlimited to complete the setup.

[Create a Git OAuth app](/docs/install-ai-unlimited/quickstart/create-github-oauth-app) (QuickStart)\
[Create a Git OAuth app](/docs/install-ai-unlimited/demo) (Demo installation)\
[Create a Git OAuth app](/docs/install-ai-unlimited/production) (Production installation)
[Create an OAuth app](/docs/install-ai-unlimited/quickstart/before-you-begin/docker-create-oauth-app.md) (QuickStart)
[Create an OAuth app] ***add link*** (Full)

</details>

Expand All @@ -63,8 +62,6 @@ Public or Private refers to how AI Unlimited should communicate with the engine.

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.

See **Create an IAM role and policies** in your installation workflow: [QuickStart], [Demo](/docs/install-ai-unlimited/demo/AWS/demo-aws-permissions-policies.md), or [Full](/docs/install-ai-unlimited/production/AWS/full-aws-permissions-policies).

***(We don't have a role/policies topic for the QS. No cloud template is needed for this install type. But shouldn't the QS include creating the role so the user can put it in the setup UI? For demo and full, the user puts it in the cloud template and in the setup UI. For the QS, the user just puts it in the setup UI. Unless there are 2 different roles?)***

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Contact your organization administrator if your account doesn’t have the requi

***The content on the tabs is currently a mix of named requirements and actions to take--at least on each tab, we should have parallel types of items, meaning, a list of things they need or a list of things to do.***

- Your AWS account must have sufficient IAM permissions to create IAM roles or IAM policies. See [Control AWS access and permissions using custom permissions and policies](../../production/AWS/aws-permissions-policies.md).
- Your AWS account must have sufficient IAM permissions to create IAM roles or IAM policies. See [Control AWS access and permissions using custom permissions and policies](../../production/AWS/prod-aws-permissions-policies.md).

- In your AWS console, choose the AWS region where you want to deploy AI Unlimited.

***This assumes they are in AWS. They might be, or they might not be. Depending on when they created their account or got access to an existing account. And they might have left their account, talked with someone about permissions, and then come back to this content the next day--anything like that. So we should add something like "In your AWS account," I almost wonder if it's enough to say "In your AWS account, select the region."? I hate to use terms like "navigation bar" and "region selector"--sounds more internal, like a UI design discussion. But... is it hard to find this in the UI?***

- If you need access to your AI Unlimited instance host operating system (OS), you can connect in the following ways:
- Generate a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) to securely connect to your AI Unlimited instance using Secure Shell (SSH) after it launches.
- Use AWS Session Manager to connect to the AI Unlimited instance. In this case, you must attach the [session-manager.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/session-manager.json) policy to the IAM role. See [Control AWS access and permissions using custom permissions and policies](/docs/install-ai-unlimited/production/AWS/aws-permissions-policies.md).
- Use AWS Session Manager to connect to the AI Unlimited instance. In this case, you must attach the [session-manager.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/session-manager.json) policy to the IAM role. See [Control AWS access and permissions using custom permissions and policies](/docs/install-ai-unlimited/production/AWS/prod-aws-permissions-policies.md).

***Sounds like they have 3 choices: key pair, session manager, or neither. We could say something like “If you (precisely who, their organization?) require host operating system (OS) access (Why would they or wouldn’t they need this? Something to do with using the CLI?) **TA: to manage the instance**, set up your connection one of these ways:” Then a bullet for key pair, and a bullet for session manager. (This way, they decide whether or not they need this at the beginning.)***

Expand Down

0 comments on commit 5561421

Please sign in to comment.