Using Kast:

1. in a git repository that will be used to store the spellbooks:

git submodule add https://github.com/kast-spells/kast.git kast

2. create the library directory, here will be stored each of your spellbooks
3. create a directory for a spellbook with its name in the folder
4. create any number of directories inside the spellbook, each one of this will be your chapters
5. create an index.yaml file inside the spellbook directory and add a yaml following this example

name: spellbookName #the name of the main spellbook folder
chapters:
  - chapterName #the name of the folders inside the spellbook

6. inside your chapters create your spell files. lower is an example of values to install argocd
7. commit your changes
8. create an argocd application to start the process

---
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: spellbookName
  namespace: argocd
spec:
  project: default # if u change the project remember to create it before
  source:
    repoURL: [email protected]:Project/repo.git
    targetRevision: master
    path: kast # this will be the submodule path u create 
  destination:
    server: https://kubernetes.default.svc
    namespace: argocd
  syncPolicy:
    retry:
      limit: 2
    syncOptions:
      - CreateNamespace=true

9. (optional) y can create a spell file with the definition to your kast installation so u can administrate ur kast from kast

Example Values

name: argocd #application name
repository: https://github.com/argoproj/argo-helm.git #tanto como para git como para helm
path: charts/argo-cd # en el caso de ser un helm repo usar chart: nombre del chart
revision: argo-cd-5.46.8
namespace: argocd # opcional si no existe toma el nombre de la app
noHelm: true #default is false toma el contenido de el repo + path como solo archivos yaml y aplica en argo
definition: #equivalente a values 
  dex:
    enabled: false
  global:
    image:
      tag: v2.9.0-rc2


appParams:
  disableAutoSync: true
  ignoreDifferences:
    - group: admissionregistration.k8s.io
      kind: ValidatingWebhookConfiguration
      name: istiod-default-validator
      jsonPointers:
        - /webhooks/0/failurePolicy
  managedNamespaceMetadata: #https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/#namespace-metadata
    labels:
      istio-injection: enabled
  # Sync policy
  syncPolicy:
    # managedNamespaceMetadata:
    #   labels: # The labels to set on the application namespace
    #     any: label
    #     you: like
    # annotations: # The annotations to set on the application namespace
    #   the: same
    #   applies: for
    #   annotations: on-the-namespace
    automated: # automated sync by default retries failed attempts 5 times with following delays between attempts ( 5s, 10s, 20s, 40s, 80s ); retry controlled using `retry` field.
      prune: true # Specifies if resources should be pruned during auto-syncing ( false by default ).
      selfHeal: true # Specifies if partial app sync should be executed when resources are changed only in target Kubernetes cluster and no git change detected ( false by default ).
      # allowEmpty: false # Allows deleting all application resources during automatic syncing ( false by default ).
    syncOptions: # Sync options which modifies sync behavior
      - CreateNamespace=true # Namespace Auto-Creation ensures that namespace specified as the application destination exists in the destination cluster.
      - PrunePropagationPolicy=foreground # Supported policies are background, foreground and orphan.
      - PruneLast=true # Allow the ability for resource pruning to happen as a final, implicit wave of a sync operation
    # The retry feature is available since v1.7
    retry:
      limit: 2 # number of failed sync attempt retries; unlimited number of attempts if less than 0
      backoff:
        duration: 5s # the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
        factor: 2 # a factor to multiply the base duration after each failed retry
        maxDuration: 3m # the maximum amount of time allowed for the backoff strategy
  annotations: #argocd app annotations
    enviroment: prod
  customFinalaizers: []
  skipCrds: true # helm/argocd parameter

useExistingProject: default # optional by default uses the spellbok name
cleanDefinition: true # default is false. if true will remove any custom data added to the value conten of the helm for using in case of hard defined helm charts

clusterSelector:
  environment: prod #needs a k8s-cluster definition in the lexicon to be used
projectDisabled: true #will disable the creation of the project
projectName: "" #if defined will override the spellbook name can be combined with projectDisabled
runes: #esto permite dentro de una sola argo app instalar varios repos dfe helm o no se puede usar para dependencias o plugins de cosas ej istio como todo un set
  - repository: https://github.com/otro/repo.git
    path: cosa # en el caso de ser un helm repo usar chart: nombre del chart
    revision: argo-cd-5.46.8
    definition: # y sus values

Using Chapters and herency:

inside each chapter folder you can create a new index.yaml file the content of this can have any configuration and it will be added or overwrite any spellbook definition

the herency is from bigger to small when the smaller is always the more important one

Lexicon:

the lexicon is a compilation of infrastructure or resources that can be consumed by a book. the only ifrastructure needed for kast as an appOfApps is the clusters where the apps will be instaled each cluster defined in the lexicon need to be added to the argocd where the spellbook will be used

lexicon:
  - name: jorge
    type: k8s-cluster
    labels:
      environment: dev
    clusterURL: https://jorge.clusters.api

when used with a clusterSelector in any index or spell file will match all the labels in the selector with the ones in the lexicon if no cluster is selected will defautl to the local cluster

License

This project is licensed under the Creative Commons Attribution-ShareAlike NonCommercial (CC BY-SA-NC) license. See the LICENSE file for details.