Skip to content

Commit a71cecb

Browse files
committed
enhanced the docker build documentation for readability and clarity
1 parent 6ac6016 commit a71cecb

File tree

3 files changed

+71
-2
lines changed

3 files changed

+71
-2
lines changed

build/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,26 @@ You must install and configure Google Cloud SDK if you want to upload your relea
1818

1919
## Overview
2020

21-
While it is possible to build Kubernetes using a local golang installation, we have a build process that runs in a Docker container. This simplifies initial set up and provides for a very consistent build and test environment.
21+
You can build Kubernetes in two environments:
22+
1. **Local `Go`** Environment, and
23+
2. **Docker Container** Environment
24+
25+
Building Kubernetes in a Docker container **simplifies the initial set-up** and provides a very consistent build and test environment.
26+
27+
## Clone the Repository
28+
Before you start building Kubernetes, make sure to clone the repository using the following command:
29+
```bash
30+
git clone https://github.com/kubernetes/kubernetes.git
31+
```
32+
Navigate to Kubernetes directory before executing scripts files:
33+
```bash
34+
cd kubernetes
35+
```
2236

2337
## Key scripts
38+
**Note:** Ensure you run all the scripts from the Kubernetes root directory.
2439

25-
The following scripts are found in the [`build/`](.) directory. Note that all scripts must be run from the Kubernetes root directory.
40+
The following scripts are found in the [`build/`](.) directory.
2641

