From 606456d699ae8c1baae2372fac69764f671c3d64 Mon Sep 17 00:00:00 2001 From: Crypt Keeper <64215+codefromthecrypt@users.noreply.github.com> Date: Sun, 31 Dec 2023 11:44:52 +0800 Subject: [PATCH] puts chart into standard directory and polishes README (#9) Signed-off-by: Adrian Cole --- README.md | 85 ++++++++++--------- build-bin/helm/helm_prepare | 10 +-- Chart.yaml => charts/zipkin/Chart.yaml | 2 +- .../zipkin/templates}/NOTES.txt | 0 .../zipkin/templates}/_helpers.tpl | 0 .../zipkin/templates}/deployment.yaml | 0 .../zipkin/templates}/hpa.yaml | 0 .../zipkin/templates}/ingress.yaml | 0 .../zipkin/templates}/psp.yaml | 0 .../zipkin/templates}/role.yaml | 0 .../zipkin/templates}/rolebinding.yaml | 0 .../zipkin/templates}/service.yaml | 0 .../zipkin/templates}/serviceaccount.yaml | 0 .../zipkin/values.schema.json | 0 values.yaml => charts/zipkin/values.yaml | 0 15 files changed, 50 insertions(+), 47 deletions(-) rename Chart.yaml => charts/zipkin/Chart.yaml (98%) rename {templates => charts/zipkin/templates}/NOTES.txt (100%) rename {templates => charts/zipkin/templates}/_helpers.tpl (100%) rename {templates => charts/zipkin/templates}/deployment.yaml (100%) rename {templates => charts/zipkin/templates}/hpa.yaml (100%) rename {templates => charts/zipkin/templates}/ingress.yaml (100%) rename {templates => charts/zipkin/templates}/psp.yaml (100%) rename {templates => charts/zipkin/templates}/role.yaml (100%) rename {templates => charts/zipkin/templates}/rolebinding.yaml (100%) rename {templates => charts/zipkin/templates}/service.yaml (100%) rename {templates => charts/zipkin/templates}/serviceaccount.yaml (100%) rename values.schema.json => charts/zipkin/values.schema.json (100%) rename values.yaml => charts/zipkin/values.yaml (100%) diff --git a/README.md b/README.md index 2cbb21a..ce256a1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Zipkin Helm Chart +[![Gitter Chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/openzipkin/zipkin) +[![Build Status](https://github.com/openzipkin/zipkin-helm/workflows/test/badge.svg)](https://github.com/openzipkin/zipkin-helm/actions?query=workflow%3Atest) + ## Usage [Helm](https://helm.sh) must be installed to use the charts. @@ -8,52 +11,52 @@ 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 openzipkin https://openzipkin.github.io/zipkin-helm +$ helm repo add zipkin https://zipkin.io/zipkin-helm ``` -You can then run `helm search repo openzipkin` to see the charts. +You can then run `helm search repo zipkin` to see the charts. ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| affinity | object | `{}` | | -| autoscaling.enabled | bool | `false` | | -| autoscaling.maxReplicas | int | `100` | | -| autoscaling.minReplicas | int | `1` | | -| autoscaling.targetCPUUtilizationPercentage | int | `80` | | -| fullnameOverride | string | `""` | | -| image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"openzipkin/zipkin-slim"` | | -| image.tag | string | `""` | | -| imagePullSecrets | list | `[]` | | -| ingress.annotations | object | `{}` | | -| ingress.enabled | bool | `false` | | -| ingress.host | string | `"chart-example.local"` | kubernetes.io/tls-acme: "true" className: nginx | -| ingress.path | string | `"/"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | | -| nodeSelector | object | `{}` | | -| podAnnotations."sidecar.istio.io/inject" | string | `"false"` | | -| podSecurityContext | object | `{}` | | -| priorityClassName | string | `""` | priority class name for the Pod | -| replicaCount | int | `1` | | -| resources.limits | object | `{"cpu":"500m","memory":"4096Mi"}` | choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after 'resources:'. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi | -| resources.requests.cpu | string | `"100m"` | | -| resources.requests.memory | string | `"128Mi"` | | -| securityContext.readOnlyRootFilesystem | bool | `true` | drop: - ALL | -| securityContext.runAsNonRoot | bool | `true` | | -| securityContext.runAsUser | int | `1000` | | -| service.port | int | `9411` | | -| service.type | string | `"ClusterIP"` | | -| serviceAccount.annotations | object | `{}` | | -| serviceAccount.create | bool | `true` | | -| serviceAccount.name | string | `""` | If not set and create is true, a name is generated using the fullname template | -| serviceAccount.psp | bool | `false` | | -| tolerations | list | `[]` | | -| zipkin.storage.elasticsearch.hosts | string | `"hostA hostB"` | | -| zipkin.storage.elasticsearch.index | string | `"fooIndex"` | | -| zipkin.storage.type | string | `"elasticsearch"` | | +| Key | Type | Default | Description | +|--------------------------------------------|--------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"openzipkin/zipkin-slim"` | | +| image.tag | string | `""` | | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.enabled | bool | `false` | | +| ingress.host | string | `"chart-example.local"` | kubernetes.io/tls-acme: "true" className: nginx | +| ingress.path | string | `"/"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations."sidecar.istio.io/inject" | string | `"false"` | | +| podSecurityContext | object | `{}` | | +| priorityClassName | string | `""` | priority class name for the Pod | +| replicaCount | int | `1` | | +| resources.limits | object | `{"cpu":"500m","memory":"4096Mi"}` | choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after 'resources:'. limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi | +| resources.requests.cpu | string | `"100m"` | | +| resources.requests.memory | string | `"128Mi"` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | drop: - ALL | +| securityContext.runAsNonRoot | bool | `true` | | +| securityContext.runAsUser | int | `1000` | | +| service.port | int | `9411` | | +| service.type | string | `"ClusterIP"` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | If not set and create is true, a name is generated using the fullname template | +| serviceAccount.psp | bool | `false` | | +| tolerations | list | `[]` | | +| zipkin.storage.elasticsearch.hosts | string | `"hostA hostB"` | | +| zipkin.storage.elasticsearch.index | string | `"fooIndex"` | | +| zipkin.storage.type | string | `"elasticsearch"` | | The values are validated using a JSON schema, which contains logic to enforce either: diff --git a/build-bin/helm/helm_prepare b/build-bin/helm/helm_prepare index ec3351e..3f021cd 100755 --- a/build-bin/helm/helm_prepare +++ b/build-bin/helm/helm_prepare @@ -33,13 +33,13 @@ fi # Update appVersion latest_app_version=${2?latest_app_version is required. Ex 4.5.6} -sh -c "sed -i 's/appVersion\:\s[0-9.]\+/appVersion\: ${latest_app_version}/g' Chart.yaml" +sh -c "sed -i 's/appVersion\:\s[0-9.]\+/appVersion\: ${latest_app_version}/g' ./charts/zipkin/Chart.yaml" # Update version -sh -c "sed -i 's/version\:\s[0-9.]\+/version\: ${release_version}/g' Chart.yaml" +sh -c "sed -i 's/version\:\s[0-9.]\+/version\: ${release_version}/g' ./charts/zipkin/Chart.yaml" -# Commit changes to Chart.yaml -git add Chart.yaml && git commit -m "chore: prepare chart release ${release_version}" +# Commit changes to ./charts/zipkin/Chart.yaml +git add ./charts/zipkin/Chart.yaml && git commit -m "chore: prepare chart release ${release_version}" -# Push the changes in Chart.yaml to the release branch +# Push the changes in ./charts/zipkin/Chart.yaml to the release branch git push origin ${release_branch} diff --git a/Chart.yaml b/charts/zipkin/Chart.yaml similarity index 98% rename from Chart.yaml rename to charts/zipkin/Chart.yaml index 0ba39db..45bcbf8 100644 --- a/Chart.yaml +++ b/charts/zipkin/Chart.yaml @@ -14,7 +14,7 @@ appVersion: 2.26.0 name: zipkin description: A Zipkin helm chart for kubernetes type: application -version: 0.1.0 +version: 0.0.0 maintainers: - name: openzipkin email: zipkin-dev@googlegroups.com diff --git a/templates/NOTES.txt b/charts/zipkin/templates/NOTES.txt similarity index 100% rename from templates/NOTES.txt rename to charts/zipkin/templates/NOTES.txt diff --git a/templates/_helpers.tpl b/charts/zipkin/templates/_helpers.tpl similarity index 100% rename from templates/_helpers.tpl rename to charts/zipkin/templates/_helpers.tpl diff --git a/templates/deployment.yaml b/charts/zipkin/templates/deployment.yaml similarity index 100% rename from templates/deployment.yaml rename to charts/zipkin/templates/deployment.yaml diff --git a/templates/hpa.yaml b/charts/zipkin/templates/hpa.yaml similarity index 100% rename from templates/hpa.yaml rename to charts/zipkin/templates/hpa.yaml diff --git a/templates/ingress.yaml b/charts/zipkin/templates/ingress.yaml similarity index 100% rename from templates/ingress.yaml rename to charts/zipkin/templates/ingress.yaml diff --git a/templates/psp.yaml b/charts/zipkin/templates/psp.yaml similarity index 100% rename from templates/psp.yaml rename to charts/zipkin/templates/psp.yaml diff --git a/templates/role.yaml b/charts/zipkin/templates/role.yaml similarity index 100% rename from templates/role.yaml rename to charts/zipkin/templates/role.yaml diff --git a/templates/rolebinding.yaml b/charts/zipkin/templates/rolebinding.yaml similarity index 100% rename from templates/rolebinding.yaml rename to charts/zipkin/templates/rolebinding.yaml diff --git a/templates/service.yaml b/charts/zipkin/templates/service.yaml similarity index 100% rename from templates/service.yaml rename to charts/zipkin/templates/service.yaml diff --git a/templates/serviceaccount.yaml b/charts/zipkin/templates/serviceaccount.yaml similarity index 100% rename from templates/serviceaccount.yaml rename to charts/zipkin/templates/serviceaccount.yaml diff --git a/values.schema.json b/charts/zipkin/values.schema.json similarity index 100% rename from values.schema.json rename to charts/zipkin/values.schema.json diff --git a/values.yaml b/charts/zipkin/values.yaml similarity index 100% rename from values.yaml rename to charts/zipkin/values.yaml