Skip to content

Commit

Permalink
Removed WSL mentions.
Browse files Browse the repository at this point in the history
  • Loading branch information
saimachi committed Feb 26, 2024
1 parent 9d0a412 commit eb910a1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
16 changes: 13 additions & 3 deletions deploy/starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

## Dependencies

Mac and Linux users can install the following dependencies locally to run the deployment. Windows users should use Ubuntu on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to run all deployment steps. Other WSL Linux distributions may work, but these instructions have been validated with Ubuntu 18.04, 20.04, and 22.04.
Please install the following dependencies to deploy FLLM.

- [PowerShell 7](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4) (required for `pwsh` to work in the AZD hooks as an alias to powershell)
- [azd CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd)
- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)
- [jq](https://jqlang.github.io/jq/download/)
Expand All @@ -25,7 +26,7 @@ Clone the FoundationaLLM repository
git clone -b release/0.4.0 https://github.com/solliancenet/foundationallm
```

Run the following commands to set the appropriate application registration settings for OIDC authentication. **Windows users should run them in WSL.**
Run the following commands to set the appropriate application registration settings for OIDC authentication.

```bash
cd foundationallm
Expand Down Expand Up @@ -60,12 +61,21 @@ azd env set ENTRA_VECTORIZATION_API_TENANT_ID <Vectorization API Tenant ID>
azd env set FOUNDATIONALLM_INSTANCE_ID <guid>
```

>**Note:** You need to manually generate a GUID for your instance ID.
>[!NOTE]
> You need to manually generate a GUID for `FOUNDATIONALLM_INSTANCE_ID`.
Bash:

```bash
uuidgen
```

PowerShell:

```powershell
[guid]::NewGuid().ToString()
```

After setting the OIDC-specific settings in the AZD environment above, run `azd up` in the same folder location to build the Docker images, provision the infrastructure, update the App Configuration entries, deploy the API and web app services, and import files into the storage account.

```bash
Expand Down
19 changes: 13 additions & 6 deletions docs/deployment/deployment-starter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Foundationa**LLM** deploys into your own Azure Subscription. By default, it will
- Docker Desktop.
- Azure CLI ([v2.51.0 or greater](https://docs.microsoft.com/cli/azure/install-azure-cli)).
- Azure Developer CLI ([v1.6.1 or greater](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd))
- Powershell 7 ([7.4.1 or greater](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4))
- PowerShell 7 ([7.4.1 or greater](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4))
> Note: Powershell 7 is required for `pwsh` to work in the AZD hooks as an alias to `powershell`
- Visual Studio 2022 (only needed if you plan to run/debug the solution locally).
- Minimum quota of 65 CPUs across all VM family types. Start here to [Manage VM Quotas](https://learn.microsoft.com/azure/quotas/per-vm-quota-requests).
Expand All @@ -35,9 +35,7 @@ Follow the steps below to deploy the solution to your Azure subscription. You wi
git clone -b release/0.4.0 https://github.com/solliancenet/foundationallm.git
```
3. **Windows users should use Ubuntu in WSL, opened in the `foundationallm` directory, for the following steps; Mac and Linux users can follow them locally.**
Run the following commands to set the appropriate application registration settings for OIDC authentication. Please refer to the instructions on the [authentication setup page](authentication/index.md) to configure authentication for the solution and obtain the appropriate client Ids, scopes, and tenant Ids for the following steps.
3. Run the following commands to set the appropriate application registration settings for OIDC authentication. Please refer to the instructions on the [authentication setup page](authentication/index.md) to configure authentication for the solution and obtain the appropriate client Ids, scopes, and tenant Ids for the following steps.
```bash
cd deploy/starter
Expand Down Expand Up @@ -71,12 +69,21 @@ Follow the steps below to deploy the solution to your Azure subscription. You wi
azd env set FOUNDATIONALLM_INSTANCE_ID <guid>
```
>**Note:** You need to manually generate a GUID for `FOUNDATIONALLM_INSTANCE_ID`.
>[!NOTE]
> You need to manually generate a GUID for `FOUNDATIONALLM_INSTANCE_ID`.
Bash:
```bash
uuidgen
```
PowerShell:
```powershell
[guid]::NewGuid().ToString()
```
After setting the OIDC-specific settings in the AZD environment above, run `azd up` in the same folder location to build the Docker images, provision the infrastructure, update the App Configuration entries, deploy the API and web app services, and import files into the storage account.
```bash
Expand All @@ -89,7 +96,7 @@ Follow the instructions on the [authentication setup page](authentication/index.
## Update APIs and portals from local code changes
To update all APIs and portals from local code changes, run the following from the `./deploy/starter` folder in your locally cloned repository. Again, Windows users should use WSL.
To update all APIs and portals from local code changes, run the following from the `./deploy/starter` folder in your locally cloned repository.
```bash
azd deploy
Expand Down

0 comments on commit eb910a1

Please sign in to comment.