Skip to content

Commit

Permalink
Added values schema (#8)
Browse files Browse the repository at this point in the history
* Added values schema

* update Helm documentation

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
edu-diaz and github-actions[bot] authored Jan 2, 2025
1 parent 498191b commit d4481b9
Show file tree
Hide file tree
Showing 4 changed files with 209 additions and 5 deletions.
16 changes: 15 additions & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,18 @@ jobs:
- name: Run helm-docs
uses: losisin/helm-docs-github-action@v1
with:
git-push: true
git-push: true

values-schema:
needs: lint-test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}

- name: Generate values schema json
uses: losisin/[email protected]
with:
input: values.yaml
2 changes: 1 addition & 1 deletion Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ maintainers:
email: [email protected]
url: https://edudiaz.trianalab.net
icon: https://jesse.trade/_nuxt/w-01.BBPhGRey.png
version: 0.0.7
version: 0.0.8
appVersion: "1.4.2"
dependencies:
- name: postgresql
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A Helm chart for Jesse trade bot.

![Version: 0.0.7](https://img.shields.io/badge/Version-0.0.7-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.4.2](https://img.shields.io/badge/AppVersion-1.4.2-informational?style=flat-square) [![DOI](https://zenodo.org/badge/909500081.svg)](https://doi.org/10.5281/zenodo.14587093) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/jesse-chart)](https://artifacthub.io/packages/helm/jesse-chart/jesse)
![Version: 0.0.8](https://img.shields.io/badge/Version-0.0.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.4.2](https://img.shields.io/badge/AppVersion-1.4.2-informational?style=flat-square) [![DOI](https://zenodo.org/badge/909500081.svg)](https://doi.org/10.5281/zenodo.14587093) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/jesse-chart)](https://artifacthub.io/packages/helm/jesse-chart/jesse)

# Index
- [Usage](#usage)
Expand Down Expand Up @@ -49,14 +49,14 @@ kind create cluster --name jesse-cluster

Pull the values file:
```bash
helm show values oci://ghcr.io/trianalab/jesse-chart/jesse --version 0.0.7 > values.yaml
helm show values oci://ghcr.io/trianalab/jesse-chart/jesse --version 0.0.8 > values.yaml
```
Add the `LICENSE_API_TOKEN` within the `config` field in the `values.yaml` file according to Jesse's [documentation](https://docs.jesse.trade/docs/configuration#environment-variables).

### Step 3: Install the Helm chart

```bash
helm install jesse oci://ghcr.io/trianalab/jesse-chart/jesse --version 0.0.7 --namespace jesse-namespace --create-namespace -f values.yaml
helm install jesse oci://ghcr.io/trianalab/jesse-chart/jesse --version 0.0.8 --namespace jesse-namespace --create-namespace -f values.yaml
```

### Step 4: Verify the deployment
Expand Down
190 changes: 190 additions & 0 deletions values.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"affinity": {
"properties": {},
"type": "object"
},
"autoscaling": {
"properties": {
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"config": {
"type": "string"
},
"fullnameOverride": {
"type": "string"
},
"image": {
"properties": {
"command": {
"type": "string"
},
"pullPolicy": {
"type": "string"
},
"repository": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"imagePullSecrets": {
"type": "array"
},
"ingress": {
"properties": {
"annotations": {
"properties": {},
"type": "object"
},
"className": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"hosts": {
"type": "array"
},
"tls": {
"type": "array"
}
},
"type": "object"
},
"nameOverride": {
"type": "string"
},
"nodeSelector": {
"properties": {},
"type": "object"
},
"podAnnotations": {
"properties": {},
"type": "object"
},
"podLabels": {
"properties": {},
"type": "object"
},
"podSecurityContext": {
"properties": {},
"type": "object"
},
"postgresql": {
"properties": {
"auth": {
"properties": {
"database": {
"type": "string"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"fullnameOverride": {
"type": "string"
}
},
"type": "object"
},
"redis": {
"properties": {
"architecture": {
"type": "string"
},
"auth": {
"properties": {
"password": {
"type": "string"
}
},
"type": "object"
},
"fullnameOverride": {
"type": "string"
}
},
"type": "object"
},
"replicaCount": {
"type": "integer"
},
"resources": {
"properties": {},
"type": "object"
},
"securityContext": {
"properties": {},
"type": "object"
},
"service": {
"properties": {
"annotations": {
"properties": {},
"type": "object"
},
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"annotations": {
"properties": {},
"type": "object"
},
"automount": {
"type": "boolean"
},
"create": {
"type": "boolean"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"type": "array"
},
"volumeMounts": {
"type": "array"
},
"volumes": {
"type": "array"
}
},
"type": "object"
}

0 comments on commit d4481b9

Please sign in to comment.