From 50ac22dd05d7293a9c27a919aa3a0e5940ef33fc Mon Sep 17 00:00:00 2001 From: MEM4GH <118773316+MEM4GH@users.noreply.github.com> Date: Fri, 24 May 2024 12:15:00 -0400 Subject: [PATCH] removed all anchors, changed all links to headings --- docs/FAQ.md | 11 ++--- .../collaborate-project.md | 2 +- .../create-first-project.md | 14 ++---- docs/explore-and-analyze-data/get-api-key.md | 2 +- .../magic-commands.md | 4 +- docs/explore-and-analyze-data/project-flow.md | 1 + docs/glossary.md | 46 +++++-------------- docs/install-ai-unlimited/index.md | 1 - .../prod-aws-console-deploy-ai-unlimited.md | 21 +++++---- .../prod-azure-portal-deploy-manager.md | 16 +++---- .../setup-ai-unlimited.md | 14 +++--- docs/resources/jupyterlab/index.md | 4 +- .../jupyterlab/install-jupyterlab-aws.md | 17 ++++--- .../jupyterlab/install-jupyterlab-azure.md | 18 ++++---- .../jupyterlab/run-jupyterlab-docker.md | 2 + docs/whats-new/index.md | 1 + 16 files changed, 76 insertions(+), 98 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 069064522d..984612ca14 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -31,20 +31,20 @@ The [community](https://support.teradata.com/community?id=community_forum&sys_id ### What is a project? -A project is a means to explore and analyze data from a Jupyter notebook. Each project has a Git repository. +A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitHub or GitLab account. ### How do I use a project? -In a Jupyter notebook, you create a project, which automatically creates its repository. Then you authorize access to your data store, deploy the project's AI/ML engine, and run analytic workloads. You can suspend the project (and engine) anytime, then restore it, to pay only for the hours you need. +In a Jupyter notebook, you create a project, which automatically creates its Git repository. Then you authorize access to your data store, deploy the project's AI/ML engine, and run analytic workloads. You can suspend the project (and engine) anytime, then restore it, to pay only for the hours you need. ### What's my API key for? You use your API key to connect your Jupyter notebook to the AI Unlimited manager. This is the first thing you do when you open a new notebook to create or access a project. -### What's in a project repository? +### What's in a project's repository? -The project owner adds collaborators to the repository. From the repository, the next time the engine is deployed, the manager derives the users authorized to connect to and use the engine. +The project owner adds project collaborators to the Git repository. From there, the next time the engine is deployed, AI Unlimited derives the users authorized to connect to and use the engine. -But if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment. +But, if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment. :::note Each time the engine is deployed, a new password is generated for each project user. @@ -94,7 +94,6 @@ It also provides a web-based user interface from which the AI Unlimited admin se From their user profile in the manager, all users get their API key for connecting a Jupyter notebook to the manager. - :::tip Don't see your question? Ask it in the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa) ::: diff --git a/docs/explore-and-analyze-data/collaborate-project.md b/docs/explore-and-analyze-data/collaborate-project.md index b5d5b8fbd0..deb49dc0e0 100644 --- a/docs/explore-and-analyze-data/collaborate-project.md +++ b/docs/explore-and-analyze-data/collaborate-project.md @@ -19,7 +19,7 @@ A project owner might add you to a project as a collaborator. You'll need to acc ## Before you begin From the project owner, get these items: -- The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#glo-aiu-manager) +- The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#ai-unlimited-manager) - The project name From your profile, [get your API key](/docs/explore-and-analyze-data/get-api-key.md). diff --git a/docs/explore-and-analyze-data/create-first-project.md b/docs/explore-and-analyze-data/create-first-project.md index 6e9d97c6a5..39de959e1e 100644 --- a/docs/explore-and-analyze-data/create-first-project.md +++ b/docs/explore-and-analyze-data/create-first-project.md @@ -6,8 +6,8 @@ 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'; @@ -32,7 +32,7 @@ Your AI Unlimited admin is the person at your organization who set up AI Unlimit - From your admin, get these items: - - The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#glo-aiu-manager). + - The IP address or hostname of the [AI Unlimited manager](/docs/glossary.md#ai-unlimited-manager). - These environment variables: @@ -67,7 +67,6 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command 1. Connect to the manager. ```bash %workspaces_config host=, apikey=, withtls=T - ``` 2. Create the project. @@ -103,8 +102,7 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command Make sure you do not have tables named SalesCenter or SalesDemo in the selected database. Replace `Authorization_Name` and the `salescenter.csv_file_location` values in the following example with your own values. :::: - a. Create a table to store the sales center data. - + a. Create a table to store the sales center data. ```sql DROP FOREIGN TABLE SalesCenter; @@ -127,8 +125,7 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command NO PRIMARY INDEX; ``` - - b. Verify that the data was inserted. + b. Verify that the data was inserted. ```sql SELECT * FROM SalesCenter ORDER BY 1 ``` @@ -169,16 +166,13 @@ Or learn about the [magic commands](/docs/explore-and-analyze-data/magic-command ```bash %chart sales_center_name, sales, title=Sales Data ``` - f. Drop the tables. - ```sql DROP TABLE SalesCenter; DROP TABLE SalesDemo; ``` 7. Back up your project metadata and object definitions in your Git repository. - ```bash %project_backup project= ``` diff --git a/docs/explore-and-analyze-data/get-api-key.md b/docs/explore-and-analyze-data/get-api-key.md index a5b54c5b39..4e124da4b6 100644 --- a/docs/explore-and-analyze-data/get-api-key.md +++ b/docs/explore-and-analyze-data/get-api-key.md @@ -10,7 +10,7 @@ pagination_next: null # Get your API key -Each time you open a new notebook to create or access a project, you'll need your [API key.](/docs/glossary#glo-api-key) It connects your notebook to the [AI Unlimited manager](/docs/glossary#glo-aiu-manager). +Each time you open a new notebook to create or access a project, you'll need your [API key.](/docs/glossary#api-key) It connects your notebook to the [AI Unlimited manager](/docs/glossary#ai-unlimited-manager). Your API key, available from your user profile in the manager, stays the same for the lifetime of the AI Unlimited installation. diff --git a/docs/explore-and-analyze-data/magic-commands.md b/docs/explore-and-analyze-data/magic-commands.md index c4a934ac03..8a3e13d57f 100644 --- a/docs/explore-and-analyze-data/magic-commands.md +++ b/docs/explore-and-analyze-data/magic-commands.md @@ -7,6 +7,7 @@ sidebar_position: 5 pagination_prev: null pagination_next: null --- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -284,7 +285,6 @@ Started deploying. Success: Compute Engine setup, look at the connection manager ``` - ## %project_engine_suspend **Description**: Stop the engine after you're done with your work. @@ -393,6 +393,7 @@ Where: ``` Username and password of each user on the engine ``` + ## %project_engine_update_auth **Description**: Update or add new authorizations on the deployed engine without having to suspend and redeploy the engine. @@ -410,6 +411,7 @@ Where: ``` Authorizations updated ``` + ## %project_connection_add **Description**: Refresh the connection for the deployed engine. Use this command to connect to the engine from another notebook without having to create a new connection manually. diff --git a/docs/explore-and-analyze-data/project-flow.md b/docs/explore-and-analyze-data/project-flow.md index 8556229bb6..7b18af5c81 100644 --- a/docs/explore-and-analyze-data/project-flow.md +++ b/docs/explore-and-analyze-data/project-flow.md @@ -25,6 +25,7 @@ import ProjectFlowOwnerImg from './owner.svg';

+ ## Project collaborators
diff --git a/docs/glossary.md b/docs/glossary.md index ac2d072705..04d4f03b8f 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -13,17 +13,14 @@ pagination_next: null ## A - ### AI Unlimited manager -The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML [engine](#glo-engine) on your [cloud service provider](#glo-csp). It also provides a web-based user interface from which the AI Unlimited admin sets up AI Unlimited after installing it, and changes settings later as needed. From the manager, all users get their API key. +The manager is the AI Unlimited component that orchestrates the deployment of the AI/ML [engine](#engine) on your [cloud service provider](#cloud-service-provider-(csp)). It also provides a web-based user interface from which the AI Unlimited admin sets up AI Unlimited after installing it, and changes settings later as needed. From the manager, all users get their API key. - ### API key Your Application Programming Interface (API) key enables you to connect your Jupyter notebook to the manager. This is the first thing you do in a new Jupyter notebook before you create or access a project. - ### application load balancer Load balancers distribute incoming traffic across servers. An application load balancer inspects incoming traffic content, such as HTTP headers and paths, to make routing decisions. You can use an application load balancer as a way to expose AI Unlimited manager and the engine to the public IP network. @@ -31,41 +28,35 @@ Load balancers distribute incoming traffic across servers. An application load b ## C - ### Classless Inter-Domain Routing (CIDR) An IP address allocation method for data routing efficiency on the internet. Every computer that connects to the internet has a unique number called an IP address. IP addresses enable computers find each other and communicate. A CIDR block is a range of IP addresses. - ### cloud service provider (CSP) -A company that delivers computing resources over the internet, on demand. These resources can include Infrastructure as a Service (IaaS), Platform as a Service (PaaS), or Software as a Service (SaaS). The [AI Unlimited manager](#glo-manager) and [engine](#glo-engine) run on your CSP. +A company that delivers computing resources over the internet, on demand. These resources can include Infrastructure as a Service (IaaS), Platform as a Service (PaaS), or Software as a Service (SaaS). The [AI Unlimited manager](#ai-unlimited-manager) and [engine](#engine) run on your CSP. - ### cluster -A group of interconnected computers (also called nodes) that work together as a single system for enhanced processing power, scalability, and reliability. The AI Unlimited engine is deployed on a cluster on your CSP. Each node is a [virtual machine (VM)](#glo-vm). +A group of interconnected computers (also called nodes) that work together as a single system for enhanced processing power, scalability, and reliability. The AI Unlimited engine is deployed on a cluster on your CSP. Each node is a [virtual machine (VM)](#virtual-machine-(vm)). ## D - ### data lake -A central repository of data for data analytics, machine learning, and data exploration. A data lake is typically built on [object storage](#glo-object-storage) and is designed for data accessibility for future data analysis. +A central repository of data for data analytics, machine learning, and data exploration. A data lake is typically built on [object storage](#object-storage) and is designed for data accessibility for future data analysis. ## E - ### engine -In cloud computing, a compute engine is an example of Infrastructure as a Service (IaaS). It enables you to create and run [virtual machines (VMs)](#glo-vm) on your cloud service provider's infrastructure. When you deploy the AI Unlimited AI/ML compute engine from a Jupyter notebook, the [AI Unlimited manager](#glo-manager) provisions VMs. +In cloud computing, a compute engine is an example of Infrastructure as a Service (IaaS). It enables you to create and run [virtual machines (VMs)](#virtual-machine-(vm)) on your cloud service provider's infrastructure. When you deploy the AI Unlimited AI/ML compute engine from a Jupyter notebook, the [AI Unlimited manager](#ai-unlimited-manager) provisions VMs. ## I - ### IAM role An [Identity and Access Management (IAM) role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) is a role that you or a cloud admin at your organization can create in your organization's AWS account. It has one or more attached permissions policies that determine what an entity with that role can and cannot do in AWS. @@ -73,7 +64,6 @@ An [Identity and Access Management (IAM) role](https://docs.aws.amazon.com/IAM/l ## K - ### kernel A Jupyter kernel is a language-specific program that processes the code you write in a Jupyter notebook and communicates the results back to your notebook for you to see. @@ -81,7 +71,6 @@ A Jupyter kernel is a language-specific program that processes the code you writ ## L - ### load balancer A load balancer distributes incoming traffic evenly across servers, which improves performance, reliability, and scalability. If your organization does not allow its resources to use public IP addresses, you can use a load balancer to expose the AI Unlimited manager and engine to the public IP network. @@ -89,12 +78,10 @@ A load balancer distributes incoming traffic evenly across servers, which improv ## M - ### manager -See [AI Unlimited manager](#glo-aiu-manager). +See [AI Unlimited manager](#ai-unlimited-manager). - ### mounting volumes A concept in containerized platforms such as Docker. You can map a directory on the machine running the containers (the host) to a directory in a container to share data and files between the host and container. @@ -102,7 +89,6 @@ A concept in containerized platforms such as Docker. You can map a directory on ## N - ### network load balancer Load balancers distribute incoming traffic across servers. A network load balancer does not inspect traffic content. It bases routing decisions on factors such as ports and IP addresses. You can use a network load balancer as a way to expose AI Unlimited and its engine to the public IP network. @@ -110,32 +96,27 @@ Load balancers distribute incoming traffic across servers. A network load balanc ## O - ### OAuth app An OAuth app allows a user to grant access to their account on one website or service to another, without sharing their password. -An OAuth app, that you or someone at your organization creates, allows AI Unlimited to use GitHub or GitLab authentication to manage each [project repository](#glo-project-repo) and, each time the engine is deployed, derive the engine users from the collaborators that have been added to the repository. +An OAuth app, that you or someone at your organization creates, allows AI Unlimited to use GitHub or GitLab authentication to manage each [project repository](#project-repository) and, each time the engine is deployed, derive the engine users from the collaborators that have been added to the repository. - - ### object storage -A scalable, highly effective way to store large amounts of structured, semi-structured, or unstructured data in the cloud. Amazon S3 is object storage on AWS. Azure Blob Storage is object storage on Azure. Object storage is the basis for a [data lake](#glo-data-lake). +A scalable, highly effective way to store large amounts of structured, semi-structured, or unstructured data in the cloud. Amazon S3 is object storage on AWS. Azure Blob Storage is object storage on Azure. Object storage is the basis for a [data lake](#data-lake). ## P - ### project -A project is a means to explore and analyze data from a Jupyter notebook. Each project has a Git repository. +A project is a means to explore and analyze data from a Jupyter notebook. Each project has a repository in your GitHub or GitLab account. - ### project repository -The project owner adds collaborators to the repository. From the repository, the next time the engine is deployed, AI Unlimited derives the users authorized to connect to and use the engine. +The project owner adds project collaborators to the Git repository. From there, the next time the engine is deployed, AI Unlimited derives the users authorized to connect to and use the engine. -But if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment. +But, if the engine is already deployed, the project owner must update the engine to add those users so they can connect to and use the engine during that deployment. :::note Each time the engine is deployed, a new password is generated for each project user. @@ -146,7 +127,6 @@ Each time you, or another user, suspends a project, its schema is backed up in t ## S - ### systemd Linux foundational software for system and service management. The AI Unlimited manager runs on a server instance in a container controlled by systemd. @@ -154,7 +134,6 @@ Linux foundational software for system and service management. The AI Unlimited ## T - ### Transport Layer Security (TLS) A protocol that creates a secure connection between two parties communicating over the internet. TLS encrypts data during transmission, making it unreadable to anyone who intercepts it, and it verifies the identities of both parties. @@ -162,6 +141,5 @@ A protocol that creates a secure connection between two parties communicating ov ## V - ## virtual machine (VM) -A software emulation of a physical computer. Each VM operates as its own computer within a [CSP](#glo-csp)'s infrastructure. VMs enable scalability, flexibility, easier management, and a pay-as-you-go model. \ No newline at end of file +A software emulation of a physical computer. Each VM operates as its own computer within a [CSP](#cloud-service-provider-(csp))'s infrastructure. VMs enable scalability, flexibility, easier management, and a pay-as-you-go model. \ No newline at end of file diff --git a/docs/install-ai-unlimited/index.md b/docs/install-ai-unlimited/index.md index 6d7f08b989..8f800e057f 100644 --- a/docs/install-ai-unlimited/index.md +++ b/docs/install-ai-unlimited/index.md @@ -31,7 +31,6 @@ If AI Unlimited has already been installed and set up by someone at your organiz - The [AI Unlimited Jupyter Kernel](https://downloads.teradata.com/download/tools/teradata-ai-unlimited-jupyter-kernel) for managing projects in notebooks - ## Prerequisites - A pay-as-you-go AWS or Azure account on which to provision compute resources. See the requirements for your [AWS](/docs/resources/aws-requirements.md) or [Azure](/docs/resources/azure-requirements.md) account. diff --git a/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md b/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md index 0f1a04bb9a..4dad1f7615 100644 --- a/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md +++ b/docs/install-ai-unlimited/prod-aws-console-deploy-ai-unlimited.md @@ -10,11 +10,11 @@ pagination_next: null # Install the manager on AWS -Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/index.md#gs-prerequisites). +Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/index.md#prerequisites). The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for setup. -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). +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#systemd). :::tip For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa). @@ -34,12 +34,12 @@ CloudFormation templates for the manager are here in the AI Unlimited GitHub rep `deployments/aws/templates/ai-unlimited/` -Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#glo-load-balancer) and what type. +Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#load-balancer) and what type. :::note You might want to ask a cloud admin at your organization for guidance. ::: - - `ai-unlimited-with-alb.yaml`—Hosts the manager behind an [application load balancer](/docs/glossary.md#glo-alb) - - `ai-unlimited-with-nlb.yaml`—Hosts the manager behind a [network load balancer](/docs/glossary.md#glo-nlb) + - `ai-unlimited-with-alb.yaml`—Hosts the manager behind an [application load balancer](/docs/glossary.md#application-load-balancer) + - `ai-unlimited-with-nlb.yaml`—Hosts the manager behind a [network load balancer](/docs/glossary.md#network-load-balancer) - `ai-unlimited-without-lb.yaml`—No load balancer. If you're unsure about which template to use, we recommend this one. @@ -62,7 +62,7 @@ We recommend selecting the region closest to your primary work location. ## Specify stack details and options 1. Provide a stack name. -2. Review the parameters. Provide values for the required parameters. Your organization might require others.
+2. Review the parameters. Provide values for the required parameters. Your organization might require others.
@@ -113,15 +113,18 @@ The manager instance runs in a container and saves its configuration data in a d A persistent volume stores data for a containerized application beyond the lifetime of the container, pod, or node in which it runs. -#### Without a persistent volume + +**Without a persistent volume** If the container, pod, or node crashes or terminates, you lose the manager's configuration data. You can deploy a new manager instance, but not to the same state as the one that was lost. -#### With a persistent volume + +**With a persistent volume** If the container, pod, or node crashes or terminates, and the manager's configuration data is stored in a persistent volume, you can deploy a new manager instance that has the same configuration as the one that was lost. -#### Example + +**Example** 1. Deploy the manager, and include these parameters: - `UsePersistentVolume`: **New** diff --git a/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md b/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md index 359419a81a..549eec6ad3 100644 --- a/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md +++ b/docs/install-ai-unlimited/prod-azure-portal-deploy-manager.md @@ -10,11 +10,11 @@ pagination_next: null # Install the manager on Azure -Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/#gs-prerequisties). +Before you begin, make sure you have the [prerequisites](/docs/install-ai-unlimited/index.md#prerequisites). The AI Unlimited manager orchestrates the engine's deployment and includes a web-based user interface for setup. -You'll use an Azure Resource Manager (ARM) 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). +You'll use an Azure Resource Manager (ARM) 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#systemd). :::tip For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa). @@ -34,12 +34,12 @@ ARM templates for the manager are here in the AI Unlimited GitHub repository: `deployments/azure/templates/arm/ai-unlimited` -Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#glo-load-balancer) and what type. +Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#load-balancer) and what type. :::note You might want to ask a cloud admin at your organization for guidance. ::: - - `ai-unlimited-with-alb.json`—Hosts the manager behind an [application load balancer](/docs/glossary.md#glo-application-load-balancer) - - `ai-unlimited-with-nlb.json`—Hosts the manager behind a [network load balancer](/docs/glossary.md#glo-network-load-balancer) + - `ai-unlimited-with-alb.json`—Hosts the manager behind an [application load balancer](/docs/glossary.md#application-load-balancer) + - `ai-unlimited-with-nlb.json`—Hosts the manager behind a [network load balancer](/docs/glossary.md#network-load-balancer) - `ai-unlimited-without-lb.json`—No load balancer. If you're unsure about which template to use, we recommend this one. @@ -100,15 +100,15 @@ The manager instance runs in a container and saves its configuration data in a d A persistent volume stores data for a containerized application beyond the lifetime of the container, pod, or node in which it runs. -#### Without a persistent volume +**Without a persistent volume** If the container, pod, or node crashes or terminates, you lose the manager's configuration data. You can deploy a new manager instance, but not to the same state as the one that was lost. -#### With a persistent volume +**With a persistent volume** If the container, pod, or node crashes or terminates, and the manager's configuration data is stored in a persistent volume, you can deploy a new manager instance that has the same configuration as the one that was lost. -#### Example +**Example** 1. Deploy the manager, and set the `Use Persistent Volume` parameter to **New**. 2. After you create the stack, on the **Outputs** page, note the `volume-id`. diff --git a/docs/install-ai-unlimited/setup-ai-unlimited.md b/docs/install-ai-unlimited/setup-ai-unlimited.md index 26b8995776..50f2bfd2bb 100644 --- a/docs/install-ai-unlimited/setup-ai-unlimited.md +++ b/docs/install-ai-unlimited/setup-ai-unlimited.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; # Set up AI Unlimited -After you install the [manager](/docs/glossary.md#glo-manager), access the AI Unlimited setup using the URL you received at the end of the installation process: `http://[ip_or_hostname]:[port]`. +After you install the [manager](/docs/glossary.md#manager), access the AI Unlimited setup using the URL you received at the end of the installation process: `http://[ip_or_hostname]:[port]`. :::note By setting up AI Unlimited, you become the AI Unlimited admin at your organization. @@ -48,11 +48,11 @@ Select **Private** if you deploy the engine in the same Virtual Private Cloud as **Use TLS** -We recommend that you use [Transport Layer Security (TLS)](/docs/glossary.md#glo-tls) to secure connections to AI Unlimited and safeguard your data in transit. +We recommend that you use [Transport Layer Security (TLS)](/docs/glossary.md#transport-layer-security-(tls)) to secure connections to AI Unlimited and safeguard your data in transit. -- If you are using an [application load balancer (ALB)](/docs/glossary.md#glo-alb), with certification termination enabled, select **False**. +- If you are using an [application load balancer (ALB)](/docs/glossary.md#application-load-balancer), with certification termination enabled, select **False**. -- If you are using a [network load balancer (NLB)](/docs/glossary.md#glo-nlb) or no load balancer, select **True.** +- If you are using a [network load balancer (NLB)](/docs/glossary.md#network-load-balancer) or no load balancer, select **True.** - **AI Unlimited TLS certificate** and **AI Unlimited TLS certificate key**—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. @@ -80,14 +80,14 @@ Some of these fields are for default values. Later, when you deploy the engine f **Default IAM role** - The [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html) for the engine. Leave blank to let AI Unlimited create the role—if your security allows this. Otherwise, create a role using this policy: [ai-unlimited-engine.json](https://github.com/Teradata/ai-unlimited/blob/develop/deployments/aws/policies/ai-unlimited-engine.json). -- If AI Unlimited creates the role, it creates it for the AWS [cluster](/docs/glossary.md#glo-cluster) that deploys the engine—each time you deploy the engine. If your organization creates the role, it must accommodate any cluster that might deploy the engine. +- If AI Unlimited creates the role, it creates it for the AWS [cluster](/docs/glossary.md#cluster) that deploys the engine—each time you deploy the engine. If your organization creates the role, it must accommodate any cluster that might deploy the engine. **Resource tags**—You can [tag](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html) the AWS resources that deploy the engine to make them easier to manage. **Inbound security** Use these fields to allow source traffic to reach the engine: -- **Default [CIDRs](/docs/glossary.md#glo-cidr)** +- **Default [CIDRs](/docs/glossary.md#classless-inter-domain-routing-(cidr))** - **Default [security group](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-security-groups.html) IDs**—If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited security group in this field to ensure that AI Unlimited can communicate with the engine. - **Default [prefix list](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) names** @@ -123,7 +123,7 @@ Learn more about [Azure virtual networks](https://learn.microsoft.com/en-us/azur Use these fields to allow source traffic to reach the engine: -- **Default [CIDRs](/docs/glossary.md#glo-cidr)** +- **Default [CIDRs](/docs/glossary.md#classless-inter-domain-routing-(cidr))** - **Default [application security group](https://learn.microsoft.com/en-us/azure/virtual-network/application-security-groups) names**— If you deploy the engine in the same Virtual Private Cloud as AI Unlimited, include the AI Unlimited application security group in this field to ensure that AI Unlimited can communicate with the engine. diff --git a/docs/resources/jupyterlab/index.md b/docs/resources/jupyterlab/index.md index 9fe54883f3..81c44bbb01 100644 --- a/docs/resources/jupyterlab/index.md +++ b/docs/resources/jupyterlab/index.md @@ -18,7 +18,7 @@ Or, get JupyterLab with the AI Unlimited kernel now: - [Run it locally](/docs/resources/jupyterlab/run-jupyterlab-docker.md) in a Docker container :::note -The [QuickStart](/docs/resources/quickstart) includes JupyterLab. If you plan to use the QuickStart, you do not need to install JupyterLab separately. +The [QuickStart](/docs/resources/quickstart/) includes JupyterLab. If you plan to use the QuickStart, you do not need to install JupyterLab separately. ::: -Once you have JupyterLab, you can start [exploring and analyzing data](/docs/explore-and-analyze-data/index.md). +Once you have JupyterLab, you can start [exploring and analyzing data](/docs/explore-and-analyze-data/). diff --git a/docs/resources/jupyterlab/install-jupyterlab-aws.md b/docs/resources/jupyterlab/install-jupyterlab-aws.md index 2a2dc950a5..fac0697287 100644 --- a/docs/resources/jupyterlab/install-jupyterlab-aws.md +++ b/docs/resources/jupyterlab/install-jupyterlab-aws.md @@ -12,7 +12,7 @@ pagination_next: null You'll use a CloudFormation template provided by Teradata to install JupyterLab and the AI Unlimited kernel from the AWS Management Console. -This deploys a server instance, with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#glo-systemd). +This deploys a server instance, with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#systemd). :::tip For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa). @@ -26,7 +26,7 @@ References to the AWS Management Console are accurate as of April 11, 2024. - 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 the [JupyterLab template](https://github.com/Teradata/ai-unlimited/tree/develop/deployments/aws/templates/jupyter). -- If you'll need to access the JupyterLab instance, after it is installed, to run commands or debug, you can use a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) you generate to securely connect using Secure Shell (SSH). You will need the key pair when you [specify the stack details](#jup-aws-parms). +- If you'll need to access the JupyterLab instance, after it is installed, to run commands or debug, you can use a [key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) you generate to securely connect using Secure Shell (SSH). You will need the key pair when you [specify the stack details](#specify-stack-details-and-options). - If you plan to use 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: - [AWS Certificate Manager](https://docs.aws.amazon.com/acm/)—to issue a new certificate for the hosted zone ID in Route 53. @@ -46,12 +46,12 @@ CloudFormation templates for JupyterLab are here in the AI Unlimited GitHub repo `deployments/aws/templates/jupyter/` -Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#glo-load-balancer) and what type. +Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#load-balancer) and what type. :::note You might want to ask a cloud admin at your organization for guidance. ::: - - `jupyter-alb.yaml`—Hosts JupyterLab behind an [application load balancer](/docs/glossary.md#glo-application-load-balancer) - - `jupyter-with-nlb.yaml`—Hosts JupyterLab behind a [network load balancer](/docs/glossary.md#glo-network-load-balancer) + - `jupyter-alb.yaml`—Hosts JupyterLab behind an [application load balancer](/docs/glossary.md#application-load-balancer) + - `jupyter-with-nlb.yaml`—Hosts JupyterLab behind a [network load balancer](/docs/glossary.md#network-load-balancer) - `jupyter-without-lb.yaml`—No load balancer @@ -65,7 +65,6 @@ You might want to ask a cloud admin at your organization for guidance. 6. Select the template file you chose to use, and click **Next**. - ## Specify stack details and options 1. Provide a stack name. @@ -111,15 +110,15 @@ The JupyterLab instance runs in a container and saves its configuration data in But a persistent volume stores data for a containerized application beyond the lifetime of the container, pod, or node in which it runs. -#### Without a persistent volume +**Without a persistent volume** If the container, pod, or node crashes or terminates, you lose the JupyterLab configuration data. You can deploy a new JupyterLab instance, but not to the same state as the one that was lost. -#### With a persistent volume +**With a persistent volume** If the container, pod, or node crashes or terminates, and the JupyterLab configuration data is stored in a persistent volume, you can deploy a new JupyterLab instance that has the same configuration as the one that was lost. -#### Example +**Example** 1. Deploy JupyterLab, and include these parameters: - `UsePersistentVolume`: **New** diff --git a/docs/resources/jupyterlab/install-jupyterlab-azure.md b/docs/resources/jupyterlab/install-jupyterlab-azure.md index 0082c85bb8..d2dacd0df9 100644 --- a/docs/resources/jupyterlab/install-jupyterlab-azure.md +++ b/docs/resources/jupyterlab/install-jupyterlab-azure.md @@ -12,7 +12,7 @@ pagination_next: null You'll use an Azure Resource Manager (ARM) template provided by Teradata to install JupyterLab, and the AI Unlimited kernel, from the Azure Portal. -This deploys a server instance, with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#glo-systemd). +This deploys a server instance, with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#systemd). :::tip For installation support, ask the [community](https://support.teradata.com/community?id=community_forum&sys_id=b0aba91597c329d0e6d2bd8c1253affa). @@ -29,7 +29,7 @@ References to the Azure Portal are accurate as of April 14, 2024. - Networking requirements: Your Azure [resource group](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal) must have an [Azure Virtual Network (VNet)](https://learn.microsoft.com/en-us/azure/virtual-network/quick-create-portal) configured with a [subnet](https://learn.microsoft.com/en-us/azure/virtual-network/virtual-network-manage-subnet?tabs=azure-portal). Use an existing VNet or subnet, or create your own, depending on your account permissions. -- If you'll need to access the JupyterLab instance, after it is installed, to run commands or debug, you can use a [key pair](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys) that you generate to securely connect using Secure Shell (SSH). You'll need the key pair when you [specify the instance details](#jup-azure-parms). +- If you'll need to access the JupyterLab instance, after it is installed, to run commands or debug, you can use a [key pair](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys) that you generate to securely connect using Secure Shell (SSH). You'll need the key pair when you [specify the instance details](#specify-instance-details). ## Clone the repository @@ -45,12 +45,12 @@ ARM templates for JupyterLab are here in the AI Unlimited GitHub repository: `deployments/azure/templates/arm/jupyter/` -Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#glo-load-balancer) and what type. +Choose a template based on whether you intend to use a [load balancer](/docs/glossary.md#load-balancer) and what type. :::note You might want to ask a cloud admin at your organization for guidance. ::: - - `jupyter-with-alb.json`—Hosts JupyterLab behind an [application load balancer](/docs/glossary.md#glo-application-load-balancer) - - `jupyter-with-nlb.json`—Hosts JupyterLab behind a [network load balancer](/docs/glossary.md#glo-network-load-balancer) + - `jupyter-with-alb.json`—Hosts JupyterLab behind an [application load balancer](/docs/glossary.md#application-load-balancer) + - `jupyter-with-nlb.json`—Hosts JupyterLab behind a [network load balancer](/docs/glossary.md#network-load-balancer) - `jupyter-without-lb.json`—No load balancer ## Load the template @@ -61,7 +61,6 @@ You might want to ask a cloud admin at your organization for guidance. 4. Select the template file you chose to use, and select **Save**. - ## Specify instance details Review the parameters. Provide values for the required ones. Your organization might require others. @@ -103,15 +102,15 @@ The JupyterLab instance runs in a container and saves its configuration data in But a persistent volume stores data for a containerized application beyond the lifetime of the container, pod, or node in which it runs. -#### Without a persistent volume +**Without a persistent volume** If the container, pod, or node crashes or terminates, you lose the JupyterLab configuration data. You can deploy a new JupyterLab instance, but not to the same state as the one that was lost. -#### With a persistent volume +**With a persistent volume** If the container, pod, or node crashes or terminates, and the JupyterLab configuration data is stored in a persistent volume, you can deploy a new JupyterLab instance that has the same configuration as the one that was lost. -#### Example +**Example** 1. Deploy JupyterLab, and include these parameters: - `UsePersistentVolume`: **New** @@ -125,6 +124,7 @@ The new JupyterLab instance has the same configuration as the one that was lost.
+ ## Create the instance 1. Select **Review + create**. diff --git a/docs/resources/jupyterlab/run-jupyterlab-docker.md b/docs/resources/jupyterlab/run-jupyterlab-docker.md index 4c21b0438f..7443b45fb3 100644 --- a/docs/resources/jupyterlab/run-jupyterlab-docker.md +++ b/docs/resources/jupyterlab/run-jupyterlab-docker.md @@ -11,6 +11,7 @@ pagination_next: null import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; + # Run JupyterLab locally using Docker You'll use [Docker Compose](https://docs.docker.com/compose/) to run JupyterLab, with the AI Unlimited Jupyter Kernel, locally in a container. @@ -67,6 +68,7 @@ Clone the repository. docker logs | grep 'Token' ``` + ## Verify access to JupyterLab When JupyterLab is ready, you can access it at `http://localhost:8888`, and enter the token. diff --git a/docs/whats-new/index.md b/docs/whats-new/index.md index 49cd83ed70..d25b4a511f 100644 --- a/docs/whats-new/index.md +++ b/docs/whats-new/index.md @@ -42,6 +42,7 @@ Includes everything you need to start exploring, analyzing, and experimenting: See the [release notes](/docs/release-notes.md) for known issue and features not currently supported. ::: + ## What's coming **(3. OK to include anticipated month?)**