feat: :memo2: Add docs

.github/workflows/ci-mkdocs.yml

@@ -0,0 +1,32 @@
+name: CI - Docs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install mkdocs-material python library
+        run: pip install mkdocs-material
+
+      - name: Documentation Github deployment
+        run: mkdocs gh-deploy --force

.gitignore

@@ -1,4 +1,79 @@
-.idea/
+**.DS_Store
+
+# Idea
+.idea
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# PyBuilder
+target/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
 # Local .terraform directories
 **/.terraform/*
 
@@ -11,8 +86,8 @@ crash.log
 crash.*.log
 
 # Exclude all .tfvars files, which are likely to contain sensitive data, such as
-# password, private keys, and other secrets. These should not be part of version 
-# control as they are data points which are potentially sensitive and subject 
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
 # to change depending on the environment.
 *.tfvars
 *.tfvars.json
@@ -33,3 +108,7 @@ override.tf.json
 # Ignore CLI configuration files
 .terraformrc
 terraform.rc
+
+# Helm
+**/Chart.lock
+**/charts/

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: local
+    hooks:
+      - id: pre-commit-terraform
+        name: pre-commit Terraform
+        language: system
+        entry: bash -c 'cd terraform && pre-commit run --all-files'
+        require_serial: true
+        verbose: true
+      - id: pre-commit-python
+        name: pre-commit Python
+        language: system
+        entry: bash -c 'cd airflow && pre-commit run --all-files'
+        require_serial: true
+        verbose: true

.tflint.hcl

@@ -0,0 +1,45 @@
+plugin "terraform" {
+  enabled = true
+  version = "0.6.0"
+  source  = "github.com/terraform-linters/tflint-ruleset-terraform"
+}
+
+rule "terraform_comment_syntax" {
+  enabled = true
+}
+
+rule "terraform_deprecated_index" {
+  enabled = true
+}
+
+rule "terraform_documented_outputs" {
+  enabled = true
+}
+
+rule "terraform_documented_variables" {
+  enabled = true
+}
+
+rule "terraform_naming_convention" {
+  enabled = true
+}
+
+rule "terraform_required_providers" {
+  enabled = true
+}
+
+rule "terraform_typed_variables" {
+  enabled = true
+}
+
+rule "terraform_unused_declarations" {
+  enabled = true
+}
+
+rule "terraform_unused_required_providers" {
+  enabled = true
+}
+
+rule "terraform_standard_module_structure" {
+  enabled = false
+}

README.md

@@ -19,7 +19,16 @@ colima start
 # Intel
 minikube start --driver=hyperkit --download-only
 # M1
+https://minikube.sigs.k8s.io/docs/drivers/qemu/
+
+```
+brew install socket_vmnet
+brew tap homebrew/services
+HOMEBREW=$(which brew) && sudo ${HOMEBREW} services start socket_vmnet
 minikube start --driver=qemu2  --download-only
+```
+# https://aquasecurity.github.io/trivy
+brew install trivy
 
 Minikube with Ingress setup
 https://github.com/scott-the-programmer/terraform-provider-minikube
@@ -60,4 +69,4 @@ Address:	192.168.64.2#53
 Non-authoritative answer:
 Name:	argocd.data
 Address: 192.168.64.2
-```
+```

airflow/.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+files: ^airflow/
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: debug-statements
+      - id: name-tests-test
+        args: [--django]
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+  - repo: https://github.com/pycqa/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+        additional_dependencies: [Flake8-pyproject]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+      - id: pyupgrade
+        args: [--py39-plus]
+  - repo: https://github.com/python/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/asottile/add-trailing-comma
+    rev: v2.4.0
+    hooks:
+      - id: add-trailing-comma
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: [ --filter-files --explicit-package-bases]

airflow/example.py → airflow/mini_dags/example.py

@@ -1,10 +1,11 @@
 import datetime
 
-from airflow.operators.empty import EmptyOperator
-
 from airflow import DAG
+from airflow.operators.empty import EmptyOperator
 
-with DAG(dag_id="my_dag_name",
-         start_date=datetime.datetime(2024, 2, 27),
-         schedule="@daily", ):
+with DAG(
+    dag_id="my_dag_name",
+    start_date=datetime.datetime(2024, 2, 27),
+    schedule="@daily",
+):
     EmptyOperator(task_id="task")