From 326923f91d0fadeebd7c8fb07b49bfe6a2985751 Mon Sep 17 00:00:00 2001 From: Catalin Jumiga Date: Wed, 30 Jul 2025 16:04:18 +0300 Subject: [PATCH] Implemented docs for configuration file --- docs/overview/app.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/overview/app.md diff --git a/docs/overview/app.md b/docs/overview/app.md new file mode 100644 index 0000000..893a3cf --- /dev/null +++ b/docs/overview/app.md @@ -0,0 +1,39 @@ +# Overlock Environment configuration file + +Overlock enables you to define and manage your local development environment using a declarative YAML configuration file (by default, `overlock.yaml`). This approach makes it easy to version-control, reload, and share reproducible setups. The configuration covers networking, Kubernetes runtime, storage mounts, and lists of Providers, Configurations, and Functions that are automatically applied when the environment is created. This is ideal for restoring environments after a restart or collaborating with others. + +```yaml +# HTTP port mapping for the environment (default: 80) +httpport: 80 + +# HTTPS port mapping for the environment (default: 443) +httpsport: 443 + +# Kubernetes context where the environment will be created +context: "my-k8s-context" + +# Kubernetes engine for the runtime environment (default: "kind") +# Supported values: "kind", "k3s", "k3d" +engine: "kind" + +# Path to the engine configuration file (supported for kind clusters) +engineconfig: "/path/to/kind-config.yaml" + +# Host directory to mount at /storage (optional) +mountpath: "/host/storage/path" + +# Providers to apply to the environment +providers: + - "xpkg.upbound.io/upbound/provider-family-aws:v1" + - "xpkg.upbound.io/upbound/provider-family-gcp:v1" + +# Configurations to apply to the environment +configurations: + - "xpkg.upbound.io/upbound/platform-ref-aws:v1.4.0" + - "xpkg.upbound.io/upbound/platform-ref-azure:v0.14.0" + +# Functions to apply to the environment +functions: + - "xpkg.upbound.io/upbound/function-go-templating:v0.10.0" + - "xxpkg.upbound.io/crossplane-contrib/function-kcl:v0.11.4" +``` \ No newline at end of file