Skip to content

Commit 9a18b14

Browse files
feat: Add support for Hubble control plane in Retina agent (#432)
## Description This PR adds support for Hubble control plane in Retina agent. This is being done in the most backward compatible way possible. I am adding a new subcommand called `hubble-control-plane` which will start Hubble instead of existing control plane. ``` $ ./retina -h  ✔  took 5s  Start Retina Agent Usage: retina-agent [flags] retina-agent [command] Available Commands: completion Generate the autocompletion script for the specified shell help Help about any command hubble-control-plane Start Hubble control plane Flags: --config string config file (default "/retina/config/config.yaml") --health-probe-bind-address string The address the probe endpoint binds to. (default ":18081") -h, --help help for retina-agent --leader-elect Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. --metrics-bind-address string The address the metric endpoint binds to. (default ":18080") Use "retina-agent [command] --help" for more information about a command. $ $ $ ./retina  ✔ Starting Retina Agent starting Retina daemon with legacy control plane ... $ $ $ ./retina hubble-control-plane -h Start Hubble control plane Usage: retina-agent hubble-control-plane [flags] retina-agent hubble-control-plane [command] Available Commands: hive Inspect the hive Flags: --cluster-name string name of the cluster (default "default") ... $ $ $ ./retina hubble-control-plane --config-dir . ts=2024-06-13T18:20:47.888Z level=info caller=hubble/daemon_main.go:276 msg="Traces telemetry initialized with zapai" version= appInsightsID= time="2024-06-13T18:20:47Z" level=info msg=Invoked duration="483.869µs" function="pprof.init.func1 (pkg/pprof/cell.go:49)" subsys=hive time="2024-06-13T18:20:47Z" level=info msg=Invoked duration="77.011µs" function="gops.registerGopsHooks (pkg/gops/cell.go:38)" subsys=hive time="2024-06-13T18:20:47Z" level=info msg=Invoked duration=10.503879ms function="github.com/microsoft/retina/cmd/hubble.init.func3 (cmd/hubble/daemon.go:68)" subsys=hive time="2024-06-13T18:20:47Z" level=info msg="&{{ 0} [] 0s false true false false false false}" subsys=agent-config time="2024-06-13T18:20:47Z" level=info msg="configuring telemetry" app-insights-id= retina-version= subsys=telemetry time="2024-06-13T18:20:47Z" level=info msg="telemetry disabled" subsys=telemetry ts=2024-06-13T18:20:47.902Z level=info caller=metrics/metrics.go:169 msg="Metrics initialized" ... ``` ## Changes made - Adopting [Hive](https://docs.cilium.io/en/latest/contributing/development/hive/) for dependency injection - Moving to [Cobra](https://github.com/spf13/cobra) for CLI - `controller/main.go` now is just the starting point of the command - `retina/cmd` now houses `rootCmd` (starts retina as is) and `hubble` (starts Hubble control plane) - In terms of Dockerfiles, packaging `Hubble` cli in agent image - Adding new YAML files to install Retina with Hubble - Moved the current YAML files under `deploy/legacy` - Fix the links in `doc` - Update cilium version to pull in commits from upstream needed for starting Hubble - Update `init` to add a step that creates Cilium dirs (This will happen for current control plane as well, but it consumes no resources, just creates an empty directory) - All new packages under `pkg` contains business logic required to run Hubble (node reconciler, Hubble control plane, IPCache, etc.) - Minor changes to `test/e2e` to support change to deployment directory (`deploy` -> `deploy/legacy`) ## Related Issue #418 ## Checklist - [x] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [x] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [x] I have correctly attributed the author(s) of the code. - [x] I have tested the changes locally. - [x] I have followed the project's style guidelines. - [x] I have updated the documentation, if necessary. - [x] I have added tests, if applicable. ## Screenshots (if applicable) or Testing Completed ### Retina with Hubble ![image](https://github.com/microsoft/retina/assets/18243968/8e21e73c-e34e-4a8a-b7a3-7ede9c6cdf9a) ### Retina ![image](https://github.com/microsoft/retina/assets/18243968/0ab02857-ca30-4afa-bad8-eec5755c6358) --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project. Signed-off-by: Anubhab Majumdar <[email protected]>
1 parent 2cb7a83 commit 9a18b14

File tree

151 files changed

+20018
-471
lines changed

Some content is hidden

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

151 files changed

+20018
-471
lines changed

.github/workflows/release-charts.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
run: |
4141
set -euo pipefail
4242
export TAG=$(make version)
43-
helm package ./deploy/manifests/controller/helm/retina --version $TAG
43+
helm package ./deploy/legacy/manifests/controller/helm/retina --version $TAG
4444
# Get Helm chart's SHA digest from helm push cmd output
4545
helm push retina-$TAG.tgz oci://ghcr.io/${{ github.repository }}/charts >> helm_push_result.txt 2>&1
4646
cat helm_push_result.txt

.golangci.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ linters:
1212
disable:
1313
- maligned
1414
- scopelint
15+
- gci
1516
enable:
1617
- exportloopref
1718
- goconst

Makefile

+68-5
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,21 @@ PLATFORM ?= $(OS)/$(ARCH)
3434
PLATFORMS ?= linux/amd64 linux/arm64 windows/amd64
3535
OS_VERSION ?= ltsc2019
3636

37+
HUBBLE_VERSION ?= v0.13.0
38+
3739
CONTAINER_BUILDER ?= docker
3840
CONTAINER_RUNTIME ?= docker
3941
YEAR ?= 2022
4042

4143
ALL_ARCH.linux = amd64 arm64
4244
ALL_ARCH.windows = amd64
4345

46+
#######
47+
# TLS #
48+
#######
49+
ENABLE_TLS ?= true
50+
CERT_DIR := $(REPO_ROOT)/.certs
51+
4452
# TAG is OS and platform agonstic, which can be used for binary version and image manifest tag,
4553
# while RETINA_PLATFORM_TAG is platform specific, which can be used for image built for specific platforms.
4654
RETINA_PLATFORM_TAG ?= $(TAG)-$(subst /,-,$(PLATFORM))
@@ -236,6 +244,7 @@ container-docker: buildx # util target to build container images using docker bu
236244
--build-arg GOARCH=$$arch \
237245
--build-arg GOOS=$$os \
238246
--build-arg OS_VERSION=$(OS_VERSION) \
247+
--build-arg HUBBLE_VERSION=$(HUBBLE_VERSION) \
239248
--build-arg VERSION=$(VERSION) $(EXTRA_BUILD_ARGS) \
240249
--target=$(TARGET) \
241250
-t $(IMAGE_REGISTRY)/$(IMAGE):$(TAG) \
@@ -376,7 +385,7 @@ HELM_IMAGE_TAG ?= v0.0.2
376385

377386
# basic/node-level mode
378387
helm-install: manifests
379-
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
388+
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
380389
--namespace kube-system \
381390
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
382391
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -389,7 +398,7 @@ helm-install: manifests
389398
--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\]"
390399

