Quickstart
Prerequisites
- kubectl
- For the backend walkthrough: kubectl bind plugin installed
To try synchronization without a backend or login, follow the core-only GitOps example.
Start with kbind
Quick Development Setup
For a local development environment, follow the kind setup guide. It creates a provider cluster and a consumer cluster, starts the backend and konnector, and adds the Widget API to the catalog. Docker, kind, and Go are required.
After the development environment is ready, you can:
-
Authenticate to the provider cluster:
This opens a browser for authentication and saves the session.
-
Bind an API service from provider to consumer:
kubectl bind catalog kubectl bind export widgets --kubeconfig=consumer.kubeconfig \ --install-konnector=falseThe development setup already runs the konnector, so skip installing another copy. You can also browse the catalog at
http://localhost:8080. -
Verify bound resources:
-
Create an example resource:
-
Check the resource synced to the provider:
-
Verify status returns to the consumer:
The sample has no Widget service controller. Simulate its status update on the provider, then wait for the consumer to receive it:
For other service APIs, see the integration examples. When finished, follow the development guide's cleanup.
Production Deployment
For an in-cluster deployment, use the Helm charts to install the consumer konnector and optional provider backend.
Once you have a backend running, either locally or in a cluster, you can connect to it:
Connect to kbind Server
Open kbind Web UI and bind services
Open your provider's URL in a browser to browse the catalog and bind services. For the same workflow from the CLI, use kubectl bind catalog and kubectl bind export <name>.