2742
* [`build/run.sh`](run.sh): Run a command in a build docker container. Common invocations:
2843
* `build/run.sh make`: Build just linux binaries in the container. Pass options and packages as necessary.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
-----BEGIN RSA PRIVATE KEY-----
2+
MIIEowIBAAKCAQEAtR4J2EfXhbwKhbHAZUwGdT+K32Q/Qg6ZDw8Zz2AOHSbf+Qlh
3+
OF1fgR84ofUZ6wAS1PGBcQvERJHJJIzQJ98EUWRBFMIVgZcOlwHiv6hUh4cChKYJ
4+
Nv5qEgVUV4xz4Sy0sra1KJkt5lIHbRKm/Nv1xX6Rkcd0PLo76vvXllA9lSeflW7k
5+
3MoSmjUrbbYGHFQM9YXmXScLQrCXvxwepjrSTY6i1wTSBMxrSxXDy1OWVCvEfZ/Z
6+
XaEx9yyFCSHNeseLSVvKhaTN/dwB7qAA2bxxWNfjdmqARPzwaWrkq9RE5ONJfh8P
7+
mYntEPQn1sQ3k/mBr7iffJz+YJIWA8ETrhQdcwIDAQABAoIBAQCf9ZSqUOD3Oxlr
8+
9I5AqMF3YhRrseTwmWXy19pqvaIZexEKqI8Vsdm8d2+UEp2+YEVBjr5MsiC4kq08
9+
O6VH4X61x7527+cAmgIHumGh9bAaNlIyB1ZSHKZfnhdcby6U69/3isg6v/a62S23
10+
1mZnInlQ4LT+NFLjo3Nx2NUR63JIPMVe02v39Whp6l9LkI/3pyQrsGBjy4+gj9JU
11+
bmovI2UvxA5exupRSVmppfvd4Qm7ED+5M5cUo2UUm0vh9fGmRx47+mBQhuKKvD0d
12+
AkpqFEfPs+A2NHO4+2fCoaQkWYGH+W4jY1TcjxqOYjx2IaInn+JyOx6YyB2D78sg
13+
cmudnhdhAoGBAO1Emmj3hjHpinudqhf0YfPa0pGLtQmRfNkklSuv8A/lQq1TYdk7
14+
6Yzzw28P0RZkyT7eg8WNq+0fD0WhnvDzeEHMkT9zxtgavpQ7gWWXPQVG2RIMaEq5
15+
FXQkgLPITmQMl6MqG2su12K+jClU2/njrriER/ppwmWanzY88o+M5eoxAoGBAMNq
16+
lLPkTcCXiFQ5ZmJqIihgkO4OdYH1kHz2dSPPaZb7pLrVE/nFJn1ugN/90Vx3uWj+
17+
pqzwmeXszqNMT7HsDgjDRpXv7NENAB+OLG408EbKPp0k8C1tufiIr0QftNvIc/WQ
18+
jWeVzGVZV5qMjFZBq+8NENC4DJ0ZPABk6JWQe7TjAoGAJbh5X+SyJe89/+cR6psE
19+
k5MfVNpEHtBNa+wf9wEShkRpdErETJf0yl7anCaElC3TvLX9dwPN6HW+pNBMB3x9
20+
iuBt2wuZ+jNORxyqtq7zmYoo6nCkh/Siz4MaHvriU4+Y7+y6zTB2N5GZkNyX2EN1
21+
PIpzMwFrUWHim+nWmjHJP5ECgYBMwDOfY+/V0K5OxiycQqsfyK2jkjI81MHnErV3
22+
VyNVlYhhiQbLds9jPF+Jmhr8gllkD4BPNEB9ucB/Cp3Sd7AbaPb0NMOCZ+TAgAqb
23+
TleAtjZZagSbExmTr7uGuh1CpTxGGnwvTvp0Y96waLtFtY1d2nfcQi1SFnMmhHuF
24+
IrYzmQKBgH89h0DR6uWgGodtEoPyBltrzMZDRgiuLxJn5aYIH3b9IgnJ7MZIZ4pC
25+
b4y0gyzcWJ3mmJZ3igcZU9j+5f2NB5GWe6HAV8mDsKBOYOEDTiLf/xJF0tS+YQz9
26+
Q5slQTecoDMqKBinMegPak7PdTL5UhcDsd5WxtxpTa7YintWVh17
27+
-----END RSA PRIVATE KEY-----
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
-----BEGIN RSA PRIVATE KEY-----
2+
MIIEpAIBAAKCAQEAvXs+PNiBt0W4Xtsj0mdQyq4ZFpKjTYoJa1XURDWgPXf5e2xY
3+
A4RqyELViPNgfcBRtkbsHs6GUHUe3NpfbQVWDCdWXSm1ewvhb8qzQ218GmwwMt0V
4+
lnuXKNah45a3mZpLchMvLklqlUPtNpChCxRMI68AB/gaSLTh2UjBPAFvmg1/B1Lu
5+
tEsBrm44Q+a61kx5BDhPZD+FJ0MI0wDgrgAHaQEG8h5WzBqYHIvVhE8CEt2BWb/n
6+
nJpu+kwe/znTEKIRVAeGMNECp8Uyri5sSng9M1G0v0kUPK9ShrdHUAtuG6laGlLW
7+
H2O9pXN6y+FxKPdPOgekqVzQmImE6goIGkrdYwIDAQABAoIBAQC4UVWWjKmKJUkX
8+
BKbQ+m1t63M+MQCn4boN7lzgySWKBdXrCNaI/Vt+WP0tDkpzqQwTeuQfh5jCVVvj
9+
TI19GK6+fdmWIIeIHWN7grtkwPDzJwCvyb5BNxIwyLCMGkWZJq1zV1QS+5mxf3UW
10+
GhR+GY2DPK2UEvVGeqYj3pESFPeB6yX6wXnezlVDFt1seDOUmvCKWJMCAFDb6vL2
11+
0AECGjA+Tgk6d8BKUh0WbMzmucbtSo+NwCsEsa6UUrCKim/jTptUnOiISSv3IrYO
12+
eqwcmADvYP4k4XcjDdN+IYDaOR+cLT3PNb5EOo4gHenwb6bKOh5QM31Qk+DF+sqh
13+
CAQk7b5pAoGBAMWMNswg+N3rm/o0RLyR9CJZliPJucPme2ug2oMY6rLzmhjWgUMz
14+
wMZruMswhotie8bYTB2Mw3rHWwOr/9pw7Ak7ARKNlHh8HWkvt5gJRpp1l+vdw4yW
15+
VE1tTlHOcud2TIQmJNG17jcGmn1iwm1bZdva9vpRC40v5OoaoSBE+1LnAoGBAPWM
16+
BqD+g1nTX4ark7amK+3eoqWSY7kZs1HOuy9uLNcKaaaLHY+3vk3uk7uUK71AUd8Y
17+
Q6B4/W41rOXdO0EknkCoLFWi2ifsTV7bvXtMrJFgQytK1j9zauIp26Y4BpIeDHy5
18+
kMR8w02Uc3VpgBFKvljhBgSWe4a+STLbxGzKbs4lAoGAcG4bpdPCL/NvI1hqInRi
19+
4MXh6F5f5nmflqLGmkQtF0oDUs2KZefneEZItwPYHy4eyg3CTDMX8iHRz+YtSHJq
20+
M9qsApYngOcKihoJQHNPBouUuj3NlI7eTe6+21pHFSrD45Yd8Gi9uf19IY16oGib
21+
MSSO2eoUS/eNLhuXxljcPNMCgYEAyq1k/1h1dRx62f8fswCge/xrxjz6IVwsXpdE
22+
fJb1Xh6TLEvh/7HL3CnUOV3JaLIBoiM2FuwnS+P0LdwZP+EI2xe1WI5OgeuTxXud
23+
gHu+aVTKvJ5OEBulmr6wNhhCnDM/XWgSLY1J6+xgDQcjFaLbUSOUQw8vMP46D0fF
24+
b4L8SR0CgYAPAXBzBfx9+NX01lZHtmTv30HxVbw3Nkzv0CoVRTZ1gVcXbYFx1R3Q
25+
Tj5o23rTBVvatIpPfjlYMe9GKh3CSiOHWMOeQgD6LDNTHcKnaZFBz3qlzCFkdOfO
26+
dEShurtPHUrjEuz+Sa5G9N9n8+iY5ofy3FoNvglSo4rLqDJ/ytzzQQ==
27+
-----END RSA PRIVATE KEY-----

0 commit comments

Comments
 (0)