Skip to content

Commit 5012153

Browse files
jaehyeon-kimjaehyeon-kim
authored
Merge pull request #16 from factorhouse/feature/FAC-167_consolidate-aws-charts
Consolidate the Helm chart for Kpow Annual
2 parents 0cc3ab4 + ff53365 commit 5012153

File tree

20 files changed

+955
-0
lines changed

20 files changed

+955
-0
lines changed

‎.github/workflows/release.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ jobs:
5757
5858
- name: Run chart-releaser #this is used to generate new version of helm chart along with some file with extension .prov
5959
uses: helm/chart-releaser-action@a917fd15b20e8b64b94d9158ad54cd6345335584 #v1.6.0
60+
with:
61+
skip_existing: true
6062
env:
6163
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
6264
CR_KEY: "${{ secrets.CR_KEY }}" # Key name used while creating key

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Official Helm Charts for Factor House products. Currently supported:
77

88
* [Kpow](charts/kpow/README.md) (`factorhouse/kpow`)
99
* [Kpow Community Edition](charts/kpow-ce/README.md) (`factorhouse/kpow-ce`)
10+
* [Kpow AWS Marketplace (Kpow Annual)](charts/kpow-annual/README.md)(`factorhouse/kpow-annual-chart`)
1011
* [Flex](charts/flex/README.md) (`factorhouse/flex`)
1112
* [Flex Community Edition](charts/flex-ce/README.md) (`factorhouse/flex-ce`)
1213

‎charts/flex-ce/values.schema.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,17 @@
114114
"allowPrivilegeEscalation": {
115115
"type": "boolean"
116116
},
117+
"capabilities": {
118+
"type": "object",
119+
"properties": {
120+
"drop": {
121+
"type": "array",
122+
"items": {
123+
"type": "string"
124+
}
125+
}
126+
}
127+
},
117128
"privileged": {
118129
"type": "boolean"
119130
},

‎charts/flex/values.schema.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,17 @@
114114
"allowPrivilegeEscalation": {
115115
"type": "boolean"
116116
},
117+
"capabilities": {
118+
"type": "object",
119+
"properties": {
120+
"drop": {
121+
"type": "array",
122+
"items": {
123+
"type": "string"
124+
}
125+
}
126+
}
127+
},
117128
"privileged": {
118129
"type": "boolean"
119130
},

‎charts/kpow-annual/.helmignore‎

Lines changed: 23 additions & 0 deletions
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/kpow-annual/Chart.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
apiVersion: v2
2+
name: kpow-annual-chart
3+
description: Run Kpow Annual from the AWS Marketplace in Kubernetes
4+
type: application
5+
version: 1.0.59
6+
appVersion: "94.5"
7+
keywords:
8+
- kafka
9+
- kafka-ui
10+
- kafka-connect
11+
- schema-registry
12+
- monitoring
13+
home: "https://factorhouse.io/kpow"
14+
sources:
15+
- "https://github.com/factorhouse/kpow"
16+
- "https://github.com/factorhouse/helm-charts/"
17+
maintainers:
18+
- name: "Factor House Support"
19+
email: "[email protected]"
20+
annotations:
21+
artifacthub.io/signKey: |
22+
fingerprint: 9686853629F9810E63A72373BA3D0FAE1A26981F
23+
url: https://keybase.io/factorhouse/pgp_keys.asc

