Skip to content

Commit

Permalink
Updates to app Readme and removed the questions.yaml to match the lat…
Browse files Browse the repository at this point in the history
…est version of gopaddle - v5.0 (#1022)
  • Loading branch information
gopaddle-io authored Jun 5, 2024
1 parent c6d99cb commit 33c1599
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 39 deletions.
61 changes: 31 additions & 30 deletions packages/gopaddle/gopaddle-lite/overlay/app-readme.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,53 @@
## gopaddle
gopaddle is a low-code Internal Developer Plaform (IDP) for Kubernetes developers and operators. It provides a self-service portal through which developers can scaffold code to containers, auto-generate YAML files, build docker images, deploy applications on to Kubernetes and manage the application life cycle from a single dashboard.
<img alt="gopaddle" src="https://gopaddle-marketing.s3.ap-southeast-2.amazonaws.com/gopaddle.png?s=200&v=4" width="200" align="left">

### Version Number
# [gopaddle](https://gopaddle.io/)
[![Slack Channel](https://img.shields.io/badge/Slack-Join-purple)](https://gopaddleio.slack.com/join/shared_invite/zt-1l73p8wfo-vYk1XcbLAZMo9wcV_AChvg#/shared-invite/email/expanded-email-form)

gopaddle Lite - v4.2.5
## Kubernetes IDE with AI Co-pilot
gopaddle is a low-code Kubernetes IDE with AI Co-pilot. The low-code IDE has advanced resource filtering, a YAML free form editor, and developer tools like a container terminal and logs. The AI Co-pilot provides interactive troubleshooting.

### Pre-requisite
a) Install the necessary CSI driver to provision Persistent Volumes.
## Installation

For eg., If you are running Rancher RKE on AWS, install the AWS EBS CSI driver.
### Minimum System Requirements
gopaddle installation requires a minimum of `8GB RAM` and `4 vCPUs`

```
kubectl create secret generic aws-secret --namespace kube-system --from-literal "key_id=<aws-access-key>" --from-literal "access_key=<aws-secret-key>"
kubectl apply -k "github.com/kubernetes-sigs/aws-ebs-csi-driver/deploy/kubernetes/overlays/stable/?ref=release-1.13"
```
### Firewall Ports
The following incoming firewall ports need to be opened - `30003`.

You can find more information on AWS CSI Driver [here](https://github.com/kubernetes-sigs/aws-ebs-csi-driver#kubernetes-version-compatibility-matrix)
### Step to install using Helm Charts

In case of AWS CSI Driver, patch the first node in the cluster to add the labels `topology.kubernetes.io` & `topology.kubernetes.io/zone` to point to the node's region and zone. The below script patches the node labels to `us-east-1` region and `us-east-1a` zone.
Add the helm repo

```sh
helm repo add gopaddle https://gopaddle-io.github.io/gopaddle-lite/
helm repo update
```
apt install jq -y
node=$(kubectl get nodes -o json | jq -r '.items[0].metadata.annotations["rke2.io/hostname"]')
kubectl patch node $node -p '{"metadata": {"labels":{"topology.kubernetes.io/region": "us-east-1"}}}'
kubectl patch node $node -p '{"metadata": {"labels":{"topology.kubernetes.io/zone":"us-east-1a"}}}'
Install the chart

```sh
helm install gp-lite gopaddle/gopaddle --namespace gopaddle --create-namespace
```

b) Create default storageClass.
Create a storageClass named `standard` from the Rancher Dashboard https://rancher-endpoint/dashboard/c/local/explorer/storage.k8s.io.storageclass.
### Validating the installation
gopaddle installation can be validated by waiting for the gopaddle services to move to `ready` state.

In case of AWS, create an Amazon EBS Disk.
```sh
kubectl wait --for=condition=ready pod -l released-by=gopaddle -n gopaddle
```

<img src="https://user-images.githubusercontent.com/74309181/211659744-adde9594-5a33-4fea-8578-b9347142ba1c.png" width="80%">
One the installation is complete, gopaddle dashboard can be accessed at http://[NodeIP]:30003/

Patch the storageClass `standard` and add the `is-default-class` annotation to make it the default storageClass.
NodeIP can be obtained by executing the command below:

```
kubectl patch storageclass standard -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'
```sh
kubectl get nodes -o wide
```

c) Open INBOUND firewall ports 30003 and 30004. If RKE is installed on AWS, then open the ports 30003 and 30004 in the instance security group.
## Usage

Once the gopaddle chart is installed, the dashboard can be accessed at http://node_ip:30003
Open the `Ask AI` option, select the LLM Type as `OpenAI`, select a model, and provide the API Key.

### Support URL
To get the OpenAI API Key, check here: [OpenAI API Key](https://platform.openai.com/api-keys).

[![Slack Channel](https://img.shields.io/badge/Slack-Join-purple)](https://gopaddleio.slack.com/join/shared_invite/zt-1l73p8wfo-vYk1XcbLAZMo9wcV_AChvg#/shared-invite/email/expanded-email-form)

### Documentation

[Documentation](https://help.gopaddle.io)
9 changes: 0 additions & 9 deletions packages/gopaddle/gopaddle-lite/overlay/questions.yaml

This file was deleted.

0 comments on commit 33c1599

Please sign in to comment.