Merge branch 'kubernetes-sigs:main' into docsaurs_mermaid

Author: kennygt51

Makefile

@@ -254,7 +254,7 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified
 
 .PHONY: deploy-kind
 deploy-kind: export KO_DOCKER_REPO=kind.local
-deploy-kind: ko
+deploy-kind: ko ## Deploy kro to a kind cluster
 	$(KIND) delete clusters ${KIND_CLUSTER_NAME} || true
 	$(KIND) create cluster --name ${KIND_CLUSTER_NAME}
 	$(KUBECTL) --context kind-$(KIND_CLUSTER_NAME) create namespace kro-system

README.md

@@ -2,7 +2,6 @@
 
 
 [![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/kro)](https://goreportcard.com/report/github.com/kubernetes-sigs/kro)
-[![unit tests](https://github.com/kubernetes-sigs/kro/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/kubernetes-sigs/kro/actions/workflows/unit-tests.yaml)
 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/kubernetes-sigs/kro)
 ![GitHub License](https://img.shields.io/github/license/kubernetes-sigs/kro)
 ![GitHub Repo stars](https://img.shields.io/github/stars/kubernetes-sigs/kro)

api/v1alpha1/resourcegraphdefinition_types.go

@@ -70,9 +70,7 @@ type Schema struct {
 	// that the resourcegraphdefinition is managing. This is adhering to the
 	// SimpleSchema spec.
 	Status runtime.RawExtension `json:"status,omitempty"`
-	// Validation is a list of validation rules that are applied to the
-	// resourcegraphdefinition.
-	Validation []Validation `json:"validation,omitempty"`
+
 	// AdditionalPrinterColumns defines additional printer columns
 	// that will be passed down to the created CRD. If set, no
 	// default printer columns will be added to the created CRD,
@@ -83,15 +81,11 @@ type Schema struct {
 	AdditionalPrinterColumns []extv1.CustomResourceColumnDefinition `json:"additionalPrinterColumns,omitempty"`
 }
 
-type Validation struct {
-	Expression string `json:"expression,omitempty"`
-	Message    string `json:"message,omitempty"`
-}
-
 type ExternalRefMetadata struct {
 	// +kubebuilder:validation:Required
 	Name string `json:"name,omitempty"`
-	// +kubebuilder:validation:Required
+	// Namespace of the external resource. optional, if empty uses instance namespace
+	// +kubebuilder:validation:Optional
 	Namespace string `json:"namespace,omitempty"`
 }
 

api/v1alpha1/zz_generated.deepcopy.go

@@ -19,7 +19,6 @@ import (
 	"os"
 	"time"
 
-	"go.uber.org/zap/zapcore"
 	extv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
@@ -51,14 +50,6 @@ func init() {
 	// +kubebuilder:scaffold:scheme
 }
 
-type customLevelEnabler struct {
-	level int
-}
-
-func (c customLevelEnabler) Enabled(lvl zapcore.Level) bool {
-	return -int(lvl) <= c.level
-}
-
 func main() {
 	var (
 		metricsAddr                                 string
@@ -78,9 +69,8 @@ func main() {
 		queueMaxRetries         int
 		gracefulShutdownTimeout time.Duration
 		// var dynamicControllerDefaultResyncPeriod int
-		logLevel int
-		qps      float64
-		burst    int
+		qps   float64
+		burst int
 	)
 
 	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8078", "The address the metric endpoint binds to.")
@@ -119,22 +109,19 @@ func main() {
 		"interval at which the controller will re list resources even with no changes, in seconds.")
 	flag.IntVar(&queueMaxRetries, "dynamic-controller-default-queue-max-retries", 20,
 		"maximum number of retries for an item in the queue will be retried before being dropped")
-	// log level flags
-	flag.IntVar(&logLevel, "log-level", 10, "The log level verbosity. 0 is the least verbose, 5 is the most verbose.")
 	// qps and burst
 	flag.Float64Var(&qps, "client-qps", 100, "The number of queries per second to allow")
 	flag.IntVar(&burst, "client-burst", 150,
 		"The number of requests that can be stored for processing before the server starts enforcing the QPS limit")
 
-	flag.Parse()
-
 	opts := zap.Options{
 		Development: true,
-		Level:       customLevelEnabler{level: logLevel},
-		TimeEncoder: zapcore.ISO8601TimeEncoder,
 	}
-	rootLogger := zap.New(zap.UseFlagOptions(&opts))
+	opts.BindFlags(flag.CommandLine)
 
+	flag.Parse()
+
+	rootLogger := zap.New(zap.UseFlagOptions(&opts))
 	ctrl.SetLogger(rootLogger)
 
 	set, err := kroclient.NewSet(kroclient.Config{
@@ -171,7 +158,6 @@ func main() {
 		// if you are doing or is intended to do any operation such as perform cleanups
 		// after the manager stops then its usage might be unsafe.
 		LeaderElectionReleaseOnCancel: false,
-		Logger:                        rootLogger,
 	})
 	if err != nil {
 		setupLog.Error(err, "unable to start manager")

cmd/controller/main.go

@@ -29,7 +29,7 @@ To test and run the project with your local changes, follow these steps to set u
 
 4. Run the kro Controller Locally: Execute the controller with your changes:
     ```bash
-    go run ./cmd/controller --log-level 2
+    go run ./cmd/controller --zap-log-level=info
     ```
     This will connect to the default Kubernetes context in your local kubeconfig (`~/.kube/config`). Ensure the context is pointing to your local cluster.
 

docs/developer-getting-started.md

@@ -0,0 +1,186 @@
+# Dogs vs Cats Voting App
+
+A multi-tier voting application demonstrating Kro's resource composition capabilities with AWS services.
+
+> **Note**: This example composes multiple reusable components. Each component can also be deployed independently. See the [Component Dependencies](#component-dependencies) section below.
+
+## Architecture
+
+This example showcases a complete voting application composed of reusable components:
+
+- **Vote App**: Frontend for casting votes (Python/Flask)
+- **Result App**: Results dashboard (Node.js)  
+- **Worker App**: Processes votes from Redis to PostgreSQL (Java)
+- **RDS PostgreSQL**: Stores voting results
+- **ElastiCache Serverless**: Caches votes
+- **Ingress**: AWS Load Balancer Controller with ALB
+
+## Component Dependencies
+
+This example uses the following reusable components:
+
+- [../../kubernetes/dogsvscats/vote-app/](../../kubernetes/dogsvscats/vote-app/) - Vote frontend
+- [../../kubernetes/dogsvscats/result-app/](../../kubernetes/dogsvscats/result-app/) - Results dashboard
+- [../../kubernetes/dogsvscats/worker-app/](../../kubernetes/dogsvscats/worker-app/) - Vote processor
+- [../rds-postgres/](../rds-postgres/) - PostgreSQL database
+- [../elasticache-serverless/](../elasticache-serverless/) - Redis cache
+
+## Prerequisites
+
+- EKS cluster with AWS Load Balancer Controller installed
+- Kro installed and running
+- AWS ACK controllers for EC2, RDS, and ElastiCache
+- VPC with private subnets
+
+Following is a way to deploy EKS cluster that covers all the above prerequisites:
+
+Uses the workshop bootstrap Terraform that creates an EKS cluster (Auto Mode), KRO, ACK add-ons, and ALB Controller.
+
+```bash
+# Clone the workshop bootstrap and apply
+git clone https://github.com/aws-samples/krmops-on-eks-workshop.git
+cd krmops-on-eks-workshop/kro-and-ack/bootstrap/terraform
+
+# Set your variables
+export AWS_REGION=ap-southeast-2
+export CLUSTER_NAME=agentcore-demo
+
+terraform init
+terraform apply -auto-approve \
+  -var="region=${AWS_REGION}" \
+  -var="cluster_name=${CLUSTER_NAME}"
+
+## Create ResourceGraphDefinitions
+
+Change directory to `examples`:
+
+```
+cd examples/
+```
+
+Apply the component RGs first:
+
+```bash
+# Apply Kubernetes app components
+kubectl apply -f kubernetes/dogsvscats/vote-app/rg.yaml
+kubectl apply -f kubernetes/dogsvscats/result-app/rg.yaml
+kubectl apply -f kubernetes/dogsvscats/worker-app/rg.yaml
+
+# Apply AWS infrastructure components
+kubectl apply -f aws/rds-postgres/rg.yaml
+kubectl apply -f aws/elasticache-serverless/rg.yaml
+```
+
+Apply the main composed RG:
+
+```bash
+kubectl apply -f aws/dogsvscats-appstack/dogsvscats-rg.yaml
+```
+
+Validate the RGs statuses are Active:
+
+```
+kubectl get rgd
+```
+
+Expected result:
+
+```
+NAME                              APIVERSION   KIND                   STATE    AGE
+dogsvscats-app.kro.run            v1alpha1     DogsvsCatsApp          Active   1m
+elasticache-serverless.kro.run    v1alpha1     ElastiCacheServerless  Active   2m
+rds-postgres.kro.run              v1alpha1     RDSPostgres            Active   2m
+result-app.kro.run                v1alpha1     ResultApp              Active   2m
+vote-app.kro.run                  v1alpha1     VoteApp                Active   2m
+worker-app.kro.run                v1alpha1     WorkerApp              Active   2m
+```
+
+## Create an Instance of kind DogsvsCatsApp
+
+Create environment variables for your infrastructure:
+
+```
+export WORKLOAD_NAME="dogsvscats-voting-app"
+export VPC_ID="vpc-xxxxxxxxx"
+export SUBNET_IDS='"subnet-xxxxxxxxx", "subnet-yyyyyyyyy", "subnet-zzzzzzzzz"'
+```
+
+Validate the variables are populated:
+
+```
+echo $WORKLOAD_NAME
+echo $VPC_ID
+echo $SUBNET_IDS
+```
+
+Run the following command to replace the variables in `instance-template.yaml` and create `instance.yaml`:
+
+```shell
+envsubst < "dogsvscats-appstack/instance-template.yaml" > "dogsvscats-appstack/instance.yaml"
+```
+
+Apply the `dogsvscats-appstack/instance.yaml`:
+
+```
+kubectl apply -f dogsvscats-appstack/instance.yaml
+```
+
+Validate instance status:
+
+```
+kubectl get dogsvscatsapp dogsvscats-voting-app
+```
+
+Expected result:
+
+```
+NAME                    STATE    SYNCED   AGE
+dogsvscats-voting-app   ACTIVE   True     5m
+```
+
+## Validate the app is working
+
+Get the URLs:
+
+```
+kubectl get dogsvscatsapp dogsvscats-voting-app
+```
+
+This will display both the Vote App and Result App URLs in the output.
+
+Navigate to the vote URL to cast votes, then check the result URL to see the results.
+
+## Clean votes for demo
+
+Reset votes between demos:
+
+```bash
+./dogsvscats/scripts/clean-votes.sh
+```
+
+## What This Example Demonstrates
+
+1. **Component Composition**: Building complex applications from reusable components
+2. **Cross-namespace References**: Kubernetes components referencing AWS infrastructure
+3. **Status Propagation**: Passing endpoints and connection details between components
+4. **Conditional Resources**: Ingress resources created based on configuration
+5. **Multi-cloud Patterns**: Separating cloud-agnostic apps from cloud-specific infrastructure
+
+## Clean up
+
+Remove the instance:
+
+```
+kubectl delete dogsvscatsapp dogsvscats-voting-app
+```
+
+Remove the ResourceGraphDefinitions:
+
+```bash
+# Remove main composed RG
+kubectl delete rgd dogsvscats-app.kro.run
+
+# Remove component RGs
+kubectl delete rgd vote-app.kro.run result-app.kro.run worker-app.kro.run
+kubectl delete rgd rds-postgres.kro.run elasticache-serverless.kro.run
+```