add poor-man exampleto kickstart

Author: mjudeikis

cli/pkg/kubectl/dev/cmd/cmd.go

@@ -73,6 +73,13 @@ func New(streams genericclioptions.IOStreams) (*cobra.Command, error) {
 	}
 	cmd.AddCommand(deleteCmd)
 
+	exampleCmd, err := newExampleCommand(streams)
+	if err != nil {
+		return nil, err
+	}
+
+	cmd.AddCommand(exampleCmd)
+
 	return cmd, nil
 }
 
@@ -151,3 +158,34 @@ func newDeleteCommand(streams genericclioptions.IOStreams) (*cobra.Command, erro
 
 	return cmd, nil
 }
+
+func newExampleCommand(streams genericclioptions.IOStreams) (*cobra.Command, error) {
+	opts := plugin.NewDevOptions(streams)
+	cmd := &cobra.Command{
+		Use:   "example",
+		Short: "Get example manifest for MangoDB",
+		Long: help.Doc(`
+		This will print example CRD you can use for development environment testing.
+	`),
+		SilenceUsage: true,
+		Args:         cobra.NoArgs,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if err := logsv1.ValidateAndApply(opts.Logs, nil); err != nil {
+				return err
+			}
+
+			if err := opts.Complete(args); err != nil {
+				return err
+			}
+
+			if err := opts.Validate(); err != nil {
+				return err
+			}
+
+			return opts.RunPrintExample(cmd.Context())
+		},
+	}
+	opts.AddCmdFlags(cmd)
+
+	return cmd, nil
+}

cli/pkg/kubectl/dev/plugin/dev.go cli/pkg/kubectl/dev/plugin/create.gocli/pkg/kubectl/dev/plugin/dev.go renamed to cli/pkg/kubectl/dev/plugin/create.go

@@ -154,7 +154,7 @@ func (o *DevOptions) Run(ctx context.Context) error {
 		"  1. Run login to authenticate to the provider cluster:\n\n"+
 		"kubectl bind login http://kube-bind.dev.local:8080\n\n"+
 		"  2. Run bind to bind an API service from the provider to the consumer cluster:\n\n"+
-		"kubectl bind --konnector-host-alias "+providerIP+":kube-bind.dev.local\n")
+		"KUBECONFIG="+o.ConsumerClusterName+".kubeconfig kubectl bind --konnector-host-alias "+providerIP+":kube-bind.dev.local\n")
 	return nil
 }
 
@@ -231,52 +231,6 @@ func (o *DevOptions) createCluster(ctx context.Context, clusterName, clusterConf
 	return nil
 }
 
