Skip to content

Commit d45bade

Browse files
committed
chore: rename the project to spark-web-proxy
1 parent b5737e8 commit d45bade

36 files changed

+152
-137
lines changed

Dockerfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ARG LDFLAGS="-X localbuild=true"
77
ARG TARGETOS="linux"
88
ARG TARGETARCH
99

10-
WORKDIR /workspace/spark-history-web-proxy
10+
WORKDIR /workspace/spark-web-proxy
1111

1212
COPY Makefile Makefile
1313
COPY go.* ./
@@ -20,17 +20,17 @@ RUN go mod tidy \
2020
RUN --mount=type=cache,target=/root/.cache/go-build \
2121
--mount=type=cache,target=/go/pkg \
2222
LDFLAGS=${LDFLAGS##-X localbuild=true} GIT_COMMIT=$GIT_COMMIT \
23-
CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -a -o spark-history-web-proxy main.go
23+
CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -a -o spark-web-proxy main.go
2424

2525
FROM alpine:3.20.3
2626

2727
RUN apk --no-cache add ca-certificates && update-ca-certificates
2828

29-
COPY --from=go-build /workspace/spark-history-web-proxy /usr/local/bin/
29+
COPY --from=go-build /workspace/spark-web-proxy /usr/local/bin/
3030

3131
USER 65534:65534
3232

3333
EXPOSE 8090
3434

35-
ENTRYPOINT ["spark-history-web-proxy"]
35+
ENTRYPOINT ["spark-web-proxy"]
3636

Readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
[![ci](https://github.com/okdp/spark-history-web-proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/spark-history-web-proxy/actions/workflows/ci.yml)
2-
[![release-please](https://github.com/okdp/spark-history-web-proxy/actions/workflows/release-please.yml/badge.svg)](https://github.com/okdp/spark-history-web-proxy/actions/workflows/release-please.yml)
1+
[![ci](https://github.com/okdp/spark-web-proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/spark-web-proxy/actions/workflows/ci.yml)
2+
[![release-please](https://github.com/okdp/spark-web-proxy/actions/workflows/release-please.yml/badge.svg)](https://github.com/okdp/spark-web-proxy/actions/workflows/release-please.yml)
33
[![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
44

55

6-
spark-history-web-proxy acts as a reverse proxy for [Spark History Server](https://spark.apache.org/docs/latest/monitoring.html) and [Spark UI](https://spark.apache.org/docs/latest/web-ui.html). It completes [Spark History Server](https://spark.apache.org/docs/latest/monitoring.html) by seamlessly integrating live (running) Spark applications UIs. The web proxy enables real-time dynamic discovery and monitoring of running spark applications (without delay) alongside completed applications, all within your existing Spark History Server Web UI.
6+
spark-web-proxy acts as a reverse proxy for [Spark History Server](https://spark.apache.org/docs/latest/monitoring.html) and [Spark UI](https://spark.apache.org/docs/latest/web-ui.html). It completes [Spark History Server](https://spark.apache.org/docs/latest/monitoring.html) by seamlessly integrating live (running) Spark applications UIs. The web proxy enables real-time dynamic discovery and monitoring of running spark applications (without delay) alongside completed applications, all within your existing Spark History Server Web UI.
77

88
The proxy is non-intrusive and independent of any specific version of Spark History Server or Spark. It supports all Spark application deployment modes, including Kubernetes Jobs, Spark Operator, Jupyter Spark notebooks, etc.
99

@@ -29,7 +29,7 @@ Refer to [helm/spark-history-server](https://github.com/OKDP/spark-history-serve
2929

3030
2. As an independent chart:
3131

32-
Refer to [README](helm/spark-history-web-proxy/README.md) for customization options and installation guidelines.
32+
Refer to [README](helm/spark-web-proxy/README.md) for customization options and installation guidelines.
3333

3434
In both cases, you need to use the web proxy ingress instead of your spark history ingress.
3535

cmd/root.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ package cmd
1919
import (
2020
"os"
2121

22-
"github.com/okdp/spark-history-web-proxy/internal/config"
23-
log "github.com/okdp/spark-history-web-proxy/internal/logging"
24-
"github.com/okdp/spark-history-web-proxy/internal/server"
22+
"github.com/okdp/spark-web-proxy/internal/config"
23+
log "github.com/okdp/spark-web-proxy/internal/logging"
24+
"github.com/okdp/spark-web-proxy/internal/server"
2525
"github.com/spf13/cobra"
2626
"github.com/spf13/viper"
2727
)
2828

2929
var RootCmd = &cobra.Command{
30-
Use: "spark-history-web-proxy",
30+
Use: "spark-web-proxy",
3131
Short: "Spark UI Proxy",
3232
Run: runSparkUIController,
3333
}
@@ -56,7 +56,7 @@ func init() {
5656
viper.SetDefault("security.cors.allowCredentials", false)
5757
viper.SetDefault("security.cors.maxAge", 3600)
5858

59-
viper.SetConfigName("spark-history-web-proxy")
59+
viper.SetConfigName("spark-web-proxy")
6060
viper.SetConfigType("yaml")
6161

6262
RootCmd.PersistentFlags().String("config", "config.yaml", "Path to configuration file")

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/okdp/spark-history-web-proxy
1+
module github.com/okdp/spark-web-proxy
22

33
go 1.23.0
44

helm/spark-history-web-proxy/templates/tests/test-connection.yaml

Lines changed: 0 additions & 15 deletions
This file was deleted.
File renamed without changes.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
apiVersion: v2
2-
name: spark-history-web-proxy
3-
description: Helm chart for spark-history-web-proxy
2+
name: spark-web-proxy
3+
description: Helm chart for spark-web-proxy
44
type: application
55
version: 0.1.0
66
appVersion: "0.1.0-snapshot"
77
keywords:
88
- spark
99
- spark-history
1010
- spark-history-server
11-
- spark-history-web-proxy
11+
- spark-web-proxy
1212
home: https://spark.apache.org
1313
maintainers:
1414
- email: idir.izitounene@kubotal.io
@@ -19,5 +19,5 @@ sources:
1919
- https://github.com/OKDP/okdp-spark-auth-filter
2020
- https://github.com/OKDP/spark-images
2121
- https://github.com/OKDP/spark-history-server/tree/main/helm/spark-history-server
22-
- https://github.com/OKDP/spark-history-web-proxy
22+
- https://github.com/OKDP/spark-web-proxy
2323

helm/spark-history-web-proxy/README.md renamed to helm/spark-web-proxy/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# spark-history-web-proxy
1+
# spark-web-proxy
22

3-
Helm chart for spark-history-web-proxy
3+
Helm chart for spark-web-proxy
44

55
## Introduction
66

@@ -16,13 +16,13 @@ Helm chart for [Spark History Web Proxy](../../) deployment using the [Helm](htt
1616
To install the chart with the release name `my-release`:
1717

1818
```shell
19-
$ helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --version 0.1.0
19+
$ helm install my-release oci://quay.io/okdp/charts/spark-web-proxy --version 0.1.0
2020
```
2121

2222
This will create a release of `my-release` in the default namespace. To install in a different namespace:
2323

2424
```shell
25-
$ helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --version 0.1.0 \
25+
$ helm install my-release oci://quay.io/okdp/charts/spark-web-proxy --version 0.1.0 \
2626
--namespace spark
2727
```
2828

@@ -43,13 +43,13 @@ The command removes all the Kubernetes components associated with the chart and
4343
To download the chart locally, use the following command:
4444

4545
```shell
46-
$ helm pull oci://quay.io/okdp/charts/spark-history-web-proxy --version 0.1.0
46+
$ helm pull oci://quay.io/okdp/charts/spark-web-proxy --version 0.1.0
4747
```
4848

4949
##### 2. Deploy the Helm Chart
5050

5151
```shell
52-
helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --version 0.1.0 \
52+
helm install my-release oci://quay.io/okdp/charts/spark-web-proxy --version 0.1.0 \
5353
--namespace spark \
5454
--values my-values.yaml \
5555
```
@@ -82,7 +82,7 @@ helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --vers
8282
| configuration.spark.ui.proxyBase | string | `"/sparkui"` | When the proxyBase is set to a value other than `/proxy`, disable the property `spark.ui.reverseProxy=false` in your Spark job configuration if already set. |
8383
| fullnameOverride | string | `""` | Overrides the release name. |
8484
| image.pullPolicy | string | `"Always"` | Image pull policy. |
85-
| image.repository | string | `"quay.io/okdp/spark-history-web-proxy"` | Docker image registry. |
85+
| image.repository | string | `"quay.io/okdp/spark-web-proxy"` | Docker image registry. |
8686
| image.tag | string | `"0.1.0-snapshot"` | Image tag. |
8787
| imagePullSecrets | list | `[]` | Secrets to be used for pulling images from private Docker registries. |
8888
| ingress.annotations | object | `{}` | |
@@ -120,5 +120,5 @@ helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --vers
120120
* <https://github.com/OKDP/okdp-spark-auth-filter>
121121
* <https://github.com/OKDP/spark-images>
122122
* <https://github.com/OKDP/spark-history-server/tree/main/helm/spark-history-server>
123-
* <https://github.com/OKDP/spark-history-web-proxy>
123+
* <https://github.com/OKDP/spark-web-proxy>
124124

helm/spark-history-web-proxy/README.md.gotmpl renamed to helm/spark-web-proxy/README.md.gotmpl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Helm chart for [Spark History Web Proxy](../../) deployment using the [Helm](htt
1818
To install the chart with the release name `my-release`:
1919

2020
```shell
21-
$ helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --version {{ template "chart.version" . }}
21+
$ helm install my-release oci://quay.io/okdp/charts/spark-web-proxy --version {{ template "chart.version" . }}
2222
```
2323

2424
This will create a release of `my-release` in the default namespace. To install in a different namespace:
2525

2626
```shell
27-
$ helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --version {{ template "chart.version" . }} \
27+
$ helm install my-release oci://quay.io/okdp/charts/spark-web-proxy --version {{ template "chart.version" . }} \
2828
--namespace spark
2929
```
3030

@@ -45,13 +45,13 @@ The command removes all the Kubernetes components associated with the chart and
4545
To download the chart locally, use the following command:
4646

4747
```shell
48-
$ helm pull oci://quay.io/okdp/charts/spark-history-web-proxy --version {{ template "chart.version" . }}
48+
$ helm pull oci://quay.io/okdp/charts/spark-web-proxy --version {{ template "chart.version" . }}
4949
```
5050

5151
##### 2. Deploy the Helm Chart
5252

5353
```shell
54-
helm install my-release oci://quay.io/okdp/charts/spark-history-web-proxy --version {{ template "chart.version" . }} \
54+
helm install my-release oci://quay.io/okdp/charts/spark-web-proxy --version {{ template "chart.version" . }} \
5555
--namespace spark \
5656
--values my-values.yaml \
5757
```

helm/spark-history-web-proxy/templates/NOTES.txt renamed to helm/spark-web-proxy/templates/NOTES.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
{{- end }}
77
{{- end }}
88
{{- else if contains "NodePort" .Values.service.type }}
9-
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "spark-history-web-proxy.fullname" . }})
9+
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "spark-web-proxy.fullname" . }})
1010
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
1111
echo http://$NODE_IP:$NODE_PORT
1212
{{- else if contains "LoadBalancer" .Values.service.type }}
1313
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 "spark-history-web-proxy.fullname" . }}'
15-
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "spark-history-web-proxy.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
14+
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "spark-web-proxy.fullname" . }}'
15+
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "spark-web-proxy.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
1616
echo http://$SERVICE_IP:{{ .Values.service.port }}
1717
{{- else if contains "ClusterIP" .Values.service.type }}
18-
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "spark-history-web-proxy.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
18+
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "spark-web-proxy.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
1919
export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
2020
echo "Visit http://127.0.0.1:8080 to use your application"
2121
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT

0 commit comments

Comments
 (0)