diff --git a/charts/README.md b/charts/README.md new file mode 100644 index 000000000..a72819e05 --- /dev/null +++ b/charts/README.md @@ -0,0 +1,160 @@ +# helm charts 使用说明 + +包含`canal-admin`和`canal-server`两个chart,基本配置保存在k8s的`secret`里,`canal.properties`和`instance.properties`保存在mysql数据库中,使用zookeeper注册中心实现高可用。 + +- [helm charts 使用说明](#helm-charts-使用说明) + - [创建zk集群](#创建zk集群) + - [初始化数据库](#初始化数据库) + - [部署canal-admin chart](#部署canal-admin-chart) + - [配置values.yaml](#配置valuesyaml) + - [配置集群信息](#配置集群信息) + - [部署canal-server chart](#部署canal-server-chart) + - [配置values.yaml](#配置valuesyaml-1) + - [instance 实例创建](#instance-实例创建) + +## 创建zk集群 + +```sh +helm install canal-zookeeper oci://registry-1.docker.io/bitnamicharts/zookeeper +``` + +如需挂载磁盘参考 [bitnami/zookeeper](`https://github.com/bitnami/charts/tree/main/bitnami/zookeeper`) + + +## 初始化数据库 + +[/admin/admin-web/src/main/resources/canal_manager.sql](/admin/admin-web/src/main/resources/canal_manager.sql) + +[/deployer/src/main/resources/spring/tsdb/sql/create_table.sql](/deployer/src/main/resources/spring/tsdb/sql/create_table.sql) + +## 部署canal-admin chart + +### 配置values.yaml + +```yaml +# 主要配置 +admin: + config: | + server: + port: 8089 + spring: + jackson: + date-format: yyyy-MM-dd HH:mm:ss + time-zone: GMT+8 + spring.datasource: + address: your_db_host:3306 + database: canal_manager + username: **** + password: **** + driver-class-name: com.mysql.jdbc.Driver + url: jdbc:mysql://${spring.datasource.address}/${spring.datasource.database}?useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true + hikari: + maximum-pool-size: 30 + minimum-idle: 1 + canal: + adminUser: admin + adminPasswd: admin + # debug: true +``` + +全量参数见:[canal-admin/values.yaml](./canal-admin/values.yaml),测试用例见:[tests/admin-values.yaml](./tests/admin-values.yaml) + +```sh +helm install canal-admin -f ./admin-values.yaml ./canal-admin +``` + +### 配置集群信息 + +![cluster](./images/cluster.png) + +等待pod启动后,使用默认账户`admin`密码`123456`登录 + +创建集群`default`并配置`zk地址`为`canal-zookeeper.default.svc.cluster.local:2181` + +配置完成后,点击`配置`-`主配置`,修改以下配置项,不是覆盖整个文件 + +```yaml +canal.user = admin +canal.passwd = 4ACFE3202A5FF5CF467898FC58AAB1D615029441 + +canal.zkServers = canal-zookeeper.default.svc.cluster.local:2181 +# tcp, kafka, rocketMQ, rabbitMQ, pulsarMQ 看实际需求,此处改为了rabbitMQ +canal.serverMode = rabbitMQ + +#canal.instance.tsdb.dir = ${canal.file.data.dir:../conf}/${canal.instance.destination:} +canal.instance.tsdb.url = jdbc:mysql://you_db_host:3306/canal_tsdb?useUnicode=true&characterEncoding=UTF-8&useSSL=false +canal.instance.tsdb.dbUsername = **** +canal.instance.tsdb.dbPassword = **** + +#canal.instance.tsdb.spring.xml = classpath:spring/tsdb/h2-tsdb.xml +canal.instance.tsdb.spring.xml = classpath:spring/tsdb/mysql-tsdb.xml + +#canal.instance.global.spring.xml = classpath:spring/file-instance.xml +canal.instance.global.spring.xml = classpath:spring/default-instance.xml + +# 如果用的是阿里云polardb需要配置 +canal.aliyun.accessKey = **** +canal.aliyun.secretKey = **** +canal.aliyun.uid = 主账号id + +# 我们是推送到rabbitmq所以需要配置 +rabbitmq.host = ****:5672 +rabbitmq.virtual.host = **** +rabbitmq.exchange = **** +# canal.aliyun.accessKey +rabbitmq.username = **** +# canal.aliyun.secretKey +rabbitmq.password = **** +rabbitmq.deliveryMode = direct +``` + +## 部署canal-server chart + +### 配置values.yaml + +```yaml +# 主要配置 +server: + config: | + canal.port = 11111 + canal.metrics.pull.port = 11112 + + # register ip + canal.register.ip = + + # canal admin config + canal.admin.manager = canal-admin.default:8089 + canal.admin.port = 11110 + canal.admin.user = admin + canal.admin.passwd = 4ACFE3202A5FF5CF467898FC58AAB1D615029441 + # admin auto register + canal.admin.register.auto = true + canal.admin.register.cluster = default +``` + +```sh +helm install canal-server -f ./server-values.yaml ./canal-server +``` + +全量参数见:[canal-server/values.yaml](./canal-server/values.yaml),测试用例见:[tests/server-values.yaml](./tests/server-values.yaml) + +![server](./images/server.png) + +至此,canal-server已自动创建,并自动注册。 + +## instance 实例创建 + +主要配置如下 + +```yaml +# 配置你要监听的数据库 +canal.instance.master.address=127.0.0.1:3306 +canal.instance.dbUsername=**** +canal.instance.dbPassword=**** + +# 过滤监听哪些表 +canal.instance.filter.regex=.*\\..* + +# 如果是推送到rabbitmq,需要配置 Routing Key +canal.mq.topic=你的Routing Key +``` diff --git a/charts/canal-admin/.helmignore b/charts/canal-admin/.helmignore new file mode 100644 index 000000000..0e8a0eb36 --- /dev/null +++ b/charts/canal-admin/.helmignore @@ -0,0 +1,23 @@ +# 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 +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/canal-admin/Chart.yaml b/charts/canal-admin/Chart.yaml new file mode 100644 index 000000000..143b6d31f --- /dev/null +++ b/charts/canal-admin/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: canal-admin +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 1.1.8-alpha-3 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.16.0" diff --git a/charts/canal-admin/templates/NOTES.txt b/charts/canal-admin/templates/NOTES.txt new file mode 100644 index 000000000..cbeb78fa0 --- /dev/null +++ b/charts/canal-admin/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "canal-admin.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "canal-admin.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "canal-admin.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "canal-admin.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/charts/canal-admin/templates/_helpers.tpl b/charts/canal-admin/templates/_helpers.tpl new file mode 100644 index 000000000..2ce08ebc6 --- /dev/null +++ b/charts/canal-admin/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "canal-admin.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 "canal-admin.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 "canal-admin.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "canal-admin.labels" -}} +helm.sh/chart: {{ include "canal-admin.chart" . }} +{{ include "canal-admin.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "canal-admin.selectorLabels" -}} +app.kubernetes.io/name: {{ include "canal-admin.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "canal-admin.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "canal-admin.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/canal-admin/templates/deployment.yaml b/charts/canal-admin/templates/deployment.yaml new file mode 100644 index 000000000..a1c7c9b4c --- /dev/null +++ b/charts/canal-admin/templates/deployment.yaml @@ -0,0 +1,75 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "canal-admin.fullname" . }} + labels: + {{- include "canal-admin.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "canal-admin.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "canal-admin.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "canal-admin.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.port }} + protocol: TCP + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumeMounts: + - mountPath: /home/admin/canal-admin/conf/application.yml + name: secret + subPath: application.yml + {{- with .Values.volumeMounts }} + {{- toYaml . | nindent 12 }} + {{- end }} + volumes: + - name: secret + secret: + defaultMode: 420 + secretName: {{ include "canal-admin.fullname" . }} + {{- with .Values.volumes }} + {{- 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 }} diff --git a/charts/canal-admin/templates/hpa.yaml b/charts/canal-admin/templates/hpa.yaml new file mode 100644 index 000000000..541bcd518 --- /dev/null +++ b/charts/canal-admin/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "canal-admin.fullname" . }} + labels: + {{- include "canal-admin.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "canal-admin.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/charts/canal-admin/templates/ingress.yaml b/charts/canal-admin/templates/ingress.yaml new file mode 100644 index 000000000..885291551 --- /dev/null +++ b/charts/canal-admin/templates/ingress.yaml @@ -0,0 +1,43 @@ +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "canal-admin.fullname" . }} + labels: + {{- include "canal-admin.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "canal-admin.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/canal-admin/templates/secret.yaml b/charts/canal-admin/templates/secret.yaml new file mode 100644 index 000000000..caa2027dd --- /dev/null +++ b/charts/canal-admin/templates/secret.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "canal-admin.fullname" . }} + labels: + {{- include "canal-admin.labels" . | nindent 4 }} +type: Opaque +data: + application.yml: {{tpl .Values.admin.config $ | b64enc | quote }} \ No newline at end of file diff --git a/charts/canal-admin/templates/service.yaml b/charts/canal-admin/templates/service.yaml new file mode 100644 index 000000000..62759f5f7 --- /dev/null +++ b/charts/canal-admin/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "canal-admin.fullname" . }} + labels: + {{- include "canal-admin.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "canal-admin.selectorLabels" . | nindent 4 }} diff --git a/charts/canal-admin/templates/serviceaccount.yaml b/charts/canal-admin/templates/serviceaccount.yaml new file mode 100644 index 000000000..4a0b0e545 --- /dev/null +++ b/charts/canal-admin/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "canal-admin.serviceAccountName" . }} + labels: + {{- include "canal-admin.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/canal-admin/templates/tests/test-connection.yaml b/charts/canal-admin/templates/tests/test-connection.yaml new file mode 100644 index 000000000..f7899dd4c --- /dev/null +++ b/charts/canal-admin/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "canal-admin.fullname" . }}-test-connection" + labels: + {{- include "canal-admin.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "canal-admin.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/canal-admin/values.yaml b/charts/canal-admin/values.yaml new file mode 100644 index 000000000..6e8717074 --- /dev/null +++ b/charts/canal-admin/values.yaml @@ -0,0 +1,146 @@ +# Default values for canal-admin. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: canal/canal-admin + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "latest" + +# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: false + # Automatically mount a ServiceAccount's API credentials? + automount: false + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + port: 8089 + +# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # 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 + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http + +# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +admin: + config: | + server: + port: 8089 + spring: + jackson: + date-format: yyyy-MM-dd HH:mm:ss + time-zone: GMT+8 + spring.datasource: + address: you_db_host:3306 + database: canal_manager + username: **** + password: **** + driver-class-name: com.mysql.jdbc.Driver + url: jdbc:mysql://${spring.datasource.address}/${spring.datasource.database}?useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true + hikari: + maximum-pool-size: 30 + minimum-idle: 1 + canal: + adminUser: admin + adminPasswd: admin + # debug: true \ No newline at end of file diff --git a/charts/canal-server/.helmignore b/charts/canal-server/.helmignore new file mode 100644 index 000000000..0e8a0eb36 --- /dev/null +++ b/charts/canal-server/.helmignore @@ -0,0 +1,23 @@ +# 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 +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/charts/canal-server/Chart.yaml b/charts/canal-server/Chart.yaml new file mode 100644 index 000000000..68da428db --- /dev/null +++ b/charts/canal-server/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: canal-server +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 1.1.8-alpha-3 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.16.0" diff --git a/charts/canal-server/templates/NOTES.txt b/charts/canal-server/templates/NOTES.txt new file mode 100644 index 000000000..275ef5ea3 --- /dev/null +++ b/charts/canal-server/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "canal-server.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "canal-server.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "canal-server.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "canal-server.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/charts/canal-server/templates/_helpers.tpl b/charts/canal-server/templates/_helpers.tpl new file mode 100644 index 000000000..665e72ac5 --- /dev/null +++ b/charts/canal-server/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "canal-server.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 "canal-server.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 "canal-server.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "canal-server.labels" -}} +helm.sh/chart: {{ include "canal-server.chart" . }} +{{ include "canal-server.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "canal-server.selectorLabels" -}} +app.kubernetes.io/name: {{ include "canal-server.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "canal-server.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "canal-server.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/charts/canal-server/templates/hpa.yaml b/charts/canal-server/templates/hpa.yaml new file mode 100644 index 000000000..6155caae5 --- /dev/null +++ b/charts/canal-server/templates/hpa.yaml @@ -0,0 +1,32 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "canal-server.fullname" . }} + labels: + {{- include "canal-server.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "canal-server.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/charts/canal-server/templates/secret.yaml b/charts/canal-server/templates/secret.yaml new file mode 100644 index 000000000..242e9b7c5 --- /dev/null +++ b/charts/canal-server/templates/secret.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "canal-server.fullname" . }} + labels: + {{- include "canal-server.labels" . | nindent 4 }} +type: Opaque +data: + canal.properties: {{tpl .Values.server.config $ | b64enc | quote }} \ No newline at end of file diff --git a/charts/canal-server/templates/service.yaml b/charts/canal-server/templates/service.yaml new file mode 100644 index 000000000..6e214f8f8 --- /dev/null +++ b/charts/canal-server/templates/service.yaml @@ -0,0 +1,23 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ printf "%s-headless" (include "canal-server.fullname" .) | trunc 63 | trimSuffix "-" }} + labels: + {{- include "canal-server.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.ports.admin }} + targetPort: admin + protocol: TCP + name: tcp-admin + - port: {{ .Values.service.ports.tcp }} + targetPort: tcp + protocol: TCP + name: tcp-tcp + - port: {{ .Values.service.ports.metric }} + targetPort: metric + protocol: TCP + name: tcp-metric + selector: + {{- include "canal-server.selectorLabels" . | nindent 4 }} diff --git a/charts/canal-server/templates/serviceaccount.yaml b/charts/canal-server/templates/serviceaccount.yaml new file mode 100644 index 000000000..2860cab18 --- /dev/null +++ b/charts/canal-server/templates/serviceaccount.yaml @@ -0,0 +1,13 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "canal-server.serviceAccountName" . }} + labels: + {{- include "canal-server.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} diff --git a/charts/canal-server/templates/statefulsets.yaml b/charts/canal-server/templates/statefulsets.yaml new file mode 100644 index 000000000..cf49be8d9 --- /dev/null +++ b/charts/canal-server/templates/statefulsets.yaml @@ -0,0 +1,80 @@ +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: {{ include "canal-server.fullname" . }} + labels: + {{- include "canal-server.labels" . | nindent 4 }} +spec: + serviceName: {{ printf "%s-headless" (include "canal-server.fullname" .) | trunc 63 | trimSuffix "-" }} + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "canal-server.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "canal-server.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "canal-server.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: admin + containerPort: {{ .Values.service.ports.admin }} + protocol: TCP + - name: tcp + containerPort: {{ .Values.service.ports.tcp }} + protocol: TCP + - name: metric + containerPort: {{ .Values.service.ports.metric }} + protocol: TCP + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + volumeMounts: + - mountPath: /home/admin/canal-server/conf/canal.properties + name: secret + subPath: canal.properties + {{- with .Values.volumeMounts }} + {{- toYaml . | nindent 12 }} + {{- end }} + volumes: + - name: secret + secret: + defaultMode: 420 + secretName: {{ include "canal-server.fullname" . }} + {{- with .Values.volumes }} + {{- 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 }} diff --git a/charts/canal-server/templates/tests/test-connection.yaml b/charts/canal-server/templates/tests/test-connection.yaml new file mode 100644 index 000000000..33ba55e0c --- /dev/null +++ b/charts/canal-server/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "canal-server.fullname" . }}-test-connection" + labels: + {{- include "canal-server.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "canal-server.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/canal-server/values.yaml b/charts/canal-server/values.yaml new file mode 100644 index 000000000..8ec120968 --- /dev/null +++ b/charts/canal-server/values.yaml @@ -0,0 +1,144 @@ +# Default values for canal-server. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +# This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/ +replicaCount: 1 + +# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/ +image: + repository: canal/canal-server + # This sets the pull policy for images. + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "1.1.8-alpha-3" + +# This is for the secretes for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ +imagePullSecrets: [] +# This is to override the chart name. +nameOverride: "" +fullnameOverride: "" + +# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/ +serviceAccount: + # Specifies whether a service account should be created + create: false + # Automatically mount a ServiceAccount's API credentials? + automount: false + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# This is for setting Kubernetes Annotations to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ +podAnnotations: {} +# This is for setting Kubernetes Labels to a Pod. +# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/ +service: + # This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + type: ClusterIP + # This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports + # port: 80 + ports: + admin: 11110 + tcp: 11111 + metric: 11112 + +# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/ +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # 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 + +# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/ +livenessProbe: + httpGet: + path: / + port: metric +readinessProbe: + httpGet: + path: / + port: metric + +# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/ +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +server: + config: | + canal.port = 11111 + canal.metrics.pull.port = 11112 + + # register ip + canal.register.ip = + + # canal admin config + canal.admin.manager = canal-admin.default:8089 + canal.admin.port = 11110 + canal.admin.user = admin + canal.admin.passwd = 4ACFE3202A5FF5CF467898FC58AAB1D615029441 + # admin auto register + canal.admin.register.auto = true + canal.admin.register.cluster = default \ No newline at end of file diff --git a/charts/images/cluster.png b/charts/images/cluster.png new file mode 100644 index 000000000..0aecddf26 Binary files /dev/null and b/charts/images/cluster.png differ diff --git a/charts/images/server.png b/charts/images/server.png new file mode 100644 index 000000000..f3cfea6b2 Binary files /dev/null and b/charts/images/server.png differ diff --git a/charts/tests/admin-values.yaml b/charts/tests/admin-values.yaml new file mode 100644 index 000000000..64aeca645 --- /dev/null +++ b/charts/tests/admin-values.yaml @@ -0,0 +1,34 @@ +ingress: + enabled: true + hosts: + - host: admin.canal.com + paths: + - path: / + pathType: ImplementationSpecific + +admin: + config: | + server: + port: 8089 + spring: + jackson: + date-format: yyyy-MM-dd HH:mm:ss + time-zone: GMT+8 + spring.datasource: + address: you_db_host:3306 + database: canal_manager + username: **** + password: **** + driver-class-name: com.mysql.jdbc.Driver + url: jdbc:mysql://${spring.datasource.address}/${spring.datasource.database}?useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true + hikari: + maximum-pool-size: 30 + minimum-idle: 1 + canal: + adminUser: admin + adminPasswd: admin + debug: true + +image: + repository: registry.us-east-1.aliyuncs.com/sll0/canal-admin + tag: "latest" \ No newline at end of file diff --git a/charts/tests/server-values.yaml b/charts/tests/server-values.yaml new file mode 100644 index 000000000..eced74e6c --- /dev/null +++ b/charts/tests/server-values.yaml @@ -0,0 +1,20 @@ +server: + config: | + canal.port = 11111 + canal.metrics.pull.port = 11112 + + # register ip + canal.register.ip = + + # canal admin config + canal.admin.manager = canal-admin.default:8089 + canal.admin.port = 11110 + canal.admin.user = admin + canal.admin.passwd = 4ACFE3202A5FF5CF467898FC58AAB1D615029441 + # admin auto register + canal.admin.register.auto = true + canal.admin.register.cluster = default + +image: + repository: registry.us-east-1.aliyuncs.com/sll0/canal-server + tag: "v1.1.8-alpha-3" \ No newline at end of file diff --git a/charts/tests/test.sh b/charts/tests/test.sh new file mode 100755 index 000000000..96619ce49 --- /dev/null +++ b/charts/tests/test.sh @@ -0,0 +1,5 @@ +#! /bin/bash + +helm install canal-admin -f ./admin-values.yaml ../canal-admin --dry-run + +helm install canal-admin -f ./server-values.yaml ../canal-server --dry-run \ No newline at end of file