diff --git a/.github/workflows/lint-test.yaml b/.github/workflows/lint-test.yaml index 5b00b5be..59f24223 100644 --- a/.github/workflows/lint-test.yaml +++ b/.github/workflows/lint-test.yaml @@ -27,7 +27,10 @@ jobs: uses: helm/chart-testing-action@v2.6.1 with: version: v3.10.1 - + - name: what is changed + run: | + ct list-changed --config ct.yaml + - name: Run chart-testing (list-changed) id: list-changed run: | @@ -67,6 +70,9 @@ jobs: - name: Check if cert-manager is up run: | cmctl check api --wait=5m - + - name: what is here + run: ls - name: Run chart-testing (install) - run: ct install --config ct.yaml + run: ct install --config ct.yaml --debug + - name: configmap + run: kubectl get configmap -A diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9e..00000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md deleted file mode 100644 index 26be2249..00000000 --- a/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Jaeger Helm Charts - -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -[![](https://github.com/jaegertracing/helm-charts/workflows/Release%20Charts/badge.svg?branch=main)](https://github.com/jaegertracing/helm-charts/actions) - -This functionality is in beta and is subject to change. The code is provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. - -## Usage - -[Helm](https://helm.sh) must be installed to use the charts. -Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. - -Once Helm is set up properly, add the repo as follows: - -```console -$ helm repo add jaegertracing https://jaegertracing.github.io/helm-charts -``` - -You can then run `helm search repo jaegertracing` to see the charts. - -See additional documentation: - * [Jaeger chart](./charts/jaeger) - * [Jaeger Operator chart](./charts/jaeger-operator) - -## Contributing - -We'd love to have you contribute! Please refer to our [contribution guidelines](CONTRIBUTING.md) for details. - -## License - -[Apache 2.0 License](./LICENSE). diff --git a/charts/jaeger-v2/.helmignore b/charts/jaeger-v2/.helmignore new file mode 100644 index 00000000..f0c13194 --- /dev/null +++ b/charts/jaeger-v2/.helmignore @@ -0,0 +1,21 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj diff --git a/charts/jaeger-v2/Chart.lock b/charts/jaeger-v2/Chart.lock new file mode 100644 index 00000000..89e13342 --- /dev/null +++ b/charts/jaeger-v2/Chart.lock @@ -0,0 +1,15 @@ +dependencies: +- name: cassandra + repository: https://charts.helm.sh/incubator + version: 0.15.3 +- name: elasticsearch + repository: https://charts.bitnami.com/bitnami + version: 20.0.4 +- name: kafka + repository: https://charts.bitnami.com/bitnami + version: 26.6.2 +- name: common + repository: https://charts.bitnami.com/bitnami + version: 2.23.0 +digest: sha256:b13c6270d6d45478b47d03157f7a1c44add98be0809d83b22597a0c800781c10 +generated: "2024-10-01T10:23:03.372102011Z" diff --git a/charts/jaeger-v2/Chart.yaml b/charts/jaeger-v2/Chart.yaml new file mode 100644 index 00000000..32112d67 --- /dev/null +++ b/charts/jaeger-v2/Chart.yaml @@ -0,0 +1,45 @@ +apiVersion: v2 +appVersion: 1.53.0 +description: A Jaeger Helm chart for Kubernetes +name: jaeger +type: application +version: 3.3.1 +# CronJobs require v1.21 +kubeVersion: ">= 1.21-0" +keywords: + - jaeger + - opentracing + - tracing +home: https://jaegertracing.io +icon: https://www.jaegertracing.io/img/jaeger-icon-reverse-color.svg +sources: + - https://hub.docker.com/u/jaegertracing/ +maintainers: + - name: dvonthenen + email: david.vonthenen@dell.com + - name: mehta-ankit + email: ankit.mehta@appian.com + - name: mikelorant + email: michael.lorant@fairfaxmedia.com.au + - name: naseemkullah + email: naseem@transit.app + - name: pavelnikolov + email: me@pavelnikolov.net + - name: jkowall + email: jkowall@kowall.net +dependencies: + - name: cassandra + version: 0.15.3 + repository: https://charts.helm.sh/incubator + condition: provisionDataStore.cassandra + - name: elasticsearch + version: 20.0.4 + repository: https://charts.bitnami.com/bitnami + condition: provisionDataStore.elasticsearch + - name: kafka + version: 26.6.2 + repository: https://charts.bitnami.com/bitnami + condition: provisionDataStore.kafka + - name: common + repository: https://charts.bitnami.com/bitnami + version: 2.x.x diff --git a/charts/jaeger-v2/readme.md b/charts/jaeger-v2/readme.md new file mode 100644 index 00000000..4d2954cb --- /dev/null +++ b/charts/jaeger-v2/readme.md @@ -0,0 +1,167 @@ +# Jaeger Helm Chart Deployment (Version 2) Documentation + +## Overview + +This document outlines the steps to deploy the Jaeger Helm chart (version 2) and provides information on how to use a custom `values.yaml` configuration file during installation. The Jaeger Helm chart includes multiple sub-charts for data stores like Cassandra, Elasticsearch, and Kafka. + +## Directory Structure + +The structure of the Jaeger Helm chart is as follows: + +```bash +kali@PC:~/LFX/helm-charts/charts/jaeger-v2$ tree +. +├── Chart.lock +├── Chart.yaml +├── charts +│ ├── cassandra-0.15.3.tgz +│ ├── common-2.23.0.tgz +│ ├── elasticsearch-20.0.4.tgz +│ └── kafka-26.6.2.tgz +├── readme.md +├── templates +│ ├── _helpers.tpl +│ ├── config-map.yaml +│ └── deployment.yaml +└── values.yaml + +3 directories, 11 files +``` + +### Key Files +- **Chart.yaml**: Contains metadata about the Helm chart such as the chart version, name, and dependencies. +- **templates/**: This directory contains Kubernetes manifests that are templated by Helm and used for the deployment of the Jaeger application. Key templates include: + - `config-map.yaml`: Configures the ConfigMap for the application. + - `deployment.yaml`: Contains the template for the Kubernetes deployment of Jaeger. +- **values.yaml**: This file contains default configuration values for the chart, which are applied unless overridden by a custom file. +- **charts/**: Contains Helm chart dependencies such as Cassandra, Elasticsearch, Kafka, and common utilities. +- **readme.md**: Provides chart-specific documentation. + +## Helm Installation + +You can install the Jaeger Helm chart with the following commands: + +### Basic Installation + +To install the Jaeger chart using the default values from the included `values.yaml`: + +```bash +helm install ./ +``` + +- `` is the name you want to give your release. + +### Installation with Custom Values + +If you want to use a custom configuration, you can pass a custom `values.yaml` file. This allows you to override the default values specified in the chart’s `values.yaml`. + +Use the following command to install the chart with a custom values file: + +```bash +helm install ./ -f +``` + +- Replace `` with the desired name for your Helm release. +- Replace `` with the path to your custom configuration file. + +### Example: + +```bash +helm install jaeger-v2 ./ -f my-config-values.yaml +``` + +This command installs the Jaeger chart and uses `my-config-values.yaml` for overriding any configuration specified in the default `values.yaml`. + +## Custom Values + +When deploying Jaeger using a custom values file, any configuration set in the file will take precedence over the default settings in `values.yaml`. For example, you can modify parameters for `receivers`, `processors`, `exporters`, and more within your custom values file. + +### Example Custom `values.yaml` + +```yaml + + service: + extensions: [jaeger_storage, jaeger_query, remote_sampling, healthcheckv2] + pipelines: + traces: + receivers: [otlp, jaeger, zipkin] + processors: [batch, adaptive_sampling] + exporters: [jaeger_storage_exporter] + + extensions: + healthcheckv2: + use_v2: true + http: {} + + + jaeger_query: + storage: + traces: some_store + traces_archive: another_store + ui: + config_file: ./cmd/jaeger/config-ui.json + + jaeger_storage: + backends: + some_store: + memory: + max_traces: 90000 + another_store: + memory: + max_traces: 90000 + + remote_sampling: + adaptive: + sampling_store: some_store + initial_sampling_probability: 0.2 + http: {} + grpc: {} + + receivers: + otlp: + protocols: + grpc: {} + http: {} + + jaeger: + protocols: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} + + zipkin: {} + + processors: + batch: {} + adaptive_sampling: {} + + exporters: + jaeger_storage_exporter: + trace_storage: some_store +``` + +## Dependencies + +This Helm chart comes with pre-packaged dependencies for data stores: +- **Cassandra**: Version `0.15.3` +- **Elasticsearch**: Version `20.0.4` +- **Kafka**: Version `26.6.2` +- **Common**: Version `2.23.0` + +These dependencies can be managed through the `charts/` directory, and they are installed as part of the Jaeger deployment. + +## Uninstallation + +To uninstall the Helm release, use the following command: + +```bash +helm uninstall +``` + +This will remove all Kubernetes resources created by the chart, including ConfigMaps, Deployments, Services, and StatefulSets. + +## Conclusion + +This document provides a summary of how to install and configure the Jaeger Helm chart (version 2) with both default and custom values. Custom configurations can be applied via a user-defined `values.yaml` file using the `-f` flag during installation.# Jaeger Helm Chart Deployment (Version 2) Documentation + diff --git a/charts/jaeger-v2/templates/_helpers.tpl b/charts/jaeger-v2/templates/_helpers.tpl new file mode 100644 index 00000000..84836006 --- /dev/null +++ b/charts/jaeger-v2/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "jaeger-v2.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "jaeger-v2.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "jaeger-v2.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "jaeger-v2.labels" -}} +helm.sh/chart: {{ include "jaeger-v2.chart" . }} +{{ include "jaeger-v2.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "jaeger-v2.selectorLabels" -}} +app.kubernetes.io/name: {{ include "jaeger-v2.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "jaeger-v2.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "jaeger-v2.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/jaeger-v2/templates/config-map.yaml b/charts/jaeger-v2/templates/config-map.yaml new file mode 100644 index 00000000..4f09d186 --- /dev/null +++ b/charts/jaeger-v2/templates/config-map.yaml @@ -0,0 +1,37 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: my-config + namespace: {{ .Release.Namespace }} + annotations: + "helm.sh/hook": pre-install + +data: + config.yaml: | + service: + extensions: {{ toYaml .Values.service.extensions | indent 6 }} + pipelines: + traces: + receivers: {{ toYaml .Values.service.pipelines.traces.receivers | indent 10 }} + processors: {{ toYaml .Values.service.pipelines.traces.processors | indent 10 }} + exporters: {{ toYaml .Values.service.pipelines.traces.exporters | indent 10 }} + + extensions: + healthcheckv2: {{ toYaml .Values.extensions.healthcheckv2 | indent 6 }} + + jaeger_query: + storage: {{ toYaml .Values.extensions.jaeger_query.storage | indent 8 }} + ui: {{ toYaml .Values.extensions.jaeger_query.ui | indent 8 }} + jaeger_storage: {{ toYaml .Values.extensions.jaeger_storage | indent 6 }} + remote_sampling: {{ toYaml .Values.extensions.remote_sampling | indent 6 }} + + receivers: + otlp: {{ toYaml .Values.receivers.otlp | indent 6 }} + jaeger: {{ toYaml .Values.receivers.jaeger | indent 6 }} + zipkin: {{ toYaml .Values.receivers.zipkin | indent 6 }} + + processors: + batch: {{ toYaml .Values.processors.batch | indent 6 }} + + exporters: + jaeger_storage_exporter: {{ toYaml .Values.exporters.jaeger_storage_exporter | indent 6 }} diff --git a/charts/jaeger-v2/values.yaml b/charts/jaeger-v2/values.yaml new file mode 100644 index 00000000..f1b8f862 --- /dev/null +++ b/charts/jaeger-v2/values.yaml @@ -0,0 +1,63 @@ +service: + extensions: [jaeger_storage, jaeger_query, remote_sampling, healthcheckv2] + pipelines: + traces: + receivers: [otlp, jaeger, zipkin] + processors: [batch, adaptive_sampling] + exporters: [jaeger_storage_exporter] + +extensions: + healthcheckv2: + use_v2: true + http: {} + + jaeger_query: + storage: + traces: some_store + traces_archive: another_store + ui: + config_file: ./cmd/jaeger/config-ui.json + + jaeger_storage: + backends: + some_store: + memory: + max_traces: 100000 + another_store: + memory: + max_traces: 100000 + + remote_sampling: + adaptive: + sampling_store: some_store + initial_sampling_probability: 0.1 + http: {} + grpc: {} + +receivers: + otlp: + protocols: + grpc: {} + http: {} + + jaeger: + protocols: + grpc: {} + thrift_binary: {} + thrift_compact: {} + thrift_http: {} + + zipkin: {} + +processors: + batch: {} + +exporters: + jaeger_storage_exporter: {} + +image: "jaegertracing/jaeger:latest" + +provisionDataStore: + cassandra: false + elasticsearch: false + kafka: false