Skip to content

Commit 012ae7a

Browse files
authored
Improve helm chart (#1220)
- Add more metadata - Improve readme - Fix a couple of issues deploying prometheus - add license
1 parent fa0364b commit 012ae7a

File tree

7 files changed

+376
-17
lines changed

7 files changed

+376
-17
lines changed

.mk/development.mk

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ undeploy-loki-tls:
3131
.PHONY: deploy-loki-tls
3232
deploy-loki-tls:
3333
@echo -e "\n==> Deploy tls loki"
34-
kubectl create namespace $(NAMESPACE) --dry-run=client -o yaml | kubectl apply -f -
34+
kubectl create namespace $(NAMESPACE) --dry-run=client -o yaml | kubectl apply -f -
3535
kubectl config set-context --current --namespace=$(NAMESPACE)
3636
curl -S -L https://raw.githubusercontent.com/netobserv/documents/main/examples/zero-click-loki/1-storage.yaml | kubectl create -f - || true
3737
curl -S -L https://raw.githubusercontent.com/netobserv/documents/main/examples/zero-click-loki/2-loki-tls.yaml | kubectl create -f - || true
@@ -119,6 +119,8 @@ undeploy-all: undeploy-infra undeploy-sample-cr undeploy-sample-workload
119119
.PHONY: deploy-prometheus
120120
deploy-prometheus: ## Deploy prometheus.
121121
@echo -e "\n==> Deploy prometheus"
122+
kubectl create namespace $(NAMESPACE) || true
123+
kubectl config set-context --current --namespace=$(NAMESPACE)
122124
kubectl apply -f config/kind/deployment-prometheus.yaml
123125
kubectl rollout status "deploy/prometheus" --timeout=600s
124126
-pkill --oldest --full "9090:9090"

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,7 @@ endif
534534
helm-update: YQ ## Update helm template
535535
sed -i -r 's/appVersion:.*/appVersion: $(BUNDLE_VERSION)/g' helm/Chart.yaml
536536
hack/helm-update.sh
537+
cp LICENSE helm/
537538

538539
include .mk/sample.mk
539540
include .mk/development.mk

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,39 @@ Flow data is then available in multiple ways, each optional:
1818

1919
You can install the NetObserv Operator using [Helm](https://helm.sh/), or directly from sources.
2020

21-
In OpenShift, NetObserv is renamed as the Network Observability operator and can be found in OperatorHub as an OLM operator. This section does not apply to it: please refer to the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/observability/network_observability/installing-operators.html) in that case.
21+
In OpenShift, NetObserv is named Network Observability operator and can be found in OperatorHub as an OLM operator. This section does not apply to it: please refer to the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/observability/network_observability/installing-operators.html) in that case.
2222

