Skip to content

Commit a341340

Browse files
mbobrovskyimbobrovskyi
authored
Added kueuectl-docs generator. (#2613)
* Added kueuectl-docs generator. * Bump gcb-docker-gcloud.
1 parent 0b793df commit a341340

File tree

60 files changed

+11469
-331
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+11469
-331
lines changed

‎Makefile

+9-2
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ shell-lint: ## Run shell linting.
171171
$(PROJECT_DIR)/hack/verify-shellcheck.sh
172172

173173
.PHONY: verify
174-
verify: gomod-verify ci-lint fmt-verify shell-lint toc-verify manifests generate update-helm generate-apiref prepare-release-branch
174+
verify: gomod-verify ci-lint fmt-verify shell-lint toc-verify manifests generate update-helm generate-apiref generate-kueuectl-docs prepare-release-branch
175175
git --no-pager diff --exit-code config/components apis charts/kueue/templates client-go site/
176176

177177
##@ Build
@@ -320,8 +320,15 @@ importer-image: importer-image-build
320320

321321
.PHONY: kueuectl
322322
kueuectl:
323-
$(GO_BUILD_ENV) $(GO_CMD) build -ldflags="$(LD_FLAGS)" -o bin/kubectl-kueue cmd/kueuectl/main.go
323+
$(GO_BUILD_ENV) $(GO_CMD) build -ldflags="$(LD_FLAGS)" -o $(PROJECT_DIR)/bin/kubectl-kueue cmd/kueuectl/main.go
324324

325325
.PHONY: generate-apiref
326326
generate-apiref: genref
327327
cd $(PROJECT_DIR)/hack/genref/ && $(GENREF) -o $(PROJECT_DIR)/site/content/en/docs/reference
328+
329+
.PHONY: generate-kueuectl-docs
330+
generate-kueuectl-docs: kueuectl-docs
331+
rm -Rf $(PROJECT_DIR)/site/content/en/docs/reference/kubectl-kueue/commands/kueuectl*
332+
$(PROJECT_DIR)/bin/kueuectl-docs \
333+
$(PROJECT_DIR)/hack/internal/tools/kueuectl-docs/templates \
334+
$(PROJECT_DIR)/site/content/en/docs/reference/kubectl-kueue/commands

‎Makefile-deps.mk

+6
Original file line numberDiff line numberDiff line change
@@ -129,3 +129,9 @@ cluster-autoscaler-crd: ## Copy the CRDs from the cluster-autoscaler to the dep-
129129
.PHONY: dep-crds
130130
dep-crds: mpi-operator-crd kf-training-operator-crd ray-operator-crd jobset-operator-crd cluster-autoscaler-crd ## Copy the CRDs from the external operators to the dep-crds directory.
131131
@echo "Copying CRDs from external operators to dep-crds directory"
132+
133+
.PHONY: kueuectl-docs
134+
kueuectl-docs:
135+
cd $(PROJECT_DIR)/hack/internal/tools && \
136+
go mod download && \
137+
$(GO_BUILD_ENV) $(GO_CMD) build -ldflags="$(LD_FLAGS)" -o $(PROJECT_DIR)/bin/kueuectl-docs ./kueuectl-docs/main.go

‎cloudbuild.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ timeout: 3000s
44
# For each build step, Prow executes a job.
55
steps:
66
# see https://github.com/kubernetes/test-infra/tree/master/config/jobs/image-pushing
7-
- name: 'gcr.io/k8s-staging-test-infra/gcb-docker-gcloud:v20240523-a15ad90fc9'
7+
- name: 'gcr.io/k8s-staging-test-infra/gcb-docker-gcloud:v20240718-5ef92b5c36'
88
entrypoint: make
99
args:
1010
- image-push

‎hack/internal/tools/go.mod

+40-23
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
module sigs.k8s.io/kueue/internal/tools
22

3-
go 1.22.3
3+
go 1.22.4
44

55
require (
66
github.com/gohugoio/hugo v0.128.2
77
github.com/golangci/golangci-lint v1.59.1
88
github.com/mikefarah/yq/v4 v4.44.2
99
github.com/onsi/ginkgo/v2 v2.19.0
10+
github.com/spf13/cobra v1.8.1
11+
github.com/spf13/pflag v1.0.5
1012
gotest.tools/gotestsum v1.12.0
1113
helm.sh/helm/v3 v3.15.3
1214
k8s.io/code-generator v0.30.2
13-
sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20240522175850-2e9781e9fc60
15+
k8s.io/component-base v0.30.2
16+
sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20240605185440-12cc8d59fabe
1417
sigs.k8s.io/controller-tools v0.15.0
1518
sigs.k8s.io/kind v0.23.0
19+
sigs.k8s.io/kueue v0.0.0-00010101000000-000000000000
1620
sigs.k8s.io/kustomize/kustomize/v4 v4.5.7
1721
)
1822

23+
replace sigs.k8s.io/kueue => ../../..
24+
1925
require (
2026
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
2127
github.com/BurntSushi/toml v1.4.0 // indirect
@@ -25,37 +31,43 @@ require (
2531
github.com/a8m/envsubst v1.4.2 // indirect
2632
github.com/alecthomas/assert/v2 v2.7.0 // indirect
2733
github.com/alecthomas/participle/v2 v2.1.1 // indirect
28-
github.com/asaskevich/govalidator v0.0.0-20200428143746-21a406dcc535 // indirect
34+
github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
35+
github.com/beorn7/perks v1.0.1 // indirect
2936
github.com/bitfield/gotestdox v0.2.2 // indirect
37+
github.com/blang/semver/v4 v4.0.0 // indirect
38+
github.com/cespare/xxhash/v2 v2.3.0 // indirect
3039
github.com/cyphar/filepath-securejoin v0.2.4 // indirect
3140
github.com/davecgh/go-spew v1.1.1 // indirect
3241
github.com/dimchansky/utfbom v1.1.1 // indirect
3342
github.com/dnephin/pflag v1.0.7 // indirect
3443
github.com/elliotchance/orderedmap v1.6.0 // indirect
35-
github.com/emicklei/go-restful/v3 v3.11.0 // indirect
36-
github.com/evanphx/json-patch v5.7.0+incompatible // indirect
44+
github.com/emicklei/go-restful/v3 v3.12.1 // indirect
45+
github.com/evanphx/json-patch v5.9.0+incompatible // indirect
46+
github.com/evanphx/json-patch/v5 v5.9.0 // indirect
3747
github.com/fatih/color v1.17.0 // indirect
3848
github.com/fsnotify/fsnotify v1.7.0 // indirect
3949
github.com/go-errors/errors v1.4.2 // indirect
40-
github.com/go-logr/logr v1.4.1 // indirect
41-
github.com/go-openapi/jsonpointer v0.20.2 // indirect
42-
github.com/go-openapi/jsonreference v0.20.2 // indirect
43-
github.com/go-openapi/swag v0.22.8 // indirect
50+
github.com/go-logr/logr v1.4.2 // indirect
51+
github.com/go-openapi/jsonpointer v0.21.0 // indirect
52+
github.com/go-openapi/jsonreference v0.21.0 // indirect
53+
github.com/go-openapi/swag v0.23.0 // indirect
4454
github.com/gobuffalo/flect v1.0.2 // indirect
4555
github.com/gobwas/glob v0.2.3 // indirect
4656
github.com/goccy/go-json v0.10.3 // indirect
4757
github.com/goccy/go-yaml v1.11.3 // indirect
4858
github.com/gogo/protobuf v1.3.2 // indirect
59+
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
4960
github.com/golang/protobuf v1.5.4 // indirect
5061
github.com/google/btree v1.0.1 // indirect
5162
github.com/google/gnostic-models v0.6.8 // indirect
63+
github.com/google/go-cmp v0.6.0 // indirect
5264
github.com/google/gofuzz v1.2.0 // indirect
5365
github.com/google/pprof v0.0.0-20240424215950-a892ee059fd6 // indirect
5466
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
55-
github.com/google/uuid v1.4.0 // indirect
67+
github.com/google/uuid v1.6.0 // indirect
5668
github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7 // indirect
5769
github.com/huandu/xstrings v1.4.0 // indirect
58-
github.com/imdario/mergo v0.3.13 // indirect
70+
github.com/imdario/mergo v0.3.16 // indirect
5971
github.com/inconshreveable/mousetrap v1.1.0 // indirect
6072
github.com/jinzhu/copier v0.4.0 // indirect
6173
github.com/josharian/intern v1.0.0 // indirect
@@ -65,6 +77,7 @@ require (
6577
github.com/mailru/easyjson v0.7.7 // indirect
6678
github.com/mattn/go-colorable v0.1.13 // indirect
6779
github.com/mattn/go-isatty v0.0.20 // indirect
80+
github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 // indirect
6881
github.com/mitchellh/copystructure v1.2.0 // indirect
6982
github.com/mitchellh/reflectwalk v1.0.2 // indirect
7083
github.com/moby/term v0.5.0 // indirect
@@ -75,44 +88,48 @@ require (
7588
github.com/pelletier/go-toml/v2 v2.2.2 // indirect
7689
github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
7790
github.com/pkg/errors v0.9.1 // indirect
91+
github.com/prometheus/client_golang v1.18.0 // indirect
92+
github.com/prometheus/client_model v0.6.1 // indirect
93+
github.com/prometheus/common v0.45.0 // indirect
94+
github.com/prometheus/procfs v0.12.0 // indirect
7895
github.com/shopspring/decimal v1.3.1 // indirect
7996
github.com/spf13/afero v1.11.0 // indirect
8097
github.com/spf13/cast v1.6.0 // indirect
81-
github.com/spf13/cobra v1.8.0 // indirect
82-
github.com/spf13/pflag v1.0.5 // indirect
8398
github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
8499
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
85100
github.com/xeipuuv/gojsonschema v1.2.0 // indirect
86101
github.com/xlab/treeprint v1.2.0 // indirect
87102
github.com/yuin/gopher-lua v1.1.1 // indirect
88103
go.starlark.net v0.0.0-20230525235612-a134d8f9ddca // indirect
89104
golang.org/x/crypto v0.24.0 // indirect
105+
golang.org/x/exp v0.0.0-20240530194437-404ba88c7ed0 // indirect
90106
golang.org/x/mod v0.18.0 // indirect
91107
golang.org/x/net v0.26.0 // indirect
92-
golang.org/x/oauth2 v0.15.0 // indirect
108+
golang.org/x/oauth2 v0.20.0 // indirect
93109
golang.org/x/sync v0.7.0 // indirect
94110
golang.org/x/sys v0.21.0 // indirect
95111
golang.org/x/term v0.21.0 // indirect
96112
golang.org/x/text v0.16.0 // indirect
97113
golang.org/x/time v0.5.0 // indirect
98114
golang.org/x/tools v0.22.0 // indirect
99115
golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
100-
google.golang.org/appengine v1.6.8 // indirect
101-
google.golang.org/protobuf v1.33.0 // indirect
116+
gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
117+
google.golang.org/protobuf v1.34.1 // indirect
102118
gopkg.in/inf.v0 v0.9.1 // indirect
103119
gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473 // indirect
104120
gopkg.in/yaml.v2 v2.4.0 // indirect
105121
gopkg.in/yaml.v3 v3.0.1 // indirect
106-
k8s.io/api v0.30.0 // indirect
107-
k8s.io/apiextensions-apiserver v0.30.0 // indirect
122+
k8s.io/api v0.30.2 // indirect
123+
k8s.io/apiextensions-apiserver v0.30.1 // indirect
108124
k8s.io/apimachinery v0.30.2 // indirect
109-
k8s.io/apiserver v0.30.0 // indirect
125+
k8s.io/apiserver v0.30.1 // indirect
110126
k8s.io/cli-runtime v0.30.0 // indirect
111-
k8s.io/client-go v0.30.0 // indirect
112-
k8s.io/gengo/v2 v2.0.0-20240228010128-51d4e06bde70 // indirect
127+
k8s.io/client-go v0.30.2 // indirect
128+
k8s.io/gengo/v2 v2.0.0-20240404160639-a0386bf69313 // indirect
113129
k8s.io/klog/v2 v2.120.1 // indirect
114-
k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
115-
k8s.io/utils v0.0.0-20230726121419-3b25d923346b // indirect
130+
k8s.io/kube-openapi v0.0.0-20240521193020-835d969ad83a // indirect
131+
k8s.io/utils v0.0.0-20240502163921-fe8a2dddb1d0 // indirect
132+
sigs.k8s.io/controller-runtime v0.18.4 // indirect
116133
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
117134
sigs.k8s.io/kustomize/api v0.13.5-0.20230601165947-6ce0bf390ce3 // indirect
118135
sigs.k8s.io/kustomize/kyaml v0.14.3-0.20230601165947-6ce0bf390ce3 // indirect

0 commit comments

Comments
 (0)