-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMakefile
More file actions
256 lines (215 loc) · 9.35 KB
/
Copy pathMakefile
File metadata and controls
256 lines (215 loc) · 9.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
BINARY := bin/kubernetes-ontology
DAEMON_BINARY := bin/kubernetes-ontologyd
VIEWER_BINARY := bin/kubernetes-ontology-viewer
OWL_FILE ?= docs/ontology/kubernetes-ontology.owl
VERSION ?= $(shell git describe --tags --dirty --always 2>/dev/null || echo dev)
COMMIT ?= $(shell git rev-parse --short HEAD 2>/dev/null || echo unknown)
DATE ?= $(shell date -u +%Y-%m-%dT%H:%M:%SZ)
BUILDINFO_PACKAGE := github.com/Colvin-Y/kubernetes-ontology/internal/buildinfo
BUILDINFO_LDFLAGS := -X $(BUILDINFO_PACKAGE).Version=$(VERSION) -X $(BUILDINFO_PACKAGE).Commit=$(COMMIT) -X $(BUILDINFO_PACKAGE).Date=$(DATE)
DEFAULT_CONFIG := local/kubernetes-ontology.yaml
CONFIG ?= $(if $(wildcard $(DEFAULT_CONFIG)),$(DEFAULT_CONFIG),)
KUBECONFIG ?=
CLUSTER ?= default-cluster
NAMESPACE ?=
NAMESPACES ?=
NAME ?=
CONTEXT_NAMESPACES ?= $(if $(NAMESPACES),$(NAMESPACES),$(NAMESPACE))
WORKLOAD_RESOURCES ?=
CONTROLLER_RULES ?=
MAX_DEPTH ?= 2
STORAGE_MAX_DEPTH ?= 5
MAX_NODES ?=
MAX_EDGES ?=
RECIPE ?=
BOOTSTRAP_TIMEOUT ?= 2m
OBSERVE_DURATION ?= 40s
POLL_INTERVAL ?= 2s
VIEWER_HOST ?= 127.0.0.1
VIEWER_PORT ?= 8765
SERVER_ADDR ?= 127.0.0.1:18080
SERVER_URL ?= http://127.0.0.1:18080
VIEWER_URL ?= http://$(VIEWER_HOST):$(VIEWER_PORT)
ENTITY_ID ?=
GRAPH_FILE ?=
ENTITY_KIND ?=
RELATION_KIND ?=
FROM_ID ?=
TO_ID ?=
DIRECTION ?= both
LIMIT ?= 50
EXPAND_DEPTH ?= 1
OVERRIDE_ORIGINS := command line environment override
make_arg = $(if $(filter $(OVERRIDE_ORIGINS),$(origin $(1))),--$(2) "$($(1))")
make_context_namespaces_arg = $(if $(filter $(OVERRIDE_ORIGINS),$(origin CONTEXT_NAMESPACES) $(origin NAMESPACES)),--context-namespaces "$(CONTEXT_NAMESPACES)")
make_diagnostic_budget_args = $(call make_arg,MAX_NODES,max-nodes) $(call make_arg,MAX_EDGES,max-edges)
make_diagnostic_recipe_arg = $(call make_arg,RECIPE,recipe)
CLI_CONFIG_OVERRIDES = $(call make_arg,KUBECONFIG,kubeconfig) $(call make_arg,CLUSTER,cluster) $(make_context_namespaces_arg) $(call make_arg,WORKLOAD_RESOURCES,workload-resources) $(call make_arg,CONTROLLER_RULES,controller-rules) $(call make_arg,BOOTSTRAP_TIMEOUT,bootstrap-timeout)
DAEMON_CONFIG_OVERRIDES = $(CLI_CONFIG_OVERRIDES) $(call make_arg,SERVER_ADDR,addr) $(call make_arg,POLL_INTERVAL,poll-interval)
CLI_CONFIG_ARGS = $(if $(CONFIG),--config "$(CONFIG)" $(CLI_CONFIG_OVERRIDES),--kubeconfig "$(KUBECONFIG)" --cluster "$(CLUSTER)" --context-namespaces "$(CONTEXT_NAMESPACES)" --workload-resources "$(WORKLOAD_RESOURCES)" --controller-rules "$(CONTROLLER_RULES)" --bootstrap-timeout "$(BOOTSTRAP_TIMEOUT)")
DAEMON_CONFIG_ARGS = $(if $(CONFIG),--config "$(CONFIG)" $(DAEMON_CONFIG_OVERRIDES),--kubeconfig "$(KUBECONFIG)" --cluster "$(CLUSTER)" --context-namespaces "$(CONTEXT_NAMESPACES)" --workload-resources "$(WORKLOAD_RESOURCES)" --controller-rules "$(CONTROLLER_RULES)" --addr "$(SERVER_ADDR)" --bootstrap-timeout "$(BOOTSTRAP_TIMEOUT)" --poll-interval "$(POLL_INTERVAL)")
.PHONY: build build-daemon build-viewer docker-build owl test verify ci ci-go ci-helm ci-binaries ci-client ci-visualize ci-kind-e2e run serve status status-server list-entities-server get-entity-server list-relations-server neighbors-server expand-node-server collapse-node-graph observe-status diagnose-pod diagnose-workload diagnose-helm-release diagnose-pod-server diagnose-workload-server diagnose-helm-release-server visualize visualize-go visualize-check live-check verify-live require-kubeconfig require-entry
build:
mkdir -p bin
go build -ldflags "$(BUILDINFO_LDFLAGS)" -o $(BINARY) ./cmd/kubernetes-ontology
build-daemon:
mkdir -p bin
go build -ldflags "$(BUILDINFO_LDFLAGS)" -o $(DAEMON_BINARY) ./cmd/kubernetes-ontologyd
build-viewer:
mkdir -p bin
go build -ldflags "$(BUILDINFO_LDFLAGS)" -o $(VIEWER_BINARY) ./cmd/kubernetes-ontology-viewer
docker-build:
docker build --build-arg VERSION="$(VERSION)" --build-arg COMMIT="$(COMMIT)" --build-arg DATE="$(DATE)" -t kubernetes-ontology:dev .
owl:
go run ./cmd/kubernetes-ontology-owl --output "$(OWL_FILE)"
test:
go test -p 1 ./...
verify: test visualize-check
ci: ci-go ci-helm ci-binaries ci-client ci-visualize
ci-go: test
ci-helm:
bash scripts/ci/verify_helm.sh
ci-binaries:
bash scripts/ci/verify_binaries.sh
ci-client: build
bash scripts/ci/verify_client.sh
ci-visualize: build-viewer visualize-check
bash scripts/ci/verify_viewer.sh
ci-kind-e2e:
bash scripts/ci/verify_kind_e2e.sh
run: build
$(BINARY) $(ARGS)
serve: build-daemon require-kubeconfig
$(DAEMON_BINARY) $(DAEMON_CONFIG_ARGS)
status: build require-kubeconfig
$(BINARY) $(CLI_CONFIG_ARGS) --status-only
status-server: build
$(BINARY) --server "$(SERVER_URL)" --status-only
list-entities-server: build
$(BINARY) \
--server "$(SERVER_URL)" \
--list-entities \
--entity-kind "$(ENTITY_KIND)" \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--limit "$(LIMIT)"
get-entity-server: build
$(BINARY) \
--server "$(SERVER_URL)" \
--get-entity \
--entity-id "$(ENTITY_ID)" \
--entity-kind "$(ENTITY_KIND)" \
--namespace "$(NAMESPACE)" \
--name "$(NAME)"
list-relations-server: build
$(BINARY) \
--server "$(SERVER_URL)" \
--list-relations \
--from "$(FROM_ID)" \
--to "$(TO_ID)" \
--relation-kind "$(RELATION_KIND)" \
--limit "$(LIMIT)"
neighbors-server: build
$(BINARY) \
--server "$(SERVER_URL)" \
--neighbors \
--entity-id "$(ENTITY_ID)" \
--relation-kind "$(RELATION_KIND)" \
--direction "$(DIRECTION)" \
--limit "$(LIMIT)"
expand-node-server: build
$(BINARY) \
--server "$(SERVER_URL)" \
--expand-node \
--entity-id "$(ENTITY_ID)" \
--expand-depth "$(EXPAND_DEPTH)" \
--relation-kind "$(RELATION_KIND)" \
--direction "$(DIRECTION)" \
--limit "$(LIMIT)"
collapse-node-graph: build
$(BINARY) \
--collapse-node \
--graph-file "$(GRAPH_FILE)" \
--entity-id "$(ENTITY_ID)"
observe-status: build require-kubeconfig
$(BINARY) \
$(CLI_CONFIG_ARGS) \
--status-only \
--observe-duration "$(OBSERVE_DURATION)" \
--poll-interval "$(POLL_INTERVAL)"
diagnose-pod: build require-kubeconfig require-entry
$(BINARY) \
$(CLI_CONFIG_ARGS) \
--entry-kind Pod \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--max-depth "$(MAX_DEPTH)" \
--storage-max-depth "$(STORAGE_MAX_DEPTH)" $(make_diagnostic_budget_args) $(make_diagnostic_recipe_arg)
diagnose-workload: build require-kubeconfig require-entry
$(BINARY) \
$(CLI_CONFIG_ARGS) \
--entry-kind Workload \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--max-depth "$(MAX_DEPTH)" \
--storage-max-depth "$(STORAGE_MAX_DEPTH)" $(make_diagnostic_budget_args) $(make_diagnostic_recipe_arg)
diagnose-helm-release: build require-kubeconfig require-entry
$(BINARY) \
$(CLI_CONFIG_ARGS) \
--diagnose-helm-release \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--max-depth "$(MAX_DEPTH)" \
--storage-max-depth "$(STORAGE_MAX_DEPTH)" $(make_diagnostic_budget_args) $(make_diagnostic_recipe_arg)
diagnose-pod-server: build require-entry
$(BINARY) \
--server "$(SERVER_URL)" \
--entry-kind Pod \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--max-depth "$(MAX_DEPTH)" \
--storage-max-depth "$(STORAGE_MAX_DEPTH)" $(make_diagnostic_budget_args) $(make_diagnostic_recipe_arg)
diagnose-workload-server: build require-entry
$(BINARY) \
--server "$(SERVER_URL)" \
--entry-kind Workload \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--max-depth "$(MAX_DEPTH)" \
--storage-max-depth "$(STORAGE_MAX_DEPTH)" $(make_diagnostic_budget_args) $(make_diagnostic_recipe_arg)
diagnose-helm-release-server: build require-entry
$(BINARY) \
--server "$(SERVER_URL)" \
--diagnose-helm-release \
--namespace "$(NAMESPACE)" \
--name "$(NAME)" \
--max-depth "$(MAX_DEPTH)" \
--storage-max-depth "$(STORAGE_MAX_DEPTH)" $(make_diagnostic_budget_args) $(make_diagnostic_recipe_arg)
visualize:
@echo "Starting ontology viewer on http://$(VIEWER_HOST):$(VIEWER_PORT)"
@echo "Default ontology server: $(SERVER_URL)"
@echo "Press Ctrl+C to stop the viewer."
ONTOLOGY_SERVER="$(SERVER_URL)" python3 tools/visualize/server.py --host "$(VIEWER_HOST)" --port "$(VIEWER_PORT)"
visualize-go: build-viewer
@echo "Starting dependency-free ontology viewer on http://$(VIEWER_HOST):$(VIEWER_PORT)"
@echo "Default ontology server: $(SERVER_URL)"
@echo "Press Ctrl+C to stop the viewer."
$(VIEWER_BINARY) --host "$(VIEWER_HOST)" --port "$(VIEWER_PORT)" --server "$(SERVER_URL)"
visualize-check:
python3 -m py_compile tools/visualize/server.py
python3 -m unittest discover -s tools/visualize -p '*_test.py'
@test -f tools/visualize/index.html || (echo "tools/visualize/index.html is missing" && exit 1)
live-check: build require-entry
@echo "Checking ontology API at $(SERVER_URL)"
curl -fsS "$(SERVER_URL)/status" >/tmp/kubernetes-ontology-status.json
@echo "Checking viewer topology through $(VIEWER_URL)"
curl -fsS "$(VIEWER_URL)/topology?entityLimit=200&relationLimit=1000" >/tmp/kubernetes-ontology-topology.json
@echo "Checking viewer diagnostic for Pod $(NAMESPACE)/$(NAME)"
curl -fsS "$(VIEWER_URL)/diagnostic?kind=Pod&namespace=$(NAMESPACE)&name=$(NAME)&maxDepth=$(MAX_DEPTH)&storageMaxDepth=$(STORAGE_MAX_DEPTH)" >/tmp/kubernetes-ontology-diagnostic.json
@echo "Live verification passed."
verify-live: live-check
require-kubeconfig:
@test -n "$(CONFIG)$(KUBECONFIG)" || (echo "CONFIG or KUBECONFIG is required" && exit 1)
require-entry:
@test -n "$(NAMESPACE)" || (echo "NAMESPACE is required" && exit 1)
@test -n "$(NAME)" || (echo "NAME is required" && exit 1)