-func (o *DevOptions) RunDelete(ctx context.Context) error {
-	if err := o.deleteCluster(ctx, o.ProviderClusterName); err != nil {
-		return err
-	}
-
-	if err := o.deleteCluster(ctx, o.ConsumerClusterName); err != nil {
-		return err
-	}
-
-	return o.cleanupHostEntries(ctx)
-}
-
-func (o *DevOptions) deleteCluster(ctx context.Context, clusterName string) error {
-	fmt.Fprintf(o.Streams.ErrOut, "Deleting kind cluster %s\n", clusterName)
-	provider := cluster.NewProvider()
-
-	err := provider.Delete(clusterName, "")
-	if err != nil {
-		return err
-	}
-
-	kubeconfigPath := fmt.Sprintf("%s.kubeconfig", clusterName)
-	if err := os.Remove(kubeconfigPath); err != nil && !os.IsNotExist(err) {
-		fmt.Fprintf(o.Streams.ErrOut, "Failed to remove kubeconfig file %s: %v\n", kubeconfigPath, err)
-	} else {
-		fmt.Fprintf(o.Streams.ErrOut, "Removed kubeconfig file %s\n", kubeconfigPath)
-	}
-
-	return nil
-}
-
-func (o *DevOptions) cleanupHostEntries(ctx context.Context) error {
-	if err := removeHostEntry("kube-bind.dev.local"); err != nil {
-		fmt.Fprintf(o.Streams.ErrOut, "Failed to remove host entry: %v\n", err)
-		fmt.Fprintf(o.Streams.ErrOut, "Warning: Could not automatically remove host entry. Please run:\n")
-		if runtime.GOOS == "windows" {
-			fmt.Fprintf(o.Streams.ErrOut, "  Remove '127.0.0.1 kube-bind.dev.local' line from C:\\Windows\\System32\\drivers\\etc\\hosts\n")
-		} else {
-			fmt.Fprintf(o.Streams.ErrOut, "  sudo sed -i '/127.0.0.1 kube-bind.dev.local/d' /etc/hosts\n")
-		}
-	} else {
-		fmt.Fprintf(o.Streams.ErrOut, "Removed host entry kube-bind.dev.local\n")
-	}
-	return nil
-}
-
 func (o *DevOptions) getClusterIPAddress(ctx context.Context, clusterName, networkName string) (string, error) {
 	dockerClient, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
 	if err != nil {

cli/pkg/kubectl/dev/plugin/delete.go

@@ -0,0 +1,72 @@
+/*
+Copyright 2025 The Kube Bind Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package plugin
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"runtime"
+
+	"sigs.k8s.io/kind/pkg/cluster"
+)
+
+func (o *DevOptions) RunDelete(ctx context.Context) error {
+	if err := o.deleteCluster(ctx, o.ProviderClusterName); err != nil {
+		return err
+	}
+
+	if err := o.deleteCluster(ctx, o.ConsumerClusterName); err != nil {
+		return err
+	}
+
+	return o.cleanupHostEntries(ctx)
+}
+
+func (o *DevOptions) deleteCluster(ctx context.Context, clusterName string) error {
+	fmt.Fprintf(o.Streams.ErrOut, "Deleting kind cluster %s\n", clusterName)
+	provider := cluster.NewProvider()
+
+	err := provider.Delete(clusterName, "")
+	if err != nil {
+		return err
+	}
+
+	kubeconfigPath := fmt.Sprintf("%s.kubeconfig", clusterName)
+	if err := os.Remove(kubeconfigPath); err != nil && !os.IsNotExist(err) {
+		fmt.Fprintf(o.Streams.ErrOut, "Failed to remove kubeconfig file %s: %v\n", kubeconfigPath, err)
+	} else {
+		fmt.Fprintf(o.Streams.ErrOut, "Removed kubeconfig file %s\n", kubeconfigPath)
+	}
+
+	return nil
+}
+
+func (o *DevOptions) cleanupHostEntries(ctx context.Context) error {
+	if err := removeHostEntry("kube-bind.dev.local"); err != nil {
+		fmt.Fprintf(o.Streams.ErrOut, "Failed to remove host entry: %v\n", err)
+		fmt.Fprintf(o.Streams.ErrOut, "Warning: Could not automatically remove host entry. Please run:\n")
+		if runtime.GOOS == "windows" {
+			fmt.Fprintf(o.Streams.ErrOut, "  Remove '127.0.0.1 kube-bind.dev.local' line from C:\\Windows\\System32\\drivers\\etc\\hosts\n")
+		} else {
+			fmt.Fprintf(o.Streams.ErrOut, "  sudo sed -i '/127.0.0.1 kube-bind.dev.local/d' /etc/hosts\n")
+		}
+	} else {
+		fmt.Fprintf(o.Streams.ErrOut, "Removed host entry kube-bind.dev.local\n")
+	}
+	return nil
+}

cli/pkg/kubectl/dev/plugin/example.go

@@ -0,0 +1,35 @@
+/*
+Copyright 2025 The Kube Bind Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package plugin
+
+import (
+	"context"
+	"fmt"
+)
+
+var example = `apiVersion: mangodb.com/v1alpha1
+kind: MangoDB
+metadata:
+  name: my-first-mangodb-instance
+  namespace: default
+spec:
+  tier: Dedicated`
+
+func (o *DevOptions) RunPrintExample(ctx context.Context) error {
+	fmt.Fprintf(o.Streams.Out, "%s", example)
+	return nil
+}

docs/content/setup/quickstart.md

@@ -12,13 +12,60 @@ description: >
 
 ## Start with kube-bind
 
-### Deploy a kube-bind Backend
+### Quick Development Setup
 
-You can deploy a kube-bind backend using helm (recommended):
+**Note:** This setup requires Docker as it uses advanced network configuration to minimize external DNS dependencies and enable inter-cluster connectivity.
+
+For a quick development environment with local Kind clusters, use the `kubectl bind dev` command:
+
+```bash
+kubectl bind dev create
+```
+
+This command will:
+- Create two Kind clusters: `kind-provider` (API provider) and `kind-consumer` (API consumer)
+- Deploy the kube-bind backend to the provider cluster
+- Generate kubeconfig files for both clusters
+- Set up local DNS entries for `kube-bind.dev.local`
+- Start the kube-bind server at `http://kube-bind.dev.local:8080`
+
+After the development environment is ready, you can:
+
+1. **Authenticate to the provider cluster:**
+   ```bash
+   kubectl bind login http://kube-bind.dev.local:8080
+   ```
+   This will open a browser for authentication and save the configuration.
+
+2. **Bind API services from provider to consumer:**
+   ```bash
+   KUBECONFIG=kind-consumer.kubeconfig kubectl bind --konnector-host-alias <docker-internal-ip-address>:kube-bind.dev.local
+   ```
+   This opens the kube-bind web UI where you can select and bind API services.
+
+3. **Verify bound resources:**
+   ```bash
+   KUBECONFIG=kind-consumer.kubeconfig kubectl get crd
+   KUBECONFIG=kind-consumer.kubeconfig kubectl get apiservicebindings -n kube-bind
+   ```
+
+4. **Create example resource**
+   ```bash
+   kubectl bind dev example | KUBECONFIG=kind-consumer.kubeconfig kubectl create -f -
+   ```
+
+5. **Check resource synced to provider**
+   ```bash
+   KUBECONFIG=kind-provider.kubeconfig kubectl get mangodbs.mangodb.com -A
+   ```
+
+### Production Deployment
+
+For production deployments, you can deploy a kube-bind backend using helm:
 
 - **[Using Helm Chart](helm.md)** - Recommended for production deployments
 
-## Once you have a kube-bind backend running, you can connect to it using the `kubectl bind` plugin.
+Once you have a kube-bind backend running (either development or production), you can connect to it:
 
 ### Connect to kube-bind Server