Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions content/patterns/rag-llm-gitops/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ aliases: /rag-llm-gitops/getting-started/
## Prerequisites

- Podman is installed on your system.
- You have the OpenShift Container Platform installation program and the pull secret for your cluster. You can get these from [Install OpenShift on AWS with installer-provisioned infrastructure](https://console.redhat.com/openshift/install/aws/installer-provisioned).
- Red Hat Openshift cluster running in AWS.
- You have the OpenShift Container Platform installation program and the pull secret for your cluster. You can get these from [Install OpenShift on AWS with installer-provisioned infrastructure](https://console.redhat.com/openshift/install/aws/installer-provisioned).
- Red Hat Openshift cluster running in AWS.

## Procedure

1. Create the installation configuration file using the steps described in [Creating the installation configuration file](https://docs.openshift.com/container-platform/4.17/installing/installing_aws/ipi/installing-aws-customizations.html#installation-initializing_installing-aws-customizations).
1. Create the installation configuration file using the steps described in [Creating the installation configuration file](https://docs.openshift.com/container-platform/4.17/installing/installing_aws/ipi/installing-aws-customizations.html#installation-initializing_installing-aws-customizations).

> **Note:**
> Supported regions are `us-west-2` and `us-east-1`. For more information about installing on AWS see, [Installation methods](https://docs.openshift.com/container-platform/latest/installing/installing_aws/preparing-to-install-on-aws.html).
>
> **Note:**
> Supported regions are `us-east-1` `us-east-2` `us-west-1` `us-west-2` `ca-central-1` `sa-east-1` `eu-west-1` `eu-west-2` `eu-west-3` `eu-central-1` `eu-north-1` `ap-northeast-1` `ap-northeast-2` `ap-northeast-3` `ap-southeast-1` `ap-southeast-2` and `ap-south-1`. For more information about installing on AWS see, [Installation methods](https://docs.openshift.com/container-platform/latest/installing/installing_aws/preparing-to-install-on-aws.html).
>

2. Customize the generated `install-config.yaml` creating one control plane node with instance type `m5a.2xlarge` and 3 worker nodes with instance type `p3.2xlarge`. A sample YAML file is shown here:
2. Customize the generated `install-config.yaml` creating one control plane node with instance type `m5a.2xlarge` and 3 worker nodes with instance type `p3.2xlarge`. A sample YAML file is shown here:
```yaml
additionalTrustBundlePolicy: Proxyonly
apiVersion: v1
Expand Down Expand Up @@ -62,7 +62,7 @@ aliases: /rag-llm-gitops/getting-started/

3. Fork the [rag-llm-gitops](https://github.com/validatedpatterns/rag-llm-gitops.git) git repository.

4. Clone the forked repository by running the following command:
4. Clone the forked repository by running the following command:

```sh
$ git clone git@github.com:your-username/rag-llm-gitops.git
Expand All @@ -78,14 +78,14 @@ aliases: /rag-llm-gitops/getting-started/
$ cp values-secret.yaml.template ~/values-secret-rag-llm-gitops.yaml
```
> **Note:**
>For this demo, editing this file is unnecessary as the default configuration works out of the box upon installation.
>For this demo, editing this file is unnecessary as the default configuration works out of the box upon installation.

7. Add the remote upstream repository by running the following command:
7. Add the remote upstream repository by running the following command:

```sh
$ git remote add -f upstream git@github.com:validatedpatterns/rag-llm-gitops.git
```
8. Create a local branch by running the following command:
8. Create a local branch by running the following command:

```sh
$ git checkout -b my-test-branch main
Expand All @@ -100,7 +100,7 @@ aliases: /rag-llm-gitops/getting-started/
```sh
$ git push origin my-test-branch
```
12. Ensure you have logged in to the cluster at both command line and the console by using the login credentials presented to you when you installed the cluster. For example:
12. Ensure you have logged in to the cluster at both command line and the console by using the login credentials presented to you when you installed the cluster. For example:

```sh
INFO Install complete!
Expand All @@ -109,38 +109,38 @@ aliases: /rag-llm-gitops/getting-started/
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.demo1.openshift4-beta-abcorp.com
INFO Login to the console with user: kubeadmin, password: <provided>
```
13. Add GPU nodes to your existing cluster deployment by running the following command:
13. Add GPU nodes to your existing cluster deployment by running the following command:

```sh
$ ./pattern.sh make create-gpu-machineset
```
> **Note:**
> You may need to create a file `config` in your home directory and populate it with the region name.
> 1. Run the following:
> **Note:**
> You may need to create a file `config` in your home directory and populate it with the region name.
> 1. Run the following:
> ```sh
> vi ~/.aws/config
> ```
> 2. Add the following:
> ```
> 2. Add the following:
> ```sh
> [default]
> region = us-east-1
> ```

14. Adding the GPU nodes should take about 5-10 minutes. You can verify the addition of these `g5.2xlarge` nodes in the OpenShift web console under **Compute** > **Nodes**.
14. Adding the GPU nodes should take about 5-10 minutes. You can verify the addition of these `g5.2xlarge` nodes in the OpenShift web console under **Compute** > **Nodes**.

15. Install the pattern with the demo application by running the following command:
15. Install the pattern with the demo application by running the following command:

```sh
$ ./pattern.sh make install
```
```

> **Note:**
> This deploys everything you need to run the demo application including the Nividia GPU Operator and the Node Feature Discovery Operator used to determine your GPU nodes.
>
> **Note:**
> This deploys everything you need to run the demo application including the Nividia GPU Operator and the Node Feature Discovery Operator used to determine your GPU nodes.
>

## Verify the Installation

1. In the OpenShift web console go to the **Workloads** > **Pods** menu.
1. In the OpenShift web console go to the **Workloads** > **Pods** menu.

2. Select the `rag-llm` project from the drop down.

Expand All @@ -160,7 +160,7 @@ aliases: /rag-llm-gitops/getting-started/

### Generate the proposal document

- The demo generates a proposal document using the default provider `Mistral-7B-Instruct`; a model available on Hugging Face. It is a fine-tuned version of the base `Mistral-7B` model.
- The demo generates a proposal document using the default provider `Mistral-7B-Instruct`; a model available on Hugging Face. It is a fine-tuned version of the base `Mistral-7B` model.

- Enter any company name for example `Microsoft`.
- Enter the product as `RedHat OpenShift AI`
Expand Down