-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
353cd27
commit a3c303c
Showing
12 changed files
with
418 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
apiVersion: v2 | ||
name: warpstream-agent | ||
description: WarpStream Agent for Kubernetes. | ||
type: application | ||
version: 0.1.0 | ||
appVersion: v507 | ||
icon: https://avatars.githubusercontent.com/u/132156278 | ||
home: https://docs.warpstream.com/warpstream/ | ||
sources: | ||
- https://github.com/warpstreamlabs/charts/warpstream-agent |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 WarpStream Labs | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# WarpStream Agent Helm chart | ||
|
||
The official Helm chart for the [Warpstream agent for Kubernetes][agent-k8s]. | ||
|
||
[agent-k8s]: ===CHART_DOC_URL=== | ||
|
||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
This chart requires Helm v3.6 or later. | ||
|
||
### Install the latest stable release | ||
|
||
```shell | ||
helm repo add warpstream https://warpstreamlabs.github.io/charts | ||
helm repo update | ||
helm upgrade --install warpstream-agent warpstream/warpstream-agent \ | ||
--set config.bucketURL="mem://mem_bucket" \ | ||
--set config.apiKey="$YOUR_API_KEY" \ | ||
--set config.virtualClusterID="$YOUR_VIRTUAL_CLUSTER_ID" | ||
``` | ||
|
||
### Upgrade an existing release | ||
|
||
```shell | ||
helm repo update | ||
helm upgrade warpstream-agent warpstream/warpstream-agent --reuse-values | ||
``` | ||
|
||
### Customize | ||
|
||
See [`values.yaml`](./values.yaml). | ||
|
||
### Install from source | ||
|
||
``` shell | ||
git clone https://github.com/warpstreamlabs/charts | ||
cd charts/warpstream-agent | ||
helm upgrade --install warpstream-agent . \ | ||
--set config.bucketURL="mem://mem_bucket" \ | ||
--set config.apiKey="$YOUR_API_KEY" \ | ||
--set config.virtualClusterID="$YOUR_VIRTUAL_CLUSTER_ID" | ||
``` | ||
|
||
## Development | ||
|
||
### Testing locally | ||
|
||
Bootstrap a Kubernetes cluster locally, for example with [kind][]. | ||
|
||
```shell | ||
helm upgrade --install warpstream-agent . --set config.playground=true | ||
helm test warpstream-agent | ||
kubectl logs warpstream-agent-diagnose-connection | ||
``` | ||
|
||
Or manually diagnose connection with | ||
```shell | ||
kubectl port-forward svc/warpstream-agent 9092 & | ||
docker run --net=host public.ecr.aws/warpstream-labs/warpstream_agent_linux_amd64 \ | ||
kcmd -bootstrap-host localhost -type diagnose-connection | ||
``` | ||
|
||
[kind]: https://kind.sigs.k8s.io/ | ||
|
||
### Publishing a new release | ||
|
||
1. When applicable: Update `appVersion` in [`Chart.yaml`](./Chart.yaml) with the latest [release][]. | ||
1. When changing any Helm chart resources: Update `version` in [`Chart.yaml`](./Chart.yaml). | ||
|
||
[release]: https://docs.warpstream.com/warpstream/reference/install-the-warpstream-agent |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Thank you for installing {{ .Chart.Name }}. | ||
|
||
Your release is named {{ .Release.Name }}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
{{/* | ||
Expand the name of the chart. | ||
*/}} | ||
{{- define "warpstream-agent.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 "warpstream-agent.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 "warpstream-agent.chart" -}} | ||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} | ||
{{- end }} | ||
|
||
{{/* | ||
Common labels | ||
*/}} | ||
{{- define "warpstream-agent.labels" -}} | ||
helm.sh/chart: {{ include "warpstream-agent.chart" . }} | ||
{{ include "warpstream-agent.selectorLabels" . }} | ||
{{- if .Chart.AppVersion }} | ||
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} | ||
{{- end }} | ||
app.kubernetes.io/managed-by: {{ .Release.Service }} | ||
{{- end }} | ||
|
||
{{/* | ||
Selector labels | ||
*/}} | ||
{{- define "warpstream-agent.selectorLabels" -}} | ||
app.kubernetes.io/name: {{ include "warpstream-agent.name" . }} | ||
app.kubernetes.io/instance: {{ .Release.Name }} | ||
{{- end }} | ||
|
||
{{/* | ||
Secret Name | ||
*/}} | ||
{{- define "warpstream-agent.secretName" -}} | ||
{{- if .Values.config.secretName }} | ||
{{- .Values.config.secretName }} | ||
{{- else }} | ||
{{- printf "%s-apikey" (include "warpstream-agent.fullname" .) -}} | ||
{{- end }} | ||
{{- end }} | ||
|
||
{{/* | ||
Create the name of the service account to use | ||
*/}} | ||
{{- define "warpstream-agent.serviceAccountName" -}} | ||
{{- if .Values.serviceAccount.create }} | ||
{{- default (include "warpstream-agent.fullname" .) .Values.serviceAccount.name }} | ||
{{- else }} | ||
{{- default "default" .Values.serviceAccount.name }} | ||
{{- end }} | ||
{{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: {{ include "warpstream-agent.fullname" . }} | ||
labels: | ||
{{- include "warpstream-agent.labels" . | nindent 4 }} | ||
spec: | ||
replicas: {{ .Values.replicas }} | ||
selector: | ||
matchLabels: | ||
{{- include "warpstream-agent.selectorLabels" . | nindent 6 }} | ||
template: | ||
metadata: | ||
{{- with .Values.podAnnotations }} | ||
annotations: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
labels: | ||
{{- include "warpstream-agent.selectorLabels" . | nindent 8 }} | ||
spec: | ||
automountServiceAccountToken: false | ||
{{- with .Values.imagePullSecrets }} | ||
imagePullSecrets: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
serviceAccountName: {{ include "warpstream-agent.serviceAccountName" . }} | ||
{{- if .Values.priorityClassName }} | ||
priorityClassName: {{ .Values.priorityClassName | quote }} | ||
{{- end }} | ||
containers: | ||
- name: {{ .Chart.Name }} | ||
securityContext: | ||
{{- toYaml .Values.securityContext | nindent 12 }} | ||
image: {{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }} | ||
imagePullPolicy: {{ .Values.image.pullPolicy }} | ||
args: | ||
{{- if .Values.config.playground }} | ||
- playground | ||
{{- else }} | ||
- --token-file=/etc/agentk/secrets/token | ||
- --kas-address={{ .Values.config.kasAddress }} | ||
{{- end }} | ||
{{- range .Values.extraArgs }} | ||
- {{ . }} | ||
{{- end }} | ||
readinessProbe: | ||
exec: | ||
command: | ||
- /bin/true | ||
initialDelaySeconds: 10 | ||
resources: | ||
{{- toYaml .Values.resources | nindent 12 }} | ||
env: | ||
{{- if .Values.extraEnv }} | ||
{{- toYaml .Values.extraEnv | nindent 12 }} | ||
{{- end }} | ||
ports: | ||
- name: kafka | ||
containerPort: 9092 | ||
protocol: TCP | ||
- name: http | ||
containerPort: 8080 | ||
protocol: TCP | ||
{{- with .Values.initContainers }} | ||
initContainers: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
{{- with .Values.nodeSelector }} | ||
nodeSelector: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
{{- with .Values.affinity }} | ||
affinity: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
{{- with .Values.tolerations }} | ||
tolerations: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
{{- with .Values.hostAliases }} | ||
hostAliases: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{{- if .Values.config.apiKey -}} | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: {{ include "warpstream-agent.secretName" . }} | ||
labels: | ||
{{- include "warpstream-agent.labels" . | nindent 4 }} | ||
data: | ||
apikey: {{ required "A valid config.apiKey is required" .Values.config.apiKey | b64enc }} | ||
type: Opaque | ||
{{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: {{ include "warpstream-agent.fullname" . }} | ||
labels: | ||
{{- include "warpstream-agent.labels" . | nindent 4 }} | ||
spec: | ||
type: {{ .Values.service.type }} | ||
ports: | ||
- port: {{ .Values.service.port }} | ||
targetPort: kafka | ||
protocol: TCP | ||
name: kafka | ||
- port: {{ .Values.service.httpPort }} | ||
targetPort: http | ||
protocol: TCP | ||
name: http | ||
selector: | ||
{{- include "warpstream-agent.selectorLabels" . | nindent 4 }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{{- if .Values.serviceAccount.create -}} | ||
apiVersion: v1 | ||
kind: ServiceAccount | ||
metadata: | ||
name: {{ include "warpstream-agent.serviceAccountName" . }} | ||
labels: | ||
{{- include "warpstream-agent.labels" . | nindent 4 }} | ||
{{- with .Values.serviceAccount.annotations }} | ||
annotations: | ||
{{- toYaml . | nindent 4 }} | ||
{{- end }} | ||
{{- end }} |
20 changes: 20 additions & 0 deletions
20
charts/warpstream-agent/templates/tests/test-connection.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
apiVersion: v1 | ||
kind: Pod | ||
metadata: | ||
name: "{{ include "warpstream-agent.fullname" . }}-diagnose-connection" | ||
labels: | ||
{{- include "warpstream-agent.labels" . | nindent 4 }} | ||
annotations: | ||
"helm.sh/hook": test | ||
spec: | ||
containers: | ||
- name: diagnose | ||
image: {{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }} | ||
command: ['/warpstream'] | ||
args: | ||
- kcmd | ||
- -bootstrap-host | ||
- '{{ include "warpstream-agent.fullname" . }}' | ||
- -type | ||
- diagnose-connection | ||
restartPolicy: Never |
Oops, something went wrong.