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
Copy file name to clipboardExpand all lines: README.md
+68Lines changed: 68 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,74 @@ providers as well as enterprise IT departments offering APIs within their compan
20
20
21
21
**NB:** In May 2023, the kcp project was restructured and components related to workload scheduling (e.g. the syncer) and the transparent multi cluster (tmc) code were removed due to lack of interest/maintainers. Please refer to the [`main-pre-tmc-removal` branch](https://github.com/kcp-dev/kcp/tree/main-pre-tmc-removal) if you are interested in the related code.
22
22
23
+
## Quick Start for Development
24
+
25
+
### Prerequisites
26
+
- Go
27
+
- kubectl
28
+
29
+
### Running kcp locally
30
+
31
+
#### Basic setup
32
+
```bash
33
+
# Option 1: Run directly with go
34
+
go run ./cmd/kcp.go start
35
+
36
+
# Option 2: Build binary first, then run
37
+
make build
38
+
./bin/kcp start
39
+
40
+
# In another terminal, set up kubectl to use kcp
41
+
export KUBECONFIG=.kcp/admin.kubeconfig
42
+
43
+
# Verify it's working
44
+
kubectl get workspaces
45
+
46
+
# Or you can combine the export and kubectl command in one line
47
+
export KUBECONFIG=.kcp/admin.kubeconfig && kubectl get workspaces
48
+
```
49
+
50
+
**Note:** When you run the `start` command for the first time, kcp automatically generates an admin kubeconfig file at `.kcp/admin.kubeconfig` and initializes the necessary data directory structure. The server listens on `https://localhost:6443` by default.
51
+
52
+
#### Sample commands and outputs
53
+
54
+
**Get workspaces:**
55
+
```bash
56
+
$ export KUBECONFIG=.kcp/admin.kubeconfig && kubectl get workspaces
0 commit comments