You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
require.Equal(t, "kubectl plugin for kube-bind, bind different remote types into the current cluster.", rootCmd.Short, "Unexpected short command description")
33
-
require.Contains(t, rootCmd.Long, "To bind a remote service, use the 'kubectl bind' command.", "Unexpected lond command Long")
33
+
require.Contains(t, rootCmd.Long, "To bind a remote service, use the 'kubectl bind' command.", "Unexpected long command")
Copy file name to clipboardExpand all lines: docs/content/usage/index.md
+17-5Lines changed: 17 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,60 +14,72 @@ This section provides comprehensive documentation on how to use kube-bind's core
14
14
kube-bind operates on three fundamental concepts:
15
15
16
16
### Service Provider
17
+
17
18
The cluster that **exports** APIs and resources, making them available for other clusters to consume. Service providers create templates and handle permission claims.
18
19
19
-
### Service Consumer
20
+
### Service Consumer
21
+
20
22
The cluster that **imports** and uses APIs from service providers. Consumers bind to templates and get access to resources through a secure, controlled process.
21
23
22
24
### Konnector Agent
25
+
23
26
The component that establishes and maintains the secure connection between provider and consumer clusters, synchronizing resources and handling permissions.
24
27
25
28
## Key API Types
26
29
27
30
### APIServiceExportTemplate
31
+
28
32
**Purpose**: Defines a reusable service template that groups related CRDs and permission claims.
29
33
**Used by**: Service providers
30
34
**Scope**: Template definition for multiple consumers
31
35
32
36
### APIServiceExport
37
+
33
38
**Purpose**: Represents an active export of a specific CRD to consumer clusters.
34
39
**Used by**: Automatically created by konnector agents
35
40
**Scope**: Per-CRD export instance
36
41
37
42
### APIServiceExportRequest
43
+
38
44
**Purpose**: Consumer's request to bind to a specific service template.
39
45
**Used by**: Service consumers (via CLI/UI)
40
46
**Scope**: Per-binding request
41
47
42
48
### APIServiceNamespace
49
+
43
50
**Purpose**: Manages namespace mapping and isolation between provider and consumer clusters.
44
51
**Used by**: Automatically managed by konnector agents
45
52
**Scope**: Per-namespace sync
46
53
47
54
## Documentation Structure
48
55
49
56
### [API Concepts](api-concepts.md)
57
+
50
58
Deep dive into the core API types, their relationships, and how they work together in the kube-bind ecosystem.
51
59
52
60
### [Template References](template-references.md)
61
+
53
62
Advanced guide for using dynamic resource selection through references in templates.
54
63
55
64
## Common Workflows
56
65
57
66
### For Service Providers
67
+
58
68
1.**Create templates** defining what APIs and resources to export, including permission claims
59
69
2.**Implement service** to act on the synced/bound objects so it can be returned to the consumer/user.
60
70
61
-
### For Service Consumers
71
+
### For Service Consumers
72
+
62
73
1.**Authenticate** to the kube-bind backend
63
74
1.**Discover available templates** through the web UI or CLI
64
75
2.**Request bindings** to specific templates
65
76
3.**Authenticate and authorize** access through OAuth2 flows
66
77
4.**Use imported APIs** in their local cluster
67
78
68
79
### For Platform Operators
80
+
69
81
1.**Deploy kube-bind infrastructure** on both provider and consumer sides (if using GitOps)
70
-
2.**Configure authentication** and security policies
82
+
2.**Configure authentication** and security policies
71
83
3.**Monitor connections** and resource synchronization
72
84
73
85
## Getting Started
@@ -79,9 +91,9 @@ If you're new to kube-bind:
79
91
3.**Explore [Template References](template-references.md)** for advanced use cases
80
92
4.**Check the [Reference Documentation](../reference/)** for complete API specifications
81
93
82
-
83
94
The konnector agents establish a secure, authenticated connection that allows:
95
+
84
96
-**API schema synchronization** from provider to consumer
85
97
-**Resource data flow** based on permission claims
0 commit comments