2323
> [!IMPORTANT]
2424
> NetObserv community was previously distributed via [OperatorHub](https://operatorhub.io/operator/netobserv-operator). This installation method is replaced with a helm chart. If you previously installed NetObserv community from OperatorHub, we recommend that you uninstall it, and re-install using the helm chart. The operation should not cause any data loss.
2525
26-
### Install with Helm
26+
### Pre-requisite
27+
28+
NetObserv has a couple of dependencies that must be installed on your cluster:
2729

28-
_Integration with ArtifactHub coming soon._
30+
- Cert-manager
31+
- Prometheus
32+
- Loki
2933

30-
In the meantime, you can install the Helm chart from this repository:
34+
Loki is not mandatory but improves the overall experience with NetObserv.
35+
If you don't have these dependencies already, some convenience scripts are available from the repository, provided for demo purpose:
3136

3237
```bash
3338
git clone https://github.com/netobserv/network-observability-operator.git && cd network-observability-operator
34-
35-
# If you don't already have cert-manager, you'll need it:
36-
make install-cert-manager
39+
PORT_FWD=false make deploy-prometheus deploy-loki install-cert-manager
3740
# (it is expected to see errors while running this script, since it runs several attempts creating a certificate for testing, before eventually succeeding)
41+
```
3842

43+
### Install with Helm
44+
45+
Check it out on [ArtifactHub](https://artifacthub.io/packages/helm/netobserv/netobserv-operator).
46+
47+
```bash
48+
helm repo add netobserv https://netobserv.io/static/helm/
3949
helm install netobserv --namespace netobserv --create-namespace -f helm/values.yaml --set standaloneConsole.enable=true ./helm
4050
# If you're in OpenShift, you can omit "--set standaloneConsole.enable=true" to use the Console plugin instead.
4151
```
4252

43-
After that, you can install Loki, as explained [here](./config/descriptions/upstream.md). Loki is not mandatory but improves the overall experience with NetObserv.
44-
You will also need Prometheus. If you don't have it already, there is a quick setup provided in this repository, just run `make deploy-prometheus` from there.
45-
46-
After the operator and Loki are installed, create a `FlowCollector` resource: refer to the [Configuration section](#configuration) of this document. A very short `FlowCollector` should work, using default values, plus with the standalone console enabled:
53+
You can now create a `FlowCollector` resource. Refer to the [Configuration section](#configuration) of this document. A very short `FlowCollector` should work, using default values, plus with the standalone console enabled:
4754

4855
```bash
4956
cat <<EOF | kubectl apply -f -
@@ -67,7 +74,7 @@ EOF
6774
A few remarks:
6875
- While the [web console](https://github.com/netobserv/network-observability-console-plugin) is primarily designed as a plugin for the OpenShift Console, it is still possible to deploy it as a standalone, which the dev team sometimes use for testing. This is why it is mentioned as "TEST_CONSOLE" here.
6976
- If you're in OpenShift, you should omit "TEST_CONSOLE: true" to use the Console plugin instead, which offers a better / more integrated experience.
70-
- You can change the Prometheus URL depending on your installation. This example URL works if you use the `make deploy-prometheus` script from this repository. Prometheus configuration options are documented [here](./docs/FlowCollector.md#flowcollectorspecprometheus-1).
77+
- You can change the Prometheus URL depending on your installation. This example URL works if you use the `make deploy-prometheus` script from the repository. Prometheus configuration options are documented [here](./docs/FlowCollector.md#flowcollectorspecprometheus-1).
7178

7279
To view the test console, you can port-forward 9001:
7380

config/kind/deployment-prometheus.yaml

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1+
apiVersion: rbac.authorization.k8s.io/v1
2+
kind: Role
3+
metadata:
4+
name: prometheus-scraper
5+
rules:
6+
- apiGroups:
7+
- ""
8+
resources:
9+
- pods
10+
- services
11+
verbs:
12+
- list
13+
- get
14+
- watch
15+
---
16+
apiVersion: v1
17+
kind: ServiceAccount
18+
metadata:
19+
name: prometheus-sa
20+
---
21+
apiVersion: rbac.authorization.k8s.io/v1
22+
kind: RoleBinding
23+
metadata:
24+
name: prometheus-scraper
25+
roleRef:
26+
apiGroup: rbac.authorization.k8s.io
27+
kind: Role
28+
name: prometheus-scraper
29+
subjects:
30+
- kind: ServiceAccount
31+
name: prometheus-sa
32+
---
133
apiVersion: apps/v1
234
kind: Deployment
335
metadata:
@@ -35,7 +67,7 @@ spec:
3567
mountPath: /etc/prometheus/
3668
- name: prometheus-storage-volume
3769
mountPath: /prometheus/
38-
serviceAccountName: flowlogs-pipeline
70+
serviceAccountName: prometheus-sa
3971
volumes:
4072
- name: prometheus-config-volume
4173
configMap:
@@ -75,6 +107,8 @@ data:
75107
- job_name: 'flowlogs-pipeline'
76108
kubernetes_sd_configs:
77109
- role: pod
110+
namespaces:
111+
own_namespace: true
78112
79113
relabel_configs:
80114
# Scrape only pods that have "prometheus.io/scrape = true" annotation.

helm/Chart.yaml

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
2-
name: Netobserv
3-
description: A Helm chart to install Network Observability Operator on k8s
2+
name: netobserv-operator
3+
description: Network Observability in Kubernetes based on eBPF.
44

55
# A chart can be either an 'application' or a 'library' chart.
66
#
@@ -15,10 +15,43 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.0.1
18+
version: 1.8.0-community
1919

2020
# This is the version number of the application being deployed. This version number should be
2121
# incremented each time you make changes to the application. Versions are not expected to
2222
# follow Semantic Versioning. They should reflect the version the application is using.
2323
# It is recommended to use it with quotes.
2424
appVersion: 1.8.0-community
25+
26+
keywords:
27+
- network observability
28+
- ebpf
29+
- ipfix
30+
- flow tracing
31+
- flows
32+
- topology
33+
- network
34+
- observability
35+
36+
home: https://netobserv.io/
37+
38+
sources:
39+
- https://github.com/netobserv/network-observability-operator
40+
- https://github.com/netobserv/flowlogs-pipeline
41+
- https://github.com/netobserv/netobserv-ebpf-agent
42+
- https://github.com/netobserv/network-observability-console-plugin
43+
- https://github.com/netobserv/network-observability-cli
44+
45+
maintainers:
46+
47+
name: Julien Pinsonneau
48+
49+
name: Joel Takvorian
50+
51+
name: Mohamed S. Mahmoud
52+
53+
name: Olivier Cazade
54+
55+
name: Steven Lee
56+
57+
icon: https://netobserv.io/static/assets/images/netobserv.svg

helm/LICENSE

Lines changed: 201 additions & 0 deletions
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] [name of copyright owner]
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)