https://github.com/stuttgart-things/kaeffken
gitops apps & cluster management cli
https://github.com/stuttgart-things/kaeffken
apps flux github-api gitops k8s sops
Last synced: 3 months ago
JSON representation
gitops apps & cluster management cli
- Host: GitHub
- URL: https://github.com/stuttgart-things/kaeffken
- Owner: stuttgart-things
- License: other
- Created: 2023-12-31T15:37:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-27T12:05:13.000Z (4 months ago)
- Last Synced: 2025-03-27T12:35:16.452Z (4 months ago)
- Topics: apps, flux, github-api, gitops, k8s, sops
- Language: Go
- Homepage:
- Size: 410 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# stuttgart-things/kaeffken
[ˈkɛfkən]- gitops apps & cluster management cli
## CREATE
CREATE
```bash
kaeffken create --profile tests/vspherevm-workflow.yaml --survey true
```
WORFKLOW SCHEMA
```bash
---
gitRepo: stuttgart-things
gitOwner: stuttgart-things
gitBranch: "{{ .technology }}-{{ .vmName }}"
rootFolder: terraform
subFolder: "{{ .vmName }}"
technology: terraform
commitMessage: "Add {{ .vmName }} VM"
prTitle: "Add {{ .vmName }} VM"
prDescription: "Add {{ .vmName }} VM"
prTags:
- terraform
values:
- "tests/values.yaml"
#SECRETS
secretFiles:
- "tests/secret-config.yaml"
secretAliases:
- "host:vsphere_host" # KEYINSOURCE:TARGETKEY
secretFileOutputName: "secret-vars.yaml" # SOURCE SECRET FILE #pragma: allowlist secret
preQuestions:
- prompt: "VM name?"
kind: ask
name: vmName
type: string
minLength: 3
maxLength: 20
# SHOULD BE IMPLEMENTED | BEFORE RENDERING - SET/PRE-RENDER THOSE ALIASES
aliases:
- "stateKey:{{ .vmName }}"
questions:
- tests/vm-general.yaml
- tests/{{ .envName }}.yaml
templates:
- "tests/vsphere-vm.tf.tpl:{{ .vmName }}.tf"
DECRYPT
## DECRYPT FILE (SOPS)
### STDOUT
```bash
export SOPS_AGE_KEY=AGE-SECRET-KEY-1T22K05UTRDU..
kaeffken decrypt \
--source encrypted.yaml
```
### TO FILE
```bash
kaeffken decrypt \
--source encrypted.yaml \
--key AGE-SECRET-KEY-1T22K05UTRDU.. \
--output file \
--destination /tmp/decrypted.yaml
```
APPS
```bash
kaeffken \
--output file \
--clusterPath=clusters/labul/test1 \
--apps tests/apps.yaml
--pr true
```
```bash
kaeffken \
--output stdout \
--apps /home/sthings/projects/stuttgart-things/kaeffken/apps/flux/apps.yaml \
--appDefaults /home/sthings/projects/stuttgart-things/kaeffken/apps/flux/app-defaults.yaml \
--defaults /home/sthings/projects/stuttgart-things/kaeffken/apps/flux/flux-defaults.yaml
```
ENCRYPT FILE
```bash
cat <> tests/secret.yaml
kind: Secret
apiVersion: v1
metadata:
name: secret
data:
password: wHat6ver
EOF
```
```bash
kaeffken encrypt \
--source tests/secret.yaml \
--output stdout
```
```bash
kaeffken encrypt \
--source tests/secret.yaml \
--output file \
--destination ~/projects/sops/ \
--name config \
--age age1g438...
```
```bash
kaeffken encrypt \
--source tests/secret.yaml \
--output file \
--pr true \
--destination /tmp \
--clusterPath=clusters/labul/test1
```
RENDER (BUILTIN) TEMPLATE AND ENCRYPT FILE
```bash
kaeffken encrypt \
--template k8s \
--values "password=mysecretvalue, username=admin" \
--output stdout
```
## INSTALL
INSTALL (LINUX)
## DEV
CREATE BRANCH
```bash
task branch
```
:bulb: :computer: :floppy_disk: Add Features, fixes, documentation ...
LINT, TEST, BUILD, RUN
```bash
task run
```
CREATE/MERGE PULL REQUEST
```bash
task pr
```
RELEASE VERSIONED ARTIFACTS
```bash
task release
```
ENV FILE
```bash
cat < .env
SOPS_AGE_KEY=AGE-SECRET-KEY-1T2...
EOF
```
ALL TASKS
```bash
task: Available tasks for this project:
* branch: Create branch from main
* build: Install
* build-ko: Build KO Image
* commit: Commit + push code into branch
* delete-branch: Delete branch from origin
* lint: Lint code
* pr: Create pull request into main
* release: Release
* run: Run
* test: Test code
* tests: Built cli tests
```
## AUTHOR
```bash
Patrick Hermann, stuttgart-things 12/2023
```
## License
Licensed under the Apache License, Version 2.0 (the "License").
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an _"AS IS"_ basis, without WARRANTIES or conditions of any kind, either express or implied.
See the License for the specific language governing permissions and limitations under the License.