391400
helm-install-with-operator: manifests
392-
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
401+
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
393402
--namespace kube-system \
394403
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
395404
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -406,7 +415,7 @@ helm-install-with-operator: manifests
406415

407416
# advanced/pod-level mode with scale limitations, where metrics are aggregated by source and destination Pod
408417
helm-install-advanced-remote-context: manifests
409-
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
418+
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
410419
--namespace kube-system \
411420
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
412421
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -425,7 +434,7 @@ helm-install-advanced-remote-context: manifests
425434

426435
# advanced/pod-level mode designed for scale, where metrics are aggregated by "local" Pod (source for outgoing traffic, destination for incoming traffic)
427436
helm-install-advanced-local-context: manifests
428-
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
437+
helm upgrade --install retina ./deploy/legacy/manifests/controller/helm/retina/ \
429438
--namespace kube-system \
430439
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
431440
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
@@ -442,9 +451,57 @@ helm-install-advanced-local-context: manifests
442451
--set enablePodLevel=true \
443452
--set enableAnnotations=true
444453

454+
helm-install-hubble:
455+
helm upgrade --install retina ./deploy/hubble/manifests/controller/helm/retina/ \
456+
--namespace kube-system \
457+
--set operator.enabled=true \
458+
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
459+
--set operator.tag=$(HELM_IMAGE_TAG) \
460+
--set agent.enabled=true \
461+
--set agent.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
462+
--set agent.tag=$(HELM_IMAGE_TAG) \
463+
--set agent.init.enabled=true \
464+
--set agent.init.repository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
465+
--set agent.init.tag=$(HELM_IMAGE_TAG) \
466+
--set logLevel=info \
467+
--set hubble.tls.enabled=$(ENABLE_TLS) \
468+
--set hubble.relay.tls.server.enabled=$(ENABLE_TLS) \
469+
--set hubble.tls.auto.enabled=$(ENABLE_TLS) \
470+
--set hubble.tls.auto.method=cronJob \
471+
--set hubble.tls.auto.certValidityDuration=1 \
472+
--set hubble.tls.auto.schedule="*/10 * * * *"
473+
474+
helm-install-without-tls: clean-certs
475+
$(MAKE) helm-install-hubble ENABLE_TLS=false
476+
445477
helm-uninstall:
446478
helm uninstall retina -n kube-system
447479

480+
.PHONY: get-certs
481+
get-certs:
482+
mkdir -p $(CERT_DIR)
483+
$(foreach kv,$(CERT_FILES),\
484+
$(eval FILE=$(word 1,$(subst :, ,$(kv)))) \
485+
$(eval CONFIG_KEY=$(word 2,$(subst :, ,$(kv)))) \
486+
kubectl get secret $(TLS_SECRET_NAME) \
487+
-n kube-system \
488+
-o jsonpath="{.data['$(call escape_dot,$(FILE))']}" \
489+
| base64 -d > $(CERT_DIR)/$(FILE);\
490+
hubble config set $(CONFIG_KEY) $(CERT_DIR)/$(FILE);\
491+
)
492+
hubble config set tls true
493+
hubble config set tls-server-name instance.hubble-relay.cilium.io
494+
495+
.PHONY: clean-certs
496+
clean-certs:
497+
rm -rf $(CERT_DIR)
498+
$(foreach kv,$(CERT_FILES),\
499+
$(eval CONFIG_KEY=$(word 2,$(subst :, ,$(kv)))) \
500+
hubble config reset $(CONFIG_KEY);\
501+
)
502+
hubble config set tls false
503+
hubble config reset tls-server-name
504+
448505
.PHONY: docs
449506
docs:
450507
echo $(PWD)
@@ -463,6 +520,12 @@ quick-build:
463520
quick-deploy:
464521
$(MAKE) helm-install-advanced-local-context HELM_IMAGE_TAG=$(TAG)-linux-amd64
465522

523+
.PHONY: quick-deploy-hubble
524+
quick-deploy-hubble:
525+
$(MAKE) helm-uninstall || true
526+
$(MAKE) helm-install-without-tls HELM_IMAGE_TAG=$(TAG)-linux-amd64
527+
466528
.PHONY: simplify-dashboards
467529
simplify-dashboards:
468-
cd deploy/grafana/dashboards/ && go test . -tags=dashboard,simplifydashboard -v
530+
cd deploy/legacy/graphana/dashboards && go test . -tags=dashboard,simplifydashboard -v && cd $(REPO_ROOT)
531+

cmd/hubble/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} Authors of Cilium and Retina
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)