Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/content/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ nav:
- Home:
- index.md
- Setup: setup
- Usage: usage
- Contributing: contributing
- Developers: developers
- API References: reference
6 changes: 4 additions & 2 deletions docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ We are actively working towards a stable release, and welcome feedback from the
- The service provider does not inject controllers/operators into the service consumer's cluster.
- A single vendor-neutral, OpenSource agent - `konnector` per consumer cluster connects it with the requested services.

## Quickstart
## Getting Started

To get started with trying out kube-bind on your local system, check out our [Quickstart](./setup/quickstart.md) instructions.
- **[Quickstart](./setup/quickstart.md)** - Get up and running with kube-bind quickly
- **[Setup Guide](./setup/index.md)** - Complete installation and deployment options
- **[Usage Guide](./usage/index.md)** - Learn the core concepts and APIs

## Contributing

Expand Down
36 changes: 36 additions & 0 deletions docs/content/setup/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,40 @@ For a quick development environment with local Kind clusters, use the `kubectl b
kubectl bind dev create
```

Example output:
```bash
kube-bind Development Environment Setup

EXPERIMENTAL: kube-bind dev command is in preview
Requirements: Docker must be installed and running

Host entry exists for kube-bind.dev.local
✓ Host entry exists for kube-bind.dev.local
Kind cluster kind-provider already exists, skipping creation
Wrote kubeconfig kind-provider.kubeconfig
Helm chart installed successfully
Creating kind cluster kind-consumer with network kube-bind-dev
Kind cluster kind-consumer created
Wrote kubeconfig kind-consumer.kubeconfig
kube-bind dev environment is ready!

Configuration:
• Provider cluster kubeconfig: kind-provider.kubeconfig
• Consumer cluster kubeconfig: kind-consumer.kubeconfig
• kube-bind server URL: http://kube-bind.dev.local:8080

Next Steps:

1. Login to authenticate to the provider cluster:
kubectl bind login http://kube-bind.dev.local:8080

2. Bind an API service from provider to consumer:
KUBECONFIG=kind-consumer.kubeconfig kubectl bind --konnector-host-alias 192.168.155.2:kube-bind.dev.local
```


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
Expand All @@ -38,6 +71,9 @@ After the development environment is ready, you can:
This will open a browser for authentication and save the configuration.

2. **Bind API services from provider to consumer:**

Bind using CLI (step 2) in the output.

```bash
KUBECONFIG=kind-consumer.kubeconfig kubectl bind --konnector-host-alias <docker-internal-ip-address>:kube-bind.dev.local
```
Expand Down
2 changes: 2 additions & 0 deletions docs/content/usage/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nav:
- api-concepts.md
Loading