‎charts/kpow-annual/README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Run Kpow for Apache Kafka in Kubernetes with AWS License Manager
2+
3+
[Helm](https://helm.sh) is the package manager for Kubernetes.
4+
5+
[Kpow](https://kpow.io) is the all-in-one toolkit to manage, monitor, and learn about your Kafka resources.
6+
7+
This Helm chart is applicable to the **AWS License Manager** version of Kpow [sold on the AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-vgghgqdsplhvc).
8+
9+
Find our general-purpose Helm charts for regular Kubernetes deploys [right here](https://github.com/factorhouse/kpow-helm-charts).
10+
11+
## Helm Charts
12+
13+
This repository contains a single Helm chart that uses the Kpow AWS Marketplace LM Docker container provided to you when you subscribe to the Kpow AWS Marketplace LM product on the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-vgghgqdsplhvc).
14+
15+
### Installation
16+
17+
Follow the instructions provided to you via your AWS Marketplace subscription.
18+
19+
For more information on configuring IAM Roles for Service Accounts see our [Kpow AWS-LM Documentation](https://docs.kpow.io/installation/aws-marketplace-lm/).
20+
21+
For general purpose configuration instructions see our [general-purpose Helm charts](https://github.com/factorhouse/kpow-helm-charts).
22+
23+
### Get Help!
24+
25+
If you have any issues or errors, please contact [email protected].
26+
27+
### Licensing and Modifications
28+
29+
This repository is Apache 2.0 licensed, you are welcome to clone and modify as required.

‎charts/kpow-annual/kpow-config.yaml.example‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
apiVersion: v1
2+
kind: ConfigMap
3+
metadata:
4+
name: kpow-config
5+
data:
6+
7+
### See https://docs.kpow.io for full configuration and installation guides
8+
9+
### Note: The simplest Kpow configuration requires only LICENSE_* and BOOTSTRAP.
10+
11+
### License Configuration (https://kpow.io/try <- 30 day trial licenses available)
12+
### Note: If using the AWS Marketplace Kpow Container you do not need to supply LICENSE* parameters
13+
### (https://aws.amazon.com/marketplace/seller-profile?id=ab356f1d-3394-4523-b5d4-b339e3cca9e0)
14+
15+
LICENSE_ID: "replace-me"
16+
LICENSE_CODE: "replace-me"
17+
LICENSEE: "replace-me"
18+
LICENSE_EXPIRY: "replace-me"
19+
LICENSE_SIGNATURE: "replace-me"
20+
21+
### Resource Set Configuration
22+
23+
### Kpow manages sets of Kafka resources. Clusters, Schema Registries and Kafka Connect Installations.
24+
### To configure multiple kafka resources prepend environment variables with _2, _3, etc.
25+
### Resources with the same set-id are considered related.
26+
### E.g. cluster with BOOTSTRAP_2 can decode messages from with registry SCHEMA_REGISTRY_URL_2.
27+
28+
## Optional Resource Set Name (this is displayed in the Kpow UI for each set of resources)
29+
30+
ENVIRONMENT_NAME: "Change Me"
31+
32+
## Kafka Cluster Configuration
33+
## Required parameters for configuring a Kafka Cluster
34+
## You must configure at least one Kafka Booktstrap to use Kpow.
35+
36+
BOOTSTRAP: "replace-with-your-bootstrap-url"
37+
38+
## Optional Kafka Cluster Configuration
39+
40+
# SECURITY_PROTOCOL: SASL_SSL
41+
# SASL_MECHANISM: PLAIN
42+
# SASL_JAAS_CONFIG: "org.apache.kafka.common.security.plain.Plain.."
43+
# SASL_LOGIN_CALLBACK_HANDLER_CLASS: "com.corp.kafka.security.sasl.oauth.KafkaBrokerTokenCreator"
44+
# SSL_KEYSTORE_LOCATION: "/ssl/kafka.keystore.jks"
45+
# SSL_KEYSTORE_PASSWORD: "keystore-pass-123"
46+
# SSL_KEY_PASSWORD: "key-pass-123"
47+
# SSL_KEYSTORE_TYPE: JKS
48+
# SSL_KEYMANAGER_ALGORITHM: SunX509
49+
# SSL_TRUSTSTORE_LOCATION: "/ssl/kafka.truststore.jks"
50+
# SSL_TRUSTSTORE_PASSWORD: "trust-pass-123"
51+
# SSL_TRUSTSTORE_TYPE: JKS
52+
# SSL_TRUSTMANAGER_ALGORITHM: PKIX
53+
# SSL_ENDPOINT_IDENTIFICATION_ALGORITHM: https
54+
# SSL_PROVIDER: default
55+
# SSL_CIPHER_SUITES: default
56+
# SSL_PROTOCOL: TLS
57+
# SSL_ENABLED_PROTOCOLS: "TLSv.12,TLSv1.1,TLSv1"
58+
# SSL_SECURE_RANDOM_IMPLEMENTATION: SHA1PRNG
59+
60+
## Schema Registry Configuration
61+
62+
# SCHEMA_REGISTRY_URL: https://registry-host
63+
# SCHEMA_REGISTRY_AUTH: USER_INFO
64+
# SCHEMA_REGISTRY_USER: registry-user
65+
# SCHEMA_REGISTRY_PASSWORD: registry-pass
66+
# SCHEMA_REGISTRY_NAME: registry-label (optional)
67+
68+
## Kafka Connect Configuration
69+
70+
# CONNECT_REST_URL: http://localhost:8083
71+
# CONNECT_AUTH: BASIC (optional)
72+
# CONNECT_BASIC_AUTH_USER: connect-user (optional)
73+
# CONNECT_BASIC_AUTH_PASS: connect-pass (optional)
74+
# CONNECT_GROUP_ID: connect-group-id (optional)
75+
# CONNECT_OFFSET_STORAGE_TOPIC: connect-topic (optional)
76+
77+
### System Configuration
78+
79+
# PORT: 3000 - the port to serve content
80+
# REPLICATION_FACTOR: 3 - the replication factor of internal kpow topics (reduce if you have fewer than 3 brokers)
81+
# SNAPSHOT_PARALLELISM: 3 - the parallelism of kpow snapshot execution (increase for very big resource-sets)
82+
# SHOW_SPLASH: true - turn on/off the initial splash screen for new user sessions
83+
84+
### Live Mode Configuration
85+
86+
# LIVE_MODE_ENABLED=true
87+
# LIVE_MODE_PERIOD_MS=60000
88+
# LIVE_MODE_INTERVAL_MS=5000
89+
# LIVE_MODE_MAX_CONCURRENT_USERS=2
90+
91+
## System HTTPS Configuration
92+
93+
# ENABLE_HTTPS: "true"
94+
# HTTPS_KEYSTORE_LOCATION: "/ssl/https.keystore.jks"
95+
# HTTPS_KEYSTORE_TYPE: "JKS"
96+
# HTTPS_KEYSTORE_PASSWORD: "ssl-key-pass"
97+
# HTTPS_TRUSTSTORE_LOCATION: "/ssl/https.truststore.jks"
98+
# HTTPS_TRUSTSTORE_TYPE: "JKS"
99+
# HTTPS_TRUSTSTORE_PASSWORD: "ssl-trust-pass"
100+
101+
## Data Inspect Configuration
102+
## Provide custom serdes, set the default serdes, and restrict serdes available to users.
103+
104+
# CUSTOM_SERDES: "io.kpow.SerdeOne,io.kpow.SerdeTwo"
105+
# DEFAULT_KEY_SERDES: "JSON"
106+
# DEFAULT_VALUE_SERDES: "AVRO"
107+
# AVAILABLE_KEY_SERDES: "JSON,String,Transit / JSON"
108+
# AVAILABLE_VALUE_SERDES: "JSON,String,io.kpow.SerdeOne"
109+
110+
## Prometheus Endpoints
111+
112+
# PROMETHEUS_EGRESS: "true"
113+
114+
### User Authentication and Authorization
115+
116+
## RBAC Configuration (requires SSO provider configured, e.g. Okta, Github, Azure AD, AWS SSO, SAML, etc.)
117+
118+
# RBAC_CONFIGURATION_FILE: /opt/kpow/rbac-config.yaml
119+
120+
## Global Access Controls Configuration (default to false, apply to all users, overriden if you configure RBAC)
121+
122+
# ALLOW_TOPIC_CREATE: "true"
123+
# ALLOW_TOPIC_DELETE: "true"
124+
# ALLOW_TOPIC_INSPECT: "true"
125+
# ALLOW_TOPIC_PRODUCE: "true"
126+
# ALLOW_TOPIC_EDIT: "true"
127+
# ALLOW_BROKER_EDIT: "true"
128+
# ALLOW_GROUP_EDIT: "true"
129+
# ALLOW_SCHEMA_CREATE: "true"
130+
# ALLOW_SCHEMA_EDIT: "true"
131+
# ALLOW_CONNECT_CREATE: "true"
132+
# ALLOW_CONNECT_EDIT: "true"
133+
# ALLOW_ACL_EDIT: "true"
134+
135+
## Data Policy (Masking / Redaction) Configuration
136+
137+
# DATA_POLICY_CONFIGURATION_FILE: /opt/kpow/data-config.yml
138+
139+
## Slack Integration (Send Audit Log records to a Slack channel)
140+
141+
# SLACK_WEBHOOK_URL: https://hooks.slack.com/services/...
142+
143+
## Okta SSO (OpenID)
144+
145+
# AUTH_PROVIDER_TYPE: "okta"
146+
# OKTA_ORGANISATION: "your-organisation"
147+
# OPENID_CLIENT_ID: "The 'Client ID' found in the "Client Credentials" section of your Okta integration"
148+
# OPENID_CLIENT_SECRET: "The 'Client Secret' found in the "Client Credentials" section of your Okta integration"
149+
# OPENID_LANDING_URI: "https://staging.kpow.z-corp.com"
150+
151+
## Github SSO (OpenID)
152+
153+
# AUTH_PROVIDER_TYPE: "github"
154+
# OPENID_TOKEN_URI: "https://github.com/login/oauth/access_token" or "[GHE Server URL]/login/oauth/access_token"
155+
# OPENID_AUTH_URI: "https://github.com/login/oauth/authorize" or "[GHE Server URL]/login/oauth/authorize"
156+
# OPENID_API_URI: "https://api.github.com/user" or, "[GHE Server URL]/api/v3/user"
157+
# OPENID_CLIENT_ID: "The 'Client ID' found in your configured Github Oath App"
158+
# OPENID_CLIENT_SECRET: "The 'Client Secret' found in your configured Github Oath App"
159+
# OPENID_LANDING_URI: "https://staging.kpow.z-corp.com/"
160+
161+
## SAML SSO
162+
163+
# AUTH_PROVIDER_TYPE: "saml"
164+
# SAML_RELYING_PARTY_IDENTIFIER: "kpow.io"
165+
# SAML_ACS_URL: "https://kpow.corp.com/saml"
166+
# SAML_METADATA_FILE: "/opt/kpow/aws-metadata.xml"
167+
# SAML_CERT: "/var/certs/saml-cert.cer"

‎charts/kpow-annual/templates/NOTES.txt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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 }}{{ . }}
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 "kpow.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 "kpow.fullname" . }}'
15+
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "kpow.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
16+
echo http://$SERVICE_IP:{{ .Values.service.port }}
17+
{{- else if contains "ClusterIP" .Values.service.type }}
18+
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "kpow.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
19+
echo "Visit http://127.0.0.1:3000 to use your application"
20+
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 3000:3000
21+
{{- end }}

‎charts/kpow-annual/templates/_helpers.tpl‎

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

0 commit comments

Comments
 (0)