From 8ff1a0c1724a8bdcdd4ff007cf9e3ba6027022fc Mon Sep 17 00:00:00 2001 From: MEM4GH <118773316+MEM4GH@users.noreply.github.com> Date: Mon, 13 May 2024 21:50:46 -0400 Subject: [PATCH] Done with Create first project --- .../create-first-project.md | 19 ++++++++----------- docs/resources/aws-requirements.md | 12 ++++++------ 2 files changed, 14 insertions(+), 17 deletions(-) diff --git a/docs/explore-and-analyze-data/create-first-project.md b/docs/explore-and-analyze-data/create-first-project.md index 97c67739c7..8fefb95d54 100644 --- a/docs/explore-and-analyze-data/create-first-project.md +++ b/docs/explore-and-analyze-data/create-first-project.md @@ -26,7 +26,7 @@ Your AI Unlimited admin is the person at your organization who set up AI Unlimit - From your admin, get these items: - - The URL for the AI Unlimited manager. + - The IP address or host name of the [AI Unlimited manager](/docs/glossary.md#glo-manager). - These environment variables: @@ -51,12 +51,12 @@ If you don't yet have JupyterLab or the AI Unlimited kernel, see [JupyterLab ins ## Connect, and run your first workload :::tip -Run `%help` for details on all magic commands. Run `%help ` for details on any one of them. +Run `%help` for details on all magic commands. Run `%help ` for details on 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). +1. Configure the connection to the engine. ```bash %workspaces_config host=, apikey=, withtls=T ``` @@ -66,18 +66,17 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command %project_create project=, env=, team= ``` -3. Create an object store authorization to store the [CSP](/docs/glossary.md#glo-cloud-service-provider) credentials. +3. Create an object store authorization to store the cloud service provider credentials. Replace `ACCESS_KEY_ID`, `SECRET_ACCESS_KEY`, and `REGION` with your values. ```bash %project_auth_create name=, project=, key=, secret=, region= ``` - ***These look like AWS. Do AWS-Azure tabs?*** - + 4. Deploy the engine. - Replace the `Project_Name`. ***(didn't they already name it?)*** The size can be small, medium, large, or extralarge. The default is small. + Replace `Project_Name`. The size can be small, medium, large, or extralarge. The default is small. ```bash %project_engine_deploy name=, size= ``` @@ -86,12 +85,12 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command ```bash %connect ``` - When the connection is made, provide the generated password. ***how?*** + When the connection is made, provide the generated password. 7. Run the sample workload. :::note - Make sure you do not have tables named SalesCenter or SalesDemo in the selected database. Replace auth1 and location values in the following example with your own. + Make sure you do not have tables named SalesCenter or SalesDemo in the selected database. Replace auth1 and the location values in the following example with your own values. :::: a. Create a table to store the sales center data. @@ -169,8 +168,6 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command 8. Back up your project metadata and object definitions in your Git repository. - ***Is "metadata" too ENG-ish for a new data scientist? Should we say "data object definitions"?*** - ```bash %project_backup project= ``` diff --git a/docs/resources/aws-requirements.md b/docs/resources/aws-requirements.md index 5f5bde90ca..e265c1cd09 100644 --- a/docs/resources/aws-requirements.md +++ b/docs/resources/aws-requirements.md @@ -29,13 +29,13 @@ The manager needs a role that allows it to deploy the engine. The engine needs a 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 for the manager** +### Role for the manager To let AI 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 for the engine** +### Role for the engine AI Unlimited can create a new role for the engine each time the engine is deployed. @@ -54,7 +54,7 @@ To allow AI Unlimited to create a new role for each engine deployment, when you If your security does not allow AI Unlimited to create roles, provide them. -**Provide the manager's role** +### Role for the manager - 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. @@ -67,9 +67,9 @@ If your security does not allow AI Unlimited to create roles, provide them. - `IamRole`: **Existing** - `IamRoleName`: the existing role's name -**JSON samples** +#### JSON samples -If you are providing the manager's role, use the samples you need in an attached policy. +Use these samples, as needed, in a policy attached to the manager's role: - 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. @@ -82,7 +82,7 @@ If you are providing the manager's role, use the samples you need in an attached - 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. -**Provide the engine's role** +### Role for the engine - To the role you provide for the engine, attach a policy that includes [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json). This allows AI Unlimited to pass the role to the cluster each time the engine is deployed.