Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
laszlocph authored Feb 16, 2024
1 parent e083084 commit 73cde02
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,44 @@ Because no-one can remember the Kubernetes yaml syntax.

https://gimlet.io/docs/onechart-reference


## Getting started
Check the generated Kubernetes yaml:

OneChart is a generic Helm Chart for web applications. The idea is that most Kubernetes manifest look alike, only very few parts actually change.

Add the Onechart Helm repository:

```bash
helm repo add onechart https://chart.onechart.dev
```

Set your image name and version, the boilerplate is generated.

```bash
helm template my-release onechart/onechart \
--set image.repository=nginx \
--set image.tag=1.19.3
```
Deploy with Helm:

The example below deploys your application image, sets environment variables and configures the Kubernetes Ingress domain name:

```bash
helm install my-release onechart/onechart \
--set image.repository=nginx \
--set image.tag=1.19.3
helm repo add onechart https://chart.onechart.dev
helm template my-release onechart/onechart -f values.yaml

# values.yaml
image:
repository: my-app
tag: fd803fc
vars:
VAR_1: "value 1"
VAR_2: "value 2"
ingress:
annotations:
kubernetes.io/ingress.class: nginx
host: my-app.mycompany.com
```

### Alternative: using an OCI repository
You can also template and install onechart from an OCI repository as follows:

Expand Down

0 comments on commit 73cde02

Please sign in to comment.