Skip to content

Commit 1c6ac99

Browse files
PabloCastellanoPabloCastellano
authored
Blobscan-web chart (#9)
* add blobscan-web chart * update blobscan-api comments * bump version * bump version * update description
1 parent fc5ab76 commit 1c6ac99

16 files changed

+724
-14
lines changed

‎charts/blobscan-api/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: https://raw.githubusercontent.com/Blobscan/blobscan/main/.github/assets/lo
66
sources:
77
- https://github.com/blobscan/blobscan/
88
type: application
9-
version: 0.3.0
9+
version: 0.3.1
1010
maintainers:
1111
- name: PabloCastellano
1212
email: [email protected]

‎charts/blobscan-api/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# blobscan-api
33

4-
![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
4+
![Version: 0.3.1](https://img.shields.io/badge/Version-0.3.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
55

66
Blobscan API
77

@@ -18,10 +18,10 @@ Blobscan API
1818
| affinity | object | `{}` | Affinity configuration for pods |
1919
| annotations | object | `{}` | Annotations for the Deployment |
2020
| args | list | `[]` | Command arguments |
21-
| config | object | See `values.yaml` | Config file https://github.com/Blobscan/blobscan/blob/next/.env.example |
21+
| config | object | See `values.yaml` | Config file https://github.com/Blobscan/blobscan/blob/main/.env.example |
2222
| containerSecurityContext | object | See `values.yaml` | The security context for containers |
23-
| customArgs | list | `["api"]` | Custom args for the blobscan container |
24-
| customCommand | list | `[]` | Command replacement for the blobscan container |
23+
| customArgs | list | `["api"]` | Custom args for the blobscan-api container |
24+
| customCommand | list | `[]` | Command replacement for the blobscan-api container |
2525
| extraContainers | list | `[]` | Additional containers |
2626
| extraEnv | list | `[]` | Additional env variables |
2727
| extraPodPorts | list | `[]` | Extra Pod ports |
@@ -30,9 +30,9 @@ Blobscan API
3030
| extraVolumes | list | `[]` | Additional volumes |
3131
| fullnameOverride | string | `""` | Overrides the chart's computed fullname |
3232
| httpPort | int | `3001` | Ports |
33-
| image.pullPolicy | string | `"IfNotPresent"` | blobscan container pull policy |
34-
| image.repository | string | `"blossomlabs/blobscan-api"` | blobscan container image repository |
35-
| image.tag | string | `"latest"` | blobscan container image tag |
33+
| image.pullPolicy | string | `"IfNotPresent"` | blobscan-api container pull policy |
34+
| image.repository | string | `"blossomlabs/blobscan-api"` | blobscan-api container image repository |
35+
| image.tag | string | `"latest"` | blobscan-api container image tag |
3636
| imagePullSecrets | list | `[]` | Image pull secrets for Docker images |
3737
| ingress.annotations | object | `{}` | Annotations for Ingress |
3838
| ingress.enabled | bool | `false` | Ingress resource for the HTTP API |

‎charts/blobscan-api/values.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ fullnameOverride: ""
88
replicas: 1
99

1010
image:
11-
# -- blobscan container image repository
11+
# -- blobscan-api container image repository
1212
repository: blossomlabs/blobscan-api
13-
# -- blobscan container image tag
13+
# -- blobscan-api container image tag
1414
tag: latest
15-
# -- blobscan container pull policy
15+
# -- blobscan-api container pull policy
1616
pullPolicy: IfNotPresent
1717

1818
# -- Secret env variables injected via a created secret
@@ -26,7 +26,7 @@ args: []
2626

2727
# -- Config file
2828
# @default -- See `values.yaml`
29-
# https://github.com/Blobscan/blobscan/blob/next/.env.example
29+
# https://github.com/Blobscan/blobscan/blob/main/.env.example
3030
config:
3131
CHAIN_ID: "1"
3232
DATABASE_URL: "postgresql://postgres:postgres@blobscan-blobscandb:5432/blobscan?ssl=false"
@@ -73,10 +73,10 @@ ingress:
7373
# hosts:
7474
# - chart-example.local
7575

76-
# -- Custom args for the blobscan container
76+
# -- Custom args for the blobscan-api container
7777
customArgs: ["api"]
7878

79-
# -- Command replacement for the blobscan container
79+
# -- Command replacement for the blobscan-api container
8080
customCommand: [] # Only change this if you need to change the default command
8181

8282
service:

‎charts/blobscan-web/.helmignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*.orig
18+
*~
19+
# Various IDEs
20+
.project
21+
.idea/
22+
*.tmproj
23+
.vscode/

‎charts/blobscan-web/Chart.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
apiVersion: v2
2+
name: blobscan-web
3+
version: 0.3.1
4+
description: Blobscan Web UI
5+
type: application
6+
keywords:
7+
- ethereum
8+
- eip4844
9+
- blobs
10+
home: https://blobscan.com
11+
sources:
12+
- https://github.com/blobscan/blobscan/
13+
maintainers:
14+
- name: PabloCastellano
15+
email: [email protected]
16+
icon: https://raw.githubusercontent.com/Blobscan/blobscan/main/.github/assets/logo.svg

‎charts/blobscan-web/README.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
2+
# blobscan-web
3+
4+
![Version: 0.3.1](https://img.shields.io/badge/Version-0.3.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
5+
6+
Blobscan Web UI
7+
8+
**Homepage:** <https://blobscan.com>
9+
10+
## Source Code
11+
12+
* <https://github.com/blobscan/blobscan/>
13+
14+
## Values
15+
16+
| Key | Type | Default | Description |
17+
|-----|------|---------|-------------|
18+
| affinity | object | `{}` | Affinity configuration for pods |
19+
| annotations | object | `{}` | Annotations for the Deployment |
20+
| args | list | `[]` | Command arguments |
21+
| config | object | See `values.yaml` | Config file https://github.com/Blobscan/blobscan/blob/main/.env.example |
22+
| containerSecurityContext | object | See `values.yaml` | The security context for containers |
23+
| customArgs | list | `["web"]` | Custom args for the blobscan-web container |
24+
| customCommand | list | `[]` | Command replacement for the blobscan-web container |
25+
| extraContainers | list | `[]` | Additional containers |
26+
| extraEnv | list | `[]` | Additional env variables |
27+
| extraPodPorts | list | `[]` | Extra Pod ports |
28+
| extraPorts | list | `[]` | Additional ports. Useful when using extraContainers |
29+
| extraVolumeMounts | list | `[]` | Additional volume mounts |
30+
| extraVolumes | list | `[]` | Additional volumes |
31+
| fullnameOverride | string | `""` | Overrides the chart's computed fullname |
32+
| httpPort | int | `3000` | Ports |
33+
| image.pullPolicy | string | `"IfNotPresent"` | blobscan-web container pull policy |
34+
| image.repository | string | `"blossomlabs/blobscan-web"` | blobscan-web container image repository |
35+
| image.tag | string | `"latest"` | blobscan-web container image tag |
36+
| imagePullSecrets | list | `[]` | Image pull secrets for Docker images |
37+
| ingress.annotations | object | `{}` | Annotations for Ingress |
38+
| ingress.enabled | bool | `false` | Ingress resource for the HTTP API |
39+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
40+
| ingress.hosts[0].paths | list | `[]` | |
41+
| ingress.tls | list | `[]` | Ingress TLS |
42+
| initContainers | list | `[]` | Additional init containers |
43+
| livenessProbe | object | See `values.yaml` | Liveness probe |
44+
| nameOverride | string | `""` | Overrides the chart's name |
45+
| nodeSelector | object | `{}` | Node selector for pods |
46+
| podAnnotations | object | `{}` | Pod annotations |
47+
| podDisruptionBudget | object | `{}` | Define the PodDisruptionBudget spec If not set then a PodDisruptionBudget will not be created |
48+
| podLabels | object | `{}` | Pod labels |
49+
| priorityClassName | string | `nil` | Pod priority class |
50+
| readinessProbe | object | See `values.yaml` | Readiness probe |
51+
| replicas | int | `1` | Number of replicas |
52+
| resources | object | `{}` | Resource requests and limits |
53+
| secretEnv | object | `{}` | Secret env variables injected via a created secret |
54+
| securityContext | object | See `values.yaml` | The security context for pods |
55+
| service.type | string | `"ClusterIP"` | Service type |
56+
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
57+
| serviceAccount.create | bool | `false` | Specifies whether a service account should be created |
58+
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
59+
| serviceMonitor.annotations | object | `{}` | Additional ServiceMonitor annotations |
60+
| serviceMonitor.enabled | bool | `false` | If true, a ServiceMonitor CRD is created for a prometheus operator https://github.com/coreos/prometheus-operator |
61+
| serviceMonitor.interval | string | `"15s"` | ServiceMonitor scrape interval |
62+
| serviceMonitor.labels | object | `{}` | Additional ServiceMonitor labels |
63+
| serviceMonitor.namespace | string | `nil` | Alternative namespace for ServiceMonitor |
64+
| serviceMonitor.path | string | `"/metrics"` | Path to scrape |
65+
| serviceMonitor.relabelings | list | `[]` | ServiceMonitor relabelings |
66+
| serviceMonitor.scheme | string | `"http"` | ServiceMonitor scheme |
67+
| serviceMonitor.scrapeTimeout | string | `"30s"` | ServiceMonitor scrape timeout |
68+
| serviceMonitor.tlsConfig | object | `{}` | ServiceMonitor TLS configuration |
69+
| terminationGracePeriodSeconds | int | `30` | How long to wait until the pod is forcefully terminated |
70+
| tolerations | list | `[]` | Tolerations for pods |
71+
| topologySpreadConstraints | list | `[]` | Topology Spread Constraints for pods |

‎charts/blobscan-web/README.md.gotmpl

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
{{ template "chart.header" . }}
3+
{{ template "chart.deprecationWarning" . }}
4+
5+
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}
6+
7+
{{ template "chart.description" . }}
8+
9+
{{ template "chart.homepageLine" . }}
10+
11+
{{ template "chart.sourcesSection" . }}
12+
13+
{{ template "chart.requirementsSection" . }}
14+
15+
{{ template "chart.valuesSection" . }}

‎charts/blobscan-web/templates/NOTES.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
1. Get the application URL by running these commands:
2+
{{- if .Values.ingress.enabled }}
3+
{{- range $host := .Values.ingress.hosts }}
4+
{{- range .paths }}
5+
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
6+
{{- end }}
7+
{{- end }}
8+
{{- else if contains "NodePort" .Values.service.type }}
9+
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "blobscan.fullname" . }})
10+
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
11+
echo http://$NODE_IP:$NODE_PORT
12+
{{- else if contains "LoadBalancer" .Values.service.type }}
13+
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
14+
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "blobscan.fullname" . }}'
15+
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "blobscan.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
16+
echo http://$SERVICE_IP:{{ include "blobscan.httpPort" . }}
17+
{{- else if contains "ClusterIP" .Values.service.type }}
18+
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "blobscan.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
19+
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
20+
echo "Visit http://127.0.0.1:8080 to use your application"
21+
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
22+
{{- end }}

