Browse Source

Update(docs)

dev
nold 1 year ago
parent
commit
1645a8f7c4
  1. 2
      docs/appconfig.md
  2. BIN
      docs/assets/heqet-overview.jpg
  3. 38
      docs/generators/vault.md
  4. 5
      docs/index.md
  5. 10
      docs/k3s.md

2
docs/appconfig.md

@ -1,6 +1,6 @@
## Application Definition
Here is a list of available configuration options inside the `apps` array.o
Here is a list of available configuration options inside the `apps` array.
### Required

BIN
docs/assets/heqet-overview.jpg

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

38
docs/generators/vault.md

@ -1,7 +1,18 @@
# VaultSecret Generator
The VaultSecret generator will create a `VaultSecret` for every secret specified in the `secrets`-hash. It's based on the [vault-secret-operator](https://github.com/ricoberger/vault-secrets-operator).
## Values
## Parameters
| Parameter | Type | Example | Description |
|-----------|--------|-------------|-------------|
| name | string | `"my-secret"` | Name of Secret to generate & in vault [requited] |
| keys | array[string] | `- password` | Array of keys that will be pulled from the vault-secret [required] |
| type | string | `Opaque` | Secret type in Kubernetes [default: `Opaque`] |
| fromApp | string | `myapp2` | Pulls secret from another app, e.g. `/heqet/<other-app>/<secret.name>`. This way sharing secrets between apps is easily possible |
## Examples
### Simple
Here is an example for a simple secret:
``` yaml
apps:
@ -20,7 +31,7 @@ This will result in following resource. Notice that the path inside of Vault is
apiVersion: ricoberger.de/v1alpha1
kind: VaultSecret
metadata:
name: vpn-config
name: my-secret
namespace: "myapp"
labels:
app: myapp
@ -34,3 +45,26 @@ spec:
type: Opaque
```
### Sharing Secrets between Apps
Secrets can also be shared & pulled from other apps, by using the `fromApp` parameter:
``` yaml
apps:
- name: myapp
secrets:
- name: my-secret
keys:
- username
- password
- shared-key
# default:
type: Opaque
- name: myapp2
secrets:
- name: my-secret
fromApp: myapp
keys:
- shared-key
```

5
docs/index.md

@ -12,6 +12,10 @@ Heqet is my attempt to make Kubernetes GitOps Deployments as easy as possible. I
**This project is still in a very early stage of development, but feel free to try it out & contribute!**
## Overview
![Heqet Overview](assets/heqet-overview.jpg)
## Components & Configuration
Core component is `ArgoCD` which will deploy Heqet & also your apps! All you need is a git-repo & k8s cluster.
@ -23,6 +27,7 @@ If more configuration values are required, simply throw your applications `value
## Installation
Installing heqet can't be simpler, after configuring your apps, argocd and pushing it to your git repo:
1. Configure `manifests/heqet-apps.yaml` to match your Setup
2. `kubectl apply -f manifests/argocd.yaml`
3. `kubectl apply -f manifests/heqet-apps.yaml`

10
docs/k3s.md

@ -3,7 +3,7 @@
## Bootstrap K3s
See: [K3s Install Options](https://rancher.com/docs/k3s/latest/en/installation/install-options/)
Or simply run:
Or if you are feeling lucky:
``` shellsession
curl -sfL https://get.k3s.io | sh -
```
@ -69,7 +69,7 @@ spec:
readOnlyRootFilesystem: true
```
The Password should be `admin`.
The password in this example is `argocd`.
## Bootstrap Heqet
@ -108,4 +108,8 @@ spec:
## Profit!
Now K3s should be setup. ArgoCD should be deployed by K3s-Helm-Operator. The Heqet-Application will bootstrap ArgoCD & hand over the control of all Application configuration to ArgoCD.
Now K3s should be setup:
- ArgoCD should be deployed by K3s-Helm-Operator
- The Heqet-Application will bootstrap ArgoCD
- ArgoCD will take control of all Application configuration in heqet

Loading…
Cancel
Save