Aller au contenu principal

Before you begin

Once you have the prerequisites, prepare for the installation.

Clone the repo​

Clone the AI Unlimited GitHub repository. The deployments folder in the repository contains template, parameter, and policy files for installing AI Unlimited.

Open a terminal window, and clone the repository.

Prepare your Azure account​

Work with your admin to prepare your Azure account.

  • Azure account requirements

    • Rights (Permissions?) to create Azure resources. Make sure the account deploying AI Unlimited has sufficient permissions to create the roles.

    Is "the account" the user who's reading this or the Azure account's ability to allow the installation of the AI Unlimited service?

    • Owner permissions on the Azure subscription that you would like to use.

  • Networking requirements

    • The resource group must have an Azure Virtual Network (VNet) configured with a subnet. You can use your existing VNet and subnets or create your own Resource Group, Vnet, Subnet, and role depending on your account permissions.

  • Secure shell (SSH) key pair to access or manage the AI Unlimited instance for running commands or debugging.

    Generate a key pair to securely connect to the AI Unlimited instance ("engine"?) using SSH.

For Azure, do we need equivalent content that's in AWS for 1. how to be able to more closely manage the engine and 2. load balancers? TA: Load balancer template options are not available for Azure, so Will wait for input from Jack

TA: For AWS, Jack had mentioned Route53 for DNS, for Azure, not sure.

Create a role with the required permissions​

If the roles defined by your organization cannot deploy AI Unlimited (needs better wording--roles don't deploy), use the role-policy ARM template. This template contains permissions to create an AI Unlimited instance and grants AI Unlimited permissions to create specific IAM [RBAC?] roles and policies for the AI Unlimited engines it deploys. Optionally, you can share the ai-unlimited file with your organization administrator to create the custom role on your behalf. This file contains the subscription-level permissions required for AI Unlimited to deploy AI Unlimited engine instances within your resource groups.

Need to look at the template - any readme.

If you have the permissions needed to create roles, configure the custom roles and policies on the Access control (IAM) page (AWS term) from the Azure portal.

To deploy the role-policy ARM template, do the following: This is "documenting a third-party UI" which we are not really supposed to do.

  1. Sign in your Azure portal and select the deploy a custom template option.

  2. Select Build your own template in the editor and load the role-policy template.

  3. When the file contents appear in the editor, select Save.

  4. On the Custom deployment page, fill in the details in the following fields:

    • Subscription: The Azure subscription that you want to use.

    • Region: The geographic location where you can deploy your resources. Use the location that’s closest to your working location.

    • Name: The name for the role for use with the AI Unlimited instance.

  5. Select Review + Create, and then Create. The template proceeds to deploy a simple network in a few minutes.

You can view the deployment status in Notifications.

The Output tab shows the network names and RoleDefinitionId. You'll need these when you install AI Unlimited.

Create a GitHub or GitLab OAuth app​

Create an OAuth app so that AI Unlimited can authorize your GitHub or GitLab account to store user and project information.

  1. Sign in to your Git repository.

  2. Create an OAuth app. See GitHub: Create an OAuth app or GitLab: Create an OAuth app.

    While registering the OAuth app, use these URLs.

    • Homepage URL:

      • If you are using the QuickStart, http://localhost:3000

      • For a demo or full installation, http://[ip_or_hostname]:[port]

    • Authorization callback URL: [Homepage URL]/auth/github/callback

    For GitLab, select the appropriate OAuth Scopes as defined in Authorized Applications.

  3. Copy and retain the Client ID and Client secret. You'll use them to authorize AI Unlimited to save user and project information.

Get deployment details​

When you install the manager using an Azure Resource Manager (ARM) template, and you'll provide network and security details.

You can copy this template to get these details from an admin. Or, get them from the Azure Portal.

These are the required parms, but the customer's org may require more. Can't put a table (of the full set) in a code block.

I also see "Public Key" (would go after Region) and "Role Definition Id" (would be last). There's a slack comment.

Subscribe to AI Unlimited​

Subscribe on the Azure Marketplace. replace w/link to listing.

Then return to this documentation site to set up AI Unlimited.