~/DOCS/

Quick Start

1. Label Nodes

kubectl label nodes <node-name> architect.loopholelabs.io/node=true
kubectl label nodes <node-name> architect.loopholelabs.io/critical-node=true

2. Install Architect

Sign into console.architect.io, click + Add Cluster, and follow the instructions. The console provides a pre-filled helm install command with your machine token, cluster name, and Kubernetes distribution.

Verify the installation:

kubectl get pods -n architect

You should see architect-manager, architect-control-plane, and architectd on each labeled node. For GitOps setup, prerequisites, and advanced Helm chart options, see the full Installation guide.

3. Deploy an Example

helm install example-valkey oci://ghcr.io/loopholelabs/example-valkey-chart --wait

4. Watch Hibernation and Wake

# Watch the pod hibernate after 10 seconds of inactivity
kubectl get pods -w

# Wake it with a request
kubectl exec -it <example-valkey-pod> -- curl localhost:8080

More Examples

Try these pre-configured applications to see Architect work across different languages and frameworks. Each chart deploys a small workload with Architect annotations already applied, so it will hibernate after a short idle period and wake instantly on traffic:

ApplicationInstall
Gohelm upgrade example-go oci://ghcr.io/loopholelabs/example-go-chart --install --wait
Java (Tomcat)helm upgrade example-java-tomcat oci://ghcr.io/loopholelabs/example-java-tomcat-chart --install --wait
Kafkahelm upgrade example-kafka oci://ghcr.io/loopholelabs/example-kafka-chart --install --wait
PostgreSQLhelm upgrade example-postgres oci://ghcr.io/loopholelabs/example-postgres-chart --install --wait
Pythonhelm upgrade example-python oci://ghcr.io/loopholelabs/example-python-chart --install --wait
Rubyhelm upgrade example-ruby oci://ghcr.io/loopholelabs/example-ruby-chart --install --wait
Valkeyhelm upgrade example-valkey oci://ghcr.io/loopholelabs/example-valkey-chart --install --wait
Spring Boothelm upgrade example-spring-boot oci://ghcr.io/loopholelabs/example-spring-boot-chart --install --wait
Rust (miniserve)helm upgrade example-rust-miniserve oci://ghcr.io/loopholelabs/example-rust-miniserve-chart --install --wait
PHP (WordPress)helm upgrade example-php-wordpress oci://ghcr.io/loopholelabs/example-php-wordpress-chart --install --wait

See FAQ → Compatibility for the full support matrix.