‎charts/blobscan-web/templates/_helpers.tpl

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{{/*
2+
Expand the name of the chart.
3+
*/}}
4+
{{- define "blobscan.name" -}}
5+
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
6+
{{- end }}
7+
8+
{{/*
9+
Create a default fully qualified app name.
10+
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
11+
If release name contains chart name it will be used as a full name.
12+
*/}}
13+
{{- define "blobscan.fullname" -}}
14+
{{- if .Values.fullnameOverride }}
15+
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
16+
{{- else }}
17+
{{- $name := default .Chart.Name .Values.nameOverride }}
18+
{{- if contains $name .Release.Name }}
19+
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
20+
{{- else }}
21+
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
22+
{{- end }}
23+
{{- end }}
24+
{{- end }}
25+
26+
{{/*
27+
Create chart name and version as used by the chart label.
28+
*/}}
29+
{{- define "blobscan.chart" -}}
30+
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
31+
{{- end }}
32+
33+
{{/*
34+
Common labels
35+
*/}}
36+
{{- define "blobscan.labels" -}}
37+
helm.sh/chart: {{ include "blobscan.chart" . }}
38+
{{ include "blobscan.selectorLabels" . }}
39+
{{- if .Chart.AppVersion }}
40+
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
41+
{{- end }}
42+
app.kubernetes.io/managed-by: {{ .Release.Service }}
43+
{{- end }}
44+
45+
{{/*
46+
Selector labels
47+
*/}}
48+
{{- define "blobscan.selectorLabels" -}}
49+
app.kubernetes.io/name: {{ include "blobscan.name" . }}
50+
app.kubernetes.io/instance: {{ .Release.Name }}
51+
{{- end }}
52+
53+
{{/*
54+
Create the name of the service account to use
55+
*/}}
56+
{{- define "blobscan.serviceAccountName" -}}
57+
{{- if .Values.serviceAccount.create }}
58+
{{- default (include "blobscan.fullname" .) .Values.serviceAccount.name }}
59+
{{- else }}
60+
{{- default "default" .Values.serviceAccount.name }}
61+
{{- end }}
62+
{{- end }}
63+
64+
{{- define "blobscan.httpPort" -}}
65+
{{ .Values.httpPort | default "3000" }}
66+
{{- end }}

0 commit comments

Comments
 (0)