-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1043 from davidnuzik/building
Add new BUILDING.md with "Building from Source" content from k3s docs
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
See the [release](https://github.com/rancher/k3s/releases/latest) page for pre-built releases. | ||
|
||
The clone will be much faster on this repo if you do | ||
|
||
git clone --depth 1 https://github.com/rancher/k3s.git | ||
|
||
This repo includes all of Kubernetes history so `--depth 1` will avoid most of that. | ||
|
||
To build the full release binary run `make` and that will create `./dist/artifacts/k3s`. | ||
|
||
Optionally to build the binaries without running linting or building docker images: | ||
```sh | ||
./scripts/download && ./scripts/build && ./scripts/package-cli | ||
``` | ||
|
||
For development, you just need go 1.12 and a proper GOPATH. To compile the binaries run: | ||
```bash | ||
go build -o k3s | ||
go build -o kubectl ./cmd/kubectl | ||
go build -o hyperkube ./vendor/k8s.io/kubernetes/cmd/hyperkube | ||
``` | ||
|
||
This will create the main executable at `./dist/artifacts` , but it does not include the dependencies like containerd, CNI, | ||
etc. To run a server and agent with all the dependencies for development run the following | ||
helper scripts: | ||
```bash | ||
# Server | ||
./scripts/dev-server.sh | ||
|
||
# Agent | ||
./scripts/dev-agent.sh | ||
``` | ||
|
||
Kubernetes Source | ||
----------------- | ||
|
||
The source code for Kubernetes is in `vendor/` and the location from which that is copied | ||
is in `./vendor.conf`. Go to the referenced repo/tag and you'll find all the patches applied | ||
to upstream Kubernetes. |