mirror of
https://github.com/kubernetes/kubernetes.git
synced 2026-02-18 18:28:18 -05:00
65b841c077
This creates go.work and enables Go Workspaces. This is a file that
includes info on k/k and all the staging modules.
This depends on go 1.22 and setting FORCE_HOST_GO=true (for kube
scripts, which try to be hermetic).
Make this part of the normal update/verify sequence.
The top-level go.work file contains no replace statements. Instead, the
replace statements in the individual go.mod files are used. For this to
work, replace statements in the individual go.mod files have to be
consistent.
hack/tools has different dependencies and can't be in the main
workspace, so this adds a go.work just for that. Without this, go tries
to consider all deps in all modules and pick one that works for all.
This is problematic because there are so many of them that it is
difficult to manage.
Likewise for k8s.io/code-generator/examples and
k8s.io/kms/internal/plugins/_mock - add trivial go.work files.
For example k/k depends on an older version of a lib that gloangci-lint
needs (transitively) and it breaks.
This also updates vendor (needed to make go happy), and removes
vendor'ed symlinks. This breaks a LOT of our build tools, which will be
fixed subsequently.
Result: `go` commands work across modules:
Before:
```
$ go list ./pkg/proxy/iptables/ ./staging/src/k8s.io/api/core/v1/
main module (k8s.io/kubernetes) does not contain package k8s.io/kubernetes/staging/src/k8s.io/api/core/v1
$ go build ./pkg/proxy/iptables/ ./staging/src/k8s.io/api
main module (k8s.io/kubernetes) does not contain package k8s.io/kubernetes/staging/src/k8s.io/api
$ go test ./pkg/proxy/iptables/ ./staging/src/k8s.io/api
main module (k8s.io/kubernetes) does not contain package k8s.io/kubernetes/staging/src/k8s.io/api
```
After:
```
$ go list ./pkg/proxy/iptables/ ./staging/src/k8s.io/api/core/v1/
k8s.io/kubernetes/pkg/proxy/iptables
k8s.io/api/core/v1
$ go build ./pkg/proxy/iptables/ ./staging/src/k8s.io/api
$ go test ./pkg/proxy/iptables/ ./staging/src/k8s.io/api
ok k8s.io/kubernetes/pkg/proxy/iptables 0.360s
ok k8s.io/api 2.302s
```
Result: `make` fails:
```
$ make
go version go1.22rc1 linux/amd64
+++ [0106 12:11:03] Building go targets for linux/amd64
k8s.io/kubernetes/cmd/kube-proxy (static)
k8s.io/kubernetes/cmd/kube-apiserver (static)
k8s.io/kubernetes/cmd/kube-controller-manager (static)
k8s.io/kubernetes/cmd/kubelet (non-static)
k8s.io/kubernetes/cmd/kubeadm (static)
k8s.io/kubernetes/cmd/kube-scheduler (static)
k8s.io/component-base/logs/kube-log-runner (static)
k8s.io/kube-aggregator (static)
k8s.io/apiextensions-apiserver (static)
k8s.io/kubernetes/cluster/gce/gci/mounter (static)
k8s.io/kubernetes/cmd/kubectl (static)
k8s.io/kubernetes/cmd/kubectl-convert (static)
github.com/onsi/ginkgo/v2/ginkgo (non-static)
k8s.io/kubernetes/test/e2e/e2e.test (test)
k8s.io/kubernetes/test/conformance/image/go-runner (non-static)
k8s.io/kubernetes/cmd/kubemark (static)
github.com/onsi/ginkgo/v2/ginkgo (non-static)
k8s.io/kubernetes/test/e2e_node/e2e_node.test (test)
test/e2e/e2e.go:35:2: cannot find package "k8s.io/api/apps/v1" in any of:
/home/thockin/src/kubernetes/_output/local/go/src/k8s.io/kubernetes/vendor/k8s.io/api/apps/v1 (vendor tree)
/home/thockin/src/kubernetes/_output/local/.gimme/versions/go1.22rc1.linux.amd64/src/k8s.io/api/apps/v1 (from $GOROOT)
/home/thockin/src/kubernetes/_output/local/go/src/k8s.io/api/apps/v1 (from $GOPATH)
... more ...
... more ...
... more ...
!!! [0106 12:13:41] Call tree:
!!! [0106 12:13:41] 1: /home/thockin/src/kubernetes/hack/lib/golang.sh:948 kube::golang::build_binaries_for_platform(...)
!!! [0106 12:13:41] 2: hack/make-rules/build.sh:27 kube::golang::build_binaries(...)
!!! [0106 12:13:41] Call tree:
!!! [0106 12:13:41] 1: hack/make-rules/build.sh:27 kube::golang::build_binaries(...)
!!! [0106 12:13:41] Call tree:
!!! [0106 12:13:41] 1: hack/make-rules/build.sh:27 kube::golang::build_binaries(...)
make: *** [Makefile:96: all] Error 1
```
Again, this requires go 1.22 (e.g. gotip), as go 1.21.x does not have
`go work vendor` support.
TO REPEAT:
( \
./hack/update-go-workspace.sh; \
./hack/update-vendor.sh; \
./hack/update-go-workspace.sh; \
)
|
||
|---|---|---|
| .. | ||
| boilerplate | ||
| conformance | ||
| e2e-internal | ||
| gen-swagger-doc | ||
| jenkins | ||
| lib | ||
| make-rules | ||
| testdata | ||
| tools | ||
| verify-flags | ||
| .descriptions_failures | ||
| .import-aliases | ||
| .spelling_failures | ||
| benchmark-go.sh | ||
| build-cross.sh | ||
| build-go.sh | ||
| cherry_pick_pull.sh | ||
| dev-build-and-push.sh | ||
| dev-build-and-up.sh | ||
| dev-push-conformance.sh | ||
| e2e-node-test.sh | ||
| generate-docs.sh | ||
| get-build.sh | ||
| ginkgo-e2e.sh | ||
| golangci-hints.yaml | ||
| golangci-strict.yaml | ||
| golangci.yaml | ||
| golangci.yaml.in | ||
| grab-profiles.sh | ||
| install-etcd.sh | ||
| install-protoc.sh | ||
| lint-dependencies.sh | ||
| list-feature-tests.sh | ||
| local-up-cluster.sh | ||
| logcheck.conf | ||
| module-graph.sh | ||
| OWNERS | ||
| pin-dependency.sh | ||
| print-workspace-status.sh | ||
| README.md | ||
| run-in-gopath.sh | ||
| run-prometheus-on-etcd-scrapes.sh | ||
| serve-prom-scrapes.sh | ||
| test-go.sh | ||
| test-integration.sh | ||
| unwanted-dependencies.json | ||
| update-all.sh | ||
| update-codegen.sh | ||
| update-conformance-yaml.sh | ||
| update-generated-api-compatibility-data.sh | ||
| update-generated-docs.sh | ||
| update-generated-proto-bindings-dockerized.sh | ||
| update-generated-protobuf-dockerized.sh | ||
| update-generated-stable-metrics.sh | ||
| update-go-workspace.sh | ||
| update-gofmt.sh | ||
| update-golangci-lint-config.sh | ||
| update-import-aliases.sh | ||
| update-internal-modules.sh | ||
| update-kustomize.sh | ||
| update-mocks.sh | ||
| update-netparse-cve.sh | ||
| update-openapi-spec.sh | ||
| update-translations.sh | ||
| update-vanity-imports.sh | ||
| update-vendor-licenses.sh | ||
| update-vendor.sh | ||
| update-yamlfmt.sh | ||
| verify-all.sh | ||
| verify-api-groups.sh | ||
| verify-boilerplate.sh | ||
| verify-cli-conventions.sh | ||
| verify-codegen.sh | ||
| verify-conformance-requirements.sh | ||
| verify-conformance-yaml.sh | ||
| verify-description.sh | ||
| verify-e2e-suites.sh | ||
| verify-e2e-test-ownership.sh | ||
| verify-external-dependencies-version.sh | ||
| verify-fieldname-docs.sh | ||
| verify-file-sizes.sh | ||
| verify-flags-underscore.py | ||
| verify-generated-docs.sh | ||
| verify-generated-stable-metrics.sh | ||
| verify-go-workspace.sh | ||
| verify-gofmt.sh | ||
| verify-golangci-lint-config.sh | ||
| verify-golangci-lint-pr-hints.sh | ||
| verify-golangci-lint-pr.sh | ||
| verify-golangci-lint.sh | ||
| verify-govulncheck.sh | ||
| verify-import-aliases.sh | ||
| verify-import-boss.sh | ||
| verify-imports.sh | ||
| verify-internal-modules.sh | ||
| verify-licenses.sh | ||
| verify-mocks.sh | ||
| verify-netparse-cve.sh | ||
| verify-no-vendor-cycles.sh | ||
| verify-non-mutating-validation.sh | ||
| verify-openapi-docs-urls.sh | ||
| verify-openapi-spec.sh | ||
| verify-pkg-names.sh | ||
| verify-prerelease-lifecycle-tags.sh | ||
| verify-prometheus-imports.sh | ||
| verify-publishing-bot.py | ||
| verify-readonly-packages.sh | ||
| verify-shellcheck.sh | ||
| verify-spelling.sh | ||
| verify-staging-meta-files.sh | ||
| verify-test-code.sh | ||
| verify-test-featuregates.sh | ||
| verify-test-images.sh | ||
| verify-testing-import.sh | ||
| verify-typecheck-providerless.sh | ||
| verify-typecheck.sh | ||
| verify-vendor-licenses.sh | ||
| verify-vendor.sh | ||
| verify-yamlfmt.sh | ||
Kubernetes hack GuideLines
This document describes how you can use the scripts from hack directory
and gives a brief introduction and explanation of these scripts.
Overview
The hack directory contains many scripts that ensure continuous development of kubernetes,
enhance the robustness of the code, improve development efficiency, etc.
The explanations and descriptions of these scripts are helpful for contributors.
For details, refer to the following guidelines.
Key scripts
verify-all.sh: This script is a vestigial redirection, Please do not add "real" logic. It is equivalent tomake verify.update-all.sh: This script is a vestigial redirection, Please do not add "real" logic. Thetruetarget of this makerule ishack/make-rules/update.sh.It is equivalent tomake update.
Attention
Note that all scripts must be run from the Kubernetes root directory.
We should run hack/verify-all.sh before submitting a PR and if anything fails run hack/update-all.sh.