From 925fea38ac407a836983eb8a7c219ce49fcaba43 Mon Sep 17 00:00:00 2001 From: Aravind-21-Test <116723181+Aravind-21-Test@users.noreply.github.com> Date: Wed, 8 May 2024 20:25:17 +0530 Subject: [PATCH] Removed temp files --- .../aws-cli-deploy-jupyter.md | 113 ---------------- .../azure-cli-deploy-jupyter.md | 12 -- .../quickstart_a/docker-setup-a.md | 128 ------------------ 3 files changed, 253 deletions(-) delete mode 100644 docs/temp-folder/install-jupyter-cli/aws-cli-deploy-jupyter.md delete mode 100644 docs/temp-folder/install-jupyter-cli/azure-cli-deploy-jupyter.md delete mode 100644 docs/temp-folder/quickstart_a/docker-setup-a.md diff --git a/docs/temp-folder/install-jupyter-cli/aws-cli-deploy-jupyter.md b/docs/temp-folder/install-jupyter-cli/aws-cli-deploy-jupyter.md deleted file mode 100644 index 57b5fc79e7..0000000000 --- a/docs/temp-folder/install-jupyter-cli/aws-cli-deploy-jupyter.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -id: aws-cli-deploy-jupyter -title: Deploy JupyterLab from the AWS CLI -description: Learn how to deploy JupyterLab using the AWS Cloudformation template from the AWS CLI. -sidebar_label: AWS CLI -sidebar_position: 2 ---- - -# Deploy the template from the AWS CLI - -***Maybe we'll use more partials. Not sure yet.*** - -The CloudFormation template deploys a server instance with JupyterLab running in a container controlled by [systemd](/docs/glossary.md#glo-systemd). - - -## Decide which template to use - - -## New section? - -The Jupyter template's parameter file is here: '/deployments/aws/parameters/'. - -***Do they add/change values to the parm JSON file? Seems like we need a section for the parms, like what's in the console topic - we could use a partial that works for the console Jupyter topic and this CLI Jupyter topic.*** - -***Related... the console topic tells them they can configure stack options. How do they set those options if they use the CLI? Looks like that's "tags" and "capabilities" in the code below. Maybe link to AWS doc about that? Compare that part of the AWS console to what's in the code here. For the console do we need to point out anything in particular on the UI page that follows the parms?*** - - -## Create a stack - -:::note -You can deploy the stack using the `aws cloudformation create-stack` or `aws cloudformation deploy` commands. This example uses `aws cloudformation create-stack`. See [AWS CLI Command Reference](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/#cli-aws-cloudformation) for the syntax differences. -::: - -Run the command that matches the template you're using: - -***The user has already cloned the repo. For the CLI (not the concole), seems they can reference the local template file and don't need to download it. Maybe we need to include the paths to the template and parm files starting with /deployments/ in the code below? How does this work?*** - -```bash - # Create the stack using jupyter-with-alb.yaml -aws cloudformation create-stack --stack-name jupyter-with-alb \ - --template-body file://templates/jupyter-with-alb.yaml \ - --parameters file://parameters/jupyter-with-alb.json \ - --tags AnotherKey=AnotherValue \ - --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM -``` - -```bash - # Create the stack using jupyter-with-nlb.yaml -aws cloudformation create-stack --stack-name jupyter-with-nlb \ - --template-body file://templates/jupyter-with-nlb.yaml \ - --parameters file://parameters/jupyter-with-nlb.json \ - --tags AnotherKey=AnotherValue \ - --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM -``` - -```bash - # Create the stack using jupyter-without-lb.yaml -aws cloudformation create-stack --stack-name jupyter-without-lb \ - --template-body file://templates/jupyter-without-lb.yaml \ - --parameters file://parameters/jupyter-without-lb.json \ - --tags AnotherKey=AnotherValue \ - --capabilities CAPABILITY_IAM CAPABILITY_NAMED_IAM -``` - - -:::note -- CAPABILITY_IAM is required if IamRole is set to New. -- CAPABILITY_NAMED_IAM is required if IamRole is set to New and IamRoleName is given a value. -::: - -To use an existing role, see Control AWS Access and Permissions using Permissions and Policies. ***Is this to be an external link--or our topic that's WIP?*** - - -## Delete a stack - -***Let's remove. This topic is for installing. If they want to eventually remove the stack, as CLI users maybe they know how to run "delete-stack"? Maybe originally this topic was a reference, not an installation task topic.*** - -Run this command: - -```bash -aws cloudformation delete-stack --stack-name -``` - -## Get stack information - -***Can we tell them what sort of information or why they do this? Is this something they normally do after creating a stack?*** - -***Delete-stack is in the first line of code--probably there by mistake.*** - -***The second one is also in the last section.*** - -Run this command: - -```bash -aws cloudformation delete-stack --stack-name -aws cloudformation describe-stacks --stack-name -aws cloudformation describe-stack-events --stack-name -aws cloudformation describe-stack-instance --stack-name -aws cloudformation describe-stack-resource --stack-name -aws cloudformation describe-stack-resources --stack-name -``` - -## Get stack outputs - -Run this command: - -```bash -aws cloudformation describe-stacks --stack-name --query 'Stacks[0].Outputs' --output table -``` - -***Tell them how to access JupyterLab. - -***Do they get that from "describe-stacks"?*** \ No newline at end of file diff --git a/docs/temp-folder/install-jupyter-cli/azure-cli-deploy-jupyter.md b/docs/temp-folder/install-jupyter-cli/azure-cli-deploy-jupyter.md deleted file mode 100644 index 1ea1c94390..0000000000 --- a/docs/temp-folder/install-jupyter-cli/azure-cli-deploy-jupyter.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: azure-cli-deploy-jupyter -title: Deploy JupyterLab from the Azure CLI -description: Learn how to deploy JupyterLab from the Azure CLI using the ARM template. -sidebar_label: Azure CLI -sidebar_position: 2 ---- - -# Deploy the template from the Azure CLI - -[placeholder] - diff --git a/docs/temp-folder/quickstart_a/docker-setup-a.md b/docs/temp-folder/quickstart_a/docker-setup-a.md deleted file mode 100644 index 19c639d4e7..0000000000 --- a/docs/temp-folder/quickstart_a/docker-setup-a.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -id: test-quickstart-setup -title: QuickStart - Setup -description: Get more information about certain fields in the setup. -sidebar_label: Test-Set up AI Unlimited -sidebar_position: 5 ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Set up AI Unlimited - -:::note -Before you start, make sure you have all the necessary details to update the cloud integration section. You must have the minimum configuration values, including **Default region**, **Default subnet**, and **Default security groups**. If you are unsure, Teradata recommends reaching out to your cloud administrator for guidance. -::: - -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 [full](/docs/install-ai-unlimited/production/index.md) installation) - -Are you an AI Unlimited user or administrator? Choose your path: ***This topic (which will be for both the QS and the full install) is meant only for the user doing the installation. For the QuickStart, that user is also a general user. For the full installation, that is less likely to be the case. But either way, it's in the installation flow--so should not descibe the other uses. There will be other topics for an admin to change settings under "manage" in the TOC, and for a general user to get their API key (under "explore and analyze data" in the TOC.*** - -- If you're an AI Unlimited user, AI Unlimited is set up and ready to use. Authorize using your Git provider credentials. This authorizes the AI Unlimited to authenticate the user and access your Git repo. Copy the API Key [Glossary] from your **Profile** page and then proceed to [running your first workload](/docs/explore-and-analyze-data/example-projects.md) on AI Unlimited. - -- If you're an AI Unlimited administrator, complete the setup. To learn more about specific fields, click a section below. - -- If you're a returning AI Unlimited administrator looking to modify the setup information, authorize using your GitHub credentials and select **SETUP**. - - -
- -Step 1: The basics - -* **Service base URL**: The root URL of the service. This value determines the URL you’ll be redirected to after successful Git authorization and varies depending on the type of installation. - - * QuickStart: - * Demo or Full install: - -* **Git provider**: The Git provider used to store project details. -* **Service log levels**: Defines the level of detail recorded in the log files. The default is **Info**; however, Teradata recommends selecting **Debug**. This option captures fine-grained informational events that could help you debug errors. - -* **Engine IP network type**: The type of network assigned to an engine instance that would allow AI Unlimited to communicate with the engine. Select **Private** if you're deploying the engine in the same VPC as AI Unlimited. Select **Public** if AI Unlimited is running on a local container. - -* **Use TLS**: Indicates if [Transport Layer Security (TLS)](/docs/glossary.md#glo-tls) support is enabled to secure communication to AI Unlimited. If you use a self-hosted AI Unlimited instance without a load balancer, Teradata recommends setting this option to **True** and uploading or generating TLS certificates. For enterprise users employing a load balancer, set this option to **False**, as the load balancer manages TLS 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. You can also select **GENERATE TLS** to use a Teradata system-generated certificate. It automatically renews before it expires. - -After you've filled in all the details, select **Update**. - -
- -
- -Step 2: Cloud integration -:::note -You can modify these parameters directly from the Jupyter notebook while connecting to the AI Unlimited engine. -::: - - - - -- **Default region**: The region where you want to deploy the engine. Teradata recommends choosing the region closest to your primary work location. -- **Default subnet**: The subnet that provides the engine instance with a route to an internet gateway. If you don't specify a subnet, the engine is automatically associated with the default subnet. -- **Default IAM role**: The default IAM identity that provides the required permissions to deploy the engine instance. When a default IAM role is assigned to a user or resource, the user or resource automatically assumes the role and gains the permissions granted to the 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—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. -- **Resource tags**: The key-value pair applied to a resource to hold metadata about that resource. With a resource tag, you can quickly identify, organize, and manage the AI Unlimited resources you use in your environment. -- **Default CIDRs**: The list of Classless Inter-Domain Routing (CIDR) network addresses that can be allocated to the engine. Use CIDR to allocate IP addresses flexibly and efficiently in your network. If you don't specify a CIDR, the engine is automatically associated with the default CIDR. -- **Default security groups**: The list of security groups for the VPC in each region. Security group is a virtual firewall that contains rules to monitor and filter the incoming and outgoing traffic for the VPC in each region. If you don't specify a security group, the engine is automatically associated with the default security group for the VPC. If you're deploying AI Unlimited using the CloudFormation template or ARM template, make sure the default security group is the same as the one in the template to ensure AI Unlimited can communicate with the AI Unlimited engine. -- **Role Prefix**: The string of characters prepended to the name of a role. You can use a role prefix to organize and manage roles and to enforce naming conventions. -- **Permission Boundary**: The maximum permissions an IAM entity can have regardless of the permissions defined in the identity-based policy. You can define and manage the user permissions and roles and enforce compliance requirements. - -After you've filled-in all the details, select **Update**. - - - - -- **Default region**: A single Azure environment corresponds to a single VNet located in a specific region, and all the resources deployed by AI Unlimited on Azure are deployed into that VNet. Teradata recommends selecting a region closest to your primary work location or the region where your data is located. -- **Default CIDRs**: The address range to define the range of private IPs for VM instances provisioned into the subnets. The CIDR range must be between /16 and /24. The default is 10.0.0.0/16, however you can modify the value based on your organizational policy. -- **Default security group**: Controls inbound and outbound traffic to and from Azure resources within a specified network. Use this field to allow users from your organization access to the resources. -- **Resource tags**: The key-value pair that helps you identify resources based on settings that are relevant to your organization. Use the ai-unlimited tag to quickly identify, organize, and manage the resources you use in your environment. - -After you've filled in all the details, select **Update**. - - - - -
- -
- -Step 3: Git integration - -- **Application URL**: The default URL of your Git provider account. If you're using an Enterprise account, Teradata recommends updating this value to match your hosted private URL by modifying the **Base URL**. - -- **Callback URL**: The URL to redirect to after you authorize using the Git provider. - -- **Base URL**: The base URL of your Git provider account. The URL may vary based on your account type. For example, https://github.company.com/ for a GitHub Enterprise account. To change the **Application URL**, update this value. - -- **Client ID**: The Client ID you received from the Git provider on creating your OAuth App. - -- **Client Secret**: The Client secret ID you received from the Git provider on creating your OAuth App. - -** Configure GitHub Organization Access** - - - - -- **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. - - - - - -- **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. - - - - -Select **Update** and then **Login**. -
- -If you're an AI Unlimited administrator, go to the **Profile** page to copy your API Key. If you've enabled TLS, select **Restart** to restart the service and